google-ads-api-client/dist/protos/bindings/ads/services/custom_audience_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 { CustomAudience } from "../resources/custom_audience";
import { FieldMask } from "../../google/protobuf/field_mask";
/**
 * Request message for [CustomAudienceService.MutateCustomAudiences][google.ads.googleads.v11.services.CustomAudienceService.MutateCustomAudiences].
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateCustomAudiencesRequest
 */
export interface MutateCustomAudiencesRequest {
    /**
     * Required. The ID of the customer whose custom audiences are being modified.
     *
     * @generated from protobuf field: string customer_id = 1;
     */
    customerId: string;
    /**
     * Required. The list of operations to perform on individual custom audiences.
     *
     * @generated from protobuf field: repeated google.ads.googleads.v11.services.CustomAudienceOperation operations = 2;
     */
    operations: CustomAudienceOperation[];
    /**
     * 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;
}
/**
 * A single operation (create, update) on a custom audience.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.CustomAudienceOperation
 */
export interface CustomAudienceOperation {
    /**
     * FieldMask that determines which resource fields are modified in an update.
     *
     * @generated from protobuf field: google.protobuf.FieldMask update_mask = 4;
     */
    updateMask?: FieldMask;
    /**
     * @generated from protobuf oneof: operation
     */
    operation: {
        oneofKind: "create";
        /**
         * Create operation: No resource name is expected for the new custom
         * audience.
         *
         * @generated from protobuf field: google.ads.googleads.v11.resources.CustomAudience create = 1;
         */
        create: CustomAudience;
    } | {
        oneofKind: "update";
        /**
         * Update operation: The custom audience is expected to have a valid
         * resource name.
         *
         * @generated from protobuf field: google.ads.googleads.v11.resources.CustomAudience update = 2;
         */
        update: CustomAudience;
    } | {
        oneofKind: "remove";
        /**
         * Remove operation: A resource name for the removed custom audience is
         * expected, in this format:
         *
         * `customers/{customer_id}/customAudiences/{custom_audience_id}`
         *
         * @generated from protobuf field: string remove = 3;
         */
        remove: string;
    } | {
        oneofKind: undefined;
    };
}
/**
 * Response message for custom audience mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateCustomAudiencesResponse
 */
export interface MutateCustomAudiencesResponse {
    /**
     * All results for the mutate.
     *
     * @generated from protobuf field: repeated google.ads.googleads.v11.services.MutateCustomAudienceResult results = 1;
     */
    results: MutateCustomAudienceResult[];
}
/**
 * The result for the custom audience mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateCustomAudienceResult
 */
export interface MutateCustomAudienceResult {
    /**
     * Returned for successful operations.
     *
     * @generated from protobuf field: string resource_name = 1;
     */
    resourceName: string;
}
declare class MutateCustomAudiencesRequest$Type extends MessageType<MutateCustomAudiencesRequest> {
    constructor();
    create(value?: PartialMessage<MutateCustomAudiencesRequest>): MutateCustomAudiencesRequest;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCustomAudiencesRequest): MutateCustomAudiencesRequest;
    internalBinaryWrite(message: MutateCustomAudiencesRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCustomAudiencesRequest
 */
export declare const MutateCustomAudiencesRequest: MutateCustomAudiencesRequest$Type;
declare class CustomAudienceOperation$Type extends MessageType<CustomAudienceOperation> {
    constructor();
    create(value?: PartialMessage<CustomAudienceOperation>): CustomAudienceOperation;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: CustomAudienceOperation): CustomAudienceOperation;
    internalBinaryWrite(message: CustomAudienceOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.CustomAudienceOperation
 */
export declare const CustomAudienceOperation: CustomAudienceOperation$Type;
declare class MutateCustomAudiencesResponse$Type extends MessageType<MutateCustomAudiencesResponse> {
    constructor();
    create(value?: PartialMessage<MutateCustomAudiencesResponse>): MutateCustomAudiencesResponse;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCustomAudiencesResponse): MutateCustomAudiencesResponse;
    internalBinaryWrite(message: MutateCustomAudiencesResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCustomAudiencesResponse
 */
export declare const MutateCustomAudiencesResponse: MutateCustomAudiencesResponse$Type;
declare class MutateCustomAudienceResult$Type extends MessageType<MutateCustomAudienceResult> {
    constructor();
    create(value?: PartialMessage<MutateCustomAudienceResult>): MutateCustomAudienceResult;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCustomAudienceResult): MutateCustomAudienceResult;
    internalBinaryWrite(message: MutateCustomAudienceResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCustomAudienceResult
 */
export declare const MutateCustomAudienceResult: MutateCustomAudienceResult$Type;
/**
 * @generated ServiceType for protobuf service google.ads.googleads.v11.services.CustomAudienceService
 */
export declare const CustomAudienceService: ServiceType;
export {};