google-ads-api-client/dist/protos/bindings/ads/services/ad_group_label_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 { AdGroupLabel } from "../resources/ad_group_label";
/**
 * Request message for [AdGroupLabelService.MutateAdGroupLabels][google.ads.googleads.v11.services.AdGroupLabelService.MutateAdGroupLabels].
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateAdGroupLabelsRequest
 */
export interface MutateAdGroupLabelsRequest {
    /**
     * Required. ID of the customer whose ad group labels are being modified.
     *
     * @generated from protobuf field: string customer_id = 1;
     */
    customerId: string;
    /**
     * Required. The list of operations to perform on ad group labels.
     *
     * @generated from protobuf field: repeated google.ads.googleads.v11.services.AdGroupLabelOperation operations = 2;
     */
    operations: AdGroupLabelOperation[];
    /**
     * 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;
}
/**
 * A single operation (create, remove) on an ad group label.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.AdGroupLabelOperation
 */
export interface AdGroupLabelOperation {
    /**
     * @generated from protobuf oneof: operation
     */
    operation: {
        oneofKind: "create";
        /**
         * Create operation: No resource name is expected for the new ad group
         * label.
         *
         * @generated from protobuf field: google.ads.googleads.v11.resources.AdGroupLabel create = 1;
         */
        create: AdGroupLabel;
    } | {
        oneofKind: "remove";
        /**
         * Remove operation: A resource name for the ad group label
         * being removed, in this format:
         *
         * `customers/{customer_id}/adGroupLabels/{ad_group_id}~{label_id}`
         *
         * @generated from protobuf field: string remove = 2;
         */
        remove: string;
    } | {
        oneofKind: undefined;
    };
}
/**
 * Response message for an ad group labels mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateAdGroupLabelsResponse
 */
export interface MutateAdGroupLabelsResponse {
    /**
     * 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 = 3;
     */
    partialFailureError?: Status;
    /**
     * All results for the mutate.
     *
     * @generated from protobuf field: repeated google.ads.googleads.v11.services.MutateAdGroupLabelResult results = 2;
     */
    results: MutateAdGroupLabelResult[];
}
/**
 * The result for an ad group label mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateAdGroupLabelResult
 */
export interface MutateAdGroupLabelResult {
    /**
     * Returned for successful operations.
     *
     * @generated from protobuf field: string resource_name = 1;
     */
    resourceName: string;
}
declare class MutateAdGroupLabelsRequest$Type extends MessageType<MutateAdGroupLabelsRequest> {
    constructor();
    create(value?: PartialMessage<MutateAdGroupLabelsRequest>): MutateAdGroupLabelsRequest;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateAdGroupLabelsRequest): MutateAdGroupLabelsRequest;
    internalBinaryWrite(message: MutateAdGroupLabelsRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateAdGroupLabelsRequest
 */
export declare const MutateAdGroupLabelsRequest: MutateAdGroupLabelsRequest$Type;
declare class AdGroupLabelOperation$Type extends MessageType<AdGroupLabelOperation> {
    constructor();
    create(value?: PartialMessage<AdGroupLabelOperation>): AdGroupLabelOperation;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: AdGroupLabelOperation): AdGroupLabelOperation;
    internalBinaryWrite(message: AdGroupLabelOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.AdGroupLabelOperation
 */
export declare const AdGroupLabelOperation: AdGroupLabelOperation$Type;
declare class MutateAdGroupLabelsResponse$Type extends MessageType<MutateAdGroupLabelsResponse> {
    constructor();
    create(value?: PartialMessage<MutateAdGroupLabelsResponse>): MutateAdGroupLabelsResponse;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateAdGroupLabelsResponse): MutateAdGroupLabelsResponse;
    internalBinaryWrite(message: MutateAdGroupLabelsResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateAdGroupLabelsResponse
 */
export declare const MutateAdGroupLabelsResponse: MutateAdGroupLabelsResponse$Type;
declare class MutateAdGroupLabelResult$Type extends MessageType<MutateAdGroupLabelResult> {
    constructor();
    create(value?: PartialMessage<MutateAdGroupLabelResult>): MutateAdGroupLabelResult;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateAdGroupLabelResult): MutateAdGroupLabelResult;
    internalBinaryWrite(message: MutateAdGroupLabelResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateAdGroupLabelResult
 */
export declare const MutateAdGroupLabelResult: MutateAdGroupLabelResult$Type;
/**
 * @generated ServiceType for protobuf service google.ads.googleads.v11.services.AdGroupLabelService
 */
export declare const AdGroupLabelService: ServiceType;
export {};