google-ads-api-client/dist/protos/bindings/ads/services/offline_user_data_job_service.d.ts

A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.

import { ServiceType } from "@protobuf-ts/runtime-rpc";
import type { BinaryWriteOptions } from "@protobuf-ts/runtime";
import type { IBinaryWriter } from "@protobuf-ts/runtime";
import type { BinaryReadOptions } from "@protobuf-ts/runtime";
import type { IBinaryReader } from "@protobuf-ts/runtime";
import type { PartialMessage } from "@protobuf-ts/runtime";
import { MessageType } from "@protobuf-ts/runtime";
import { Status } from "../../google/rpc/status";
import { UserData } from "../common/offline_user_data";
import { OfflineUserDataJob } from "../resources/offline_user_data_job";
/**
 * Request message for
 * [OfflineUserDataJobService.CreateOfflineUserDataJob][google.ads.googleads.v11.services.OfflineUserDataJobService.CreateOfflineUserDataJob].
 *
 * @generated from protobuf message google.ads.googleads.v11.services.CreateOfflineUserDataJobRequest
 */
export interface CreateOfflineUserDataJobRequest {
    /**
     * Required. The ID of the customer for which to create an offline user data job.
     *
     * @generated from protobuf field: string customer_id = 1;
     */
    customerId: string;
    /**
     * Required. The offline user data job to be created.
     *
     * @generated from protobuf field: google.ads.googleads.v11.resources.OfflineUserDataJob job = 2;
     */
    job?: OfflineUserDataJob;
    /**
     * If true, the request is validated but not executed. Only errors are
     * returned, not results.
     *
     * @generated from protobuf field: bool validate_only = 3;
     */
    validateOnly: boolean;
    /**
     * If true, match rate range for the offline user data job is calculated and
     * made available in the resource.
     *
     * @generated from protobuf field: bool enable_match_rate_range_preview = 5;
     */
    enableMatchRateRangePreview: boolean;
}
/**
 * Response message for
 * [OfflineUserDataJobService.CreateOfflineUserDataJob][google.ads.googleads.v11.services.OfflineUserDataJobService.CreateOfflineUserDataJob].
 *
 * @generated from protobuf message google.ads.googleads.v11.services.CreateOfflineUserDataJobResponse
 */
export interface CreateOfflineUserDataJobResponse {
    /**
     * The resource name of the OfflineUserDataJob.
     *
     * @generated from protobuf field: string resource_name = 1;
     */
    resourceName: string;
}
/**
 * Request message for [OfflineUserDataJobService.RunOfflineUserDataJob][google.ads.googleads.v11.services.OfflineUserDataJobService.RunOfflineUserDataJob].
 *
 * @generated from protobuf message google.ads.googleads.v11.services.RunOfflineUserDataJobRequest
 */
export interface RunOfflineUserDataJobRequest {
    /**
     * Required. The resource name of the OfflineUserDataJob to run.
     *
     * @generated from protobuf field: string resource_name = 1;
     */
    resourceName: string;
    /**
     * If true, the request is validated but not executed. Only errors are
     * returned, not results.
     *
     * @generated from protobuf field: bool validate_only = 2;
     */
    validateOnly: boolean;
}
/**
 * Request message for
 * [OfflineUserDataJobService.AddOfflineUserDataJobOperations][google.ads.googleads.v11.services.OfflineUserDataJobService.AddOfflineUserDataJobOperations].
 *
 * @generated from protobuf message google.ads.googleads.v11.services.AddOfflineUserDataJobOperationsRequest
 */
export interface AddOfflineUserDataJobOperationsRequest {
    /**
     * Required. The resource name of the OfflineUserDataJob.
     *
     * @generated from protobuf field: string resource_name = 1;
     */
    resourceName: string;
    /**
     * True to enable partial failure for the offline user data job.
     *
     * @generated from protobuf field: optional bool enable_partial_failure = 4;
     */
    enablePartialFailure?: boolean;
    /**
     * True to enable warnings for the offline user data job. When enabled, a
     * warning will not block the OfflineUserDataJobOperation, and will also
     * return warning messages about malformed field values.
     *
     * @generated from protobuf field: optional bool enable_warnings = 6;
     */
    enableWarnings?: boolean;
    /**
     * Required. The list of operations to be done.
     *
     * @generated from protobuf field: repeated google.ads.googleads.v11.services.OfflineUserDataJobOperation operations = 3;
     */
    operations: OfflineUserDataJobOperation[];
    /**
     * If true, the request is validated but not executed. Only errors are
     * returned, not results.
     *
     * @generated from protobuf field: bool validate_only = 5;
     */
    validateOnly: boolean;
}
/**
 * Operation to be made for the AddOfflineUserDataJobOperationsRequest.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.OfflineUserDataJobOperation
 */
