google-ads-api-client/dist/protos/bindings/ads/services/ad_group_customizer_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 { AdGroupCustomizer } from "../resources/ad_group_customizer";
import { ResponseContentTypeEnum_ResponseContentType } from "../enums/response_content_type";
/**
 * Request message for
 * [AdGroupCustomizerService.MutateAdGroupCustomizers][google.ads.googleads.v11.services.AdGroupCustomizerService.MutateAdGroupCustomizers].
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateAdGroupCustomizersRequest
 */
export interface MutateAdGroupCustomizersRequest {
    /**
     * Required. The ID of the customer whose ad group customizers are being modified.
     *
     * @generated from protobuf field: string customer_id = 1;
     */
    customerId: string;
    /**
     * Required. The list of operations to perform on individual ad group customizers.
     *
     * @generated from protobuf field: repeated google.ads.googleads.v11.services.AdGroupCustomizerOperation operations = 2;
     */
    operations: AdGroupCustomizerOperation[];
    /**
     * If true, successful operations will be carried out and invalid
     * operations will return errors. If false, all operations will be carried
     * out in one transaction if and only if they are all valid.
     * Default is false.
     *
     * @generated from protobuf field: bool partial_failure = 3;
     */
    partialFailure: boolean;
    /**
     * If true, the request is validated but not executed. Only errors are
     * returned, not results.
     *
     * @generated from protobuf field: bool validate_only = 4;
     */
    validateOnly: boolean;
    /**
     * The response content type setting. Determines whether the mutable resource
     * or just the resource name should be returned post mutation.
     *
     * @generated from protobuf field: google.ads.googleads.v11.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
     */
    responseContentType: ResponseContentTypeEnum_ResponseContentType;
}
/**
 * A single operation (create, remove) on an customizer attribute.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.AdGroupCustomizerOperation
 */
export interface AdGroupCustomizerOperation {
    /**
     * @generated from protobuf oneof: operation
     */
    operation: {
        oneofKind: "create";
        /**
         * Create operation: No resource name is expected for the new ad group
         * customizer
         *
         * @generated from protobuf field: google.ads.googleads.v11.resources.AdGroupCustomizer create = 1;
         */
        create: AdGroupCustomizer;
    } | {
        oneofKind: "remove";
        /**
         * Remove operation: A resource name for the removed ad group customizer is
         * expected, in this format:
         * `customers/{customer_id}/adGroupCustomizers/{ad_group_id}~{customizer_attribute_id}`
         *
         * @generated from protobuf field: string remove = 2;
         */
        remove: string;
    } | {
        oneofKind: undefined;
    };
}
/**
 * Response message for an ad group customizer mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateAdGroupCustomizersResponse
 */
export interface MutateAdGroupCustomizersResponse {
    /**
     * All results for the mutate.
     *
     * @generated from protobuf field: repeated google.ads.googleads.v11.services.MutateAdGroupCustomizerResult results = 1;
     */
    results: MutateAdGroupCustomizerResult[];
    /**
     * 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 = 2;
     */
    partialFailureError?: Status;
}
/**
 * The result for the ad group customizer mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateAdGroupCustomizerResult
 */
export interface MutateAdGroupCustomizerResult {
    /**
     * Returned for successful operations.
     *
     * @generated from protobuf field: string resource_name = 1;
     */
    resourceName: string;
    /**
     * The mutated AdGroupCustomizer with only mutable fields after mutate.
     * The field will only be returned when response_content_type is set to
     * "MUTABLE_RESOURCE".
     *
     * @generated from protobuf field: google.ads.googleads.v11.resources.AdGroupCustomizer ad_group_customizer = 2;
     */
    adGroupCustomizer?: AdGroupCustomizer;
}
declare class MutateAdGroupCustomizersRequest$Type extends MessageType<MutateAdGroupCustomizersRequest> {
    constructor();
    create(value?: PartialMessage<MutateAdGroupCustomizersRequest>): MutateAdGroupCustomizersRequest;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateAdGroupCustomizersRequest): MutateAdGroupCustomizersRequest;
    internalBinaryWrite(message: MutateAdGroupCustomizersRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateAdGroupCustomizersRequest
 */
export declare const MutateAdGroupCustomizersRequest: MutateAdGroupCustomizersRequest$Type;
declare class AdGroupCustomizerOperation$Type extends MessageType<AdGroupCustomizerOperation> {
    constructor();
    create(value?: PartialMessage<AdGroupCustomizerOperation>): AdGroupCustomizerOperation;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: AdGroupCustomizerOperation): AdGroupCustomizerOperation;
    internalBinaryWrite(message: AdGroupCustomizerOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.AdGroupCustomizerOperation
 */
export declare const AdGroupCustomizerOperation: AdGroupCustomizerOperation$Type;
declare class MutateAdGroupCustomizersResponse$Type extends MessageType<MutateAdGroupCustomizersResponse> {
    constructor();
    create(value?: PartialMessage<MutateAdGroupCustomizersResponse>): MutateAdGroupCustomizersResponse;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateAdGroupCustomizersResponse): MutateAdGroupCustomizersResponse;
    internalBinaryWrite(message: MutateAdGroupCustomizersResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateAdGroupCustomizersResponse
 */
export declare const MutateAdGroupCustomizersResponse: MutateAdGroupCustomizersResponse$Type;
declare class MutateAdGroupCustomizerResult$Type extends MessageType<MutateAdGroupCustomizerResult> {
    constructor();
    create(value?: PartialMessage<MutateAdGroupCustomizerResult>): MutateAdGroupCustomizerResult;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateAdGroupCustomizerResult): MutateAdGroupCustomizerResult;
    internalBinaryWrite(message: MutateAdGroupCustomizerResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateAdGroupCustomizerResult
 */
export declare const MutateAdGroupCustomizerResult: MutateAdGroupCustomizerResult$Type;
/**
 * @generated ServiceType for protobuf service google.ads.googleads.v11.services.AdGroupCustomizerService
 */
export declare const AdGroupCustomizerService: ServiceType;
export {};