export interface OfflineUserDataJobOperation {
    /**
     * @generated from protobuf oneof: operation
     */
    operation: {
        oneofKind: "create";
        /**
         * Add the provided data to the transaction. Data cannot be retrieved after
         * being uploaded.
         *
         * @generated from protobuf field: google.ads.googleads.v11.common.UserData create = 1;
         */
        create: UserData;
    } | {
        oneofKind: "remove";
        /**
         * Remove the provided data from the transaction. Data cannot be retrieved
         * after being uploaded.
         *
         * @generated from protobuf field: google.ads.googleads.v11.common.UserData remove = 2;
         */
        remove: UserData;
    } | {
        oneofKind: "removeAll";
        /**
         * Remove all previously provided data. This is only supported for Customer
         * Match.
         *
         * @generated from protobuf field: bool remove_all = 3;
         */
        removeAll: boolean;
    } | {
        oneofKind: undefined;
    };
}
/**
 * Response message for
 * [OfflineUserDataJobService.AddOfflineUserDataJobOperations][google.ads.googleads.v11.services.OfflineUserDataJobService.AddOfflineUserDataJobOperations].
 *
 * @generated from protobuf message google.ads.googleads.v11.services.AddOfflineUserDataJobOperationsResponse
 */
export interface AddOfflineUserDataJobOperationsResponse {
    /**
     * Errors that pertain to operation failures in the partial failure mode.
     * Returned only when partial_failure = true and all errors occur inside the
     * operations. If any errors occur outside the operations (for example, auth
     * errors), we return an RPC level error.
     *
     * @generated from protobuf field: google.rpc.Status partial_failure_error = 1;
     */
    partialFailureError?: Status;
    /**
     * Non blocking errors that pertain to operation failures in the warnings
     * mode. Returned only when enable_warnings = true.
     *
     * @generated from protobuf field: google.rpc.Status warning = 2;
     */
    warning?: Status;
}
declare class CreateOfflineUserDataJobRequest$Type extends MessageType<CreateOfflineUserDataJobRequest> {
    constructor();
    create(value?: PartialMessage<CreateOfflineUserDataJobRequest>): CreateOfflineUserDataJobRequest;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: CreateOfflineUserDataJobRequest): CreateOfflineUserDataJobRequest;
    internalBinaryWrite(message: CreateOfflineUserDataJobRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.CreateOfflineUserDataJobRequest
 */
export declare const CreateOfflineUserDataJobRequest: CreateOfflineUserDataJobRequest$Type;
declare class CreateOfflineUserDataJobResponse$Type extends MessageType<CreateOfflineUserDataJobResponse> {
    constructor();
    create(value?: PartialMessage<CreateOfflineUserDataJobResponse>): CreateOfflineUserDataJobResponse;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: CreateOfflineUserDataJobResponse): CreateOfflineUserDataJobResponse;
    internalBinaryWrite(message: CreateOfflineUserDataJobResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.CreateOfflineUserDataJobResponse
 */
export declare const CreateOfflineUserDataJobResponse: CreateOfflineUserDataJobResponse$Type;
declare class RunOfflineUserDataJobRequest$Type extends MessageType<RunOfflineUserDataJobRequest> {
    constructor();
    create(value?: PartialMessage<RunOfflineUserDataJobRequest>): RunOfflineUserDataJobRequest;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: RunOfflineUserDataJobRequest): RunOfflineUserDataJobRequest;
    internalBinaryWrite(message: RunOfflineUserDataJobRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.RunOfflineUserDataJobRequest
 */
export declare const RunOfflineUserDataJobRequest: RunOfflineUserDataJobRequest$Type;
declare class AddOfflineUserDataJobOperationsRequest$Type extends MessageType<AddOfflineUserDataJobOperationsRequest> {
    constructor();
    create(value?: PartialMessage<AddOfflineUserDataJobOperationsRequest>): AddOfflineUserDataJobOperationsRequest;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: AddOfflineUserDataJobOperationsRequest): AddOfflineUserDataJobOperationsRequest;
    internalBinaryWrite(message: AddOfflineUserDataJobOperationsRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.AddOfflineUserDataJobOperationsRequest
 */
export declare const AddOfflineUserDataJobOperationsRequest: AddOfflineUserDataJobOperationsRequest$Type;
declare class OfflineUserDataJobOperation$Type extends MessageType<OfflineUserDataJobOperation> {
    constructor();
    create(value?: PartialMessage<OfflineUserDataJobOperation>): OfflineUserDataJobOperation;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: OfflineUserDataJobOperation): OfflineUserDataJobOperation;
    internalBinaryWrite(message: OfflineUserDataJobOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.OfflineUserDataJobOperation
 */
export declare const OfflineUserDataJobOperation: OfflineUserDataJobOperation$Type;
declare class AddOfflineUserDataJobOperationsResponse$Type extends MessageType<AddOfflineUserDataJobOperationsResponse> {
    constructor();
    create(value?: PartialMessage<AddOfflineUserDataJobOperationsResponse>): AddOfflineUserDataJobOperationsResponse;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: AddOfflineUserDataJobOperationsResponse): AddOfflineUserDataJobOperationsResponse;
    internalBinaryWrite(message: AddOfflineUserDataJobOperationsResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.AddOfflineUserDataJobOperationsResponse
 */
export declare const AddOfflineUserDataJobOperationsResponse: AddOfflineUserDataJobOperationsResponse$Type;
/**
 * @generated ServiceType for protobuf service google.ads.googleads.v11.services.OfflineUserDataJobService
 */
export declare const OfflineUserDataJobService: ServiceType;
export {};