google-ads-api-client/dist/protos/bindings/ads/services/keyword_plan_ad_group_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 { KeywordPlanAdGroup } from "../resources/keyword_plan_ad_group";
import { FieldMask } from "../../google/protobuf/field_mask";
/**
 * Request message for [KeywordPlanAdGroupService.MutateKeywordPlanAdGroups][google.ads.googleads.v11.services.KeywordPlanAdGroupService.MutateKeywordPlanAdGroups].
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateKeywordPlanAdGroupsRequest
 */
export interface MutateKeywordPlanAdGroupsRequest {
    /**
     * Required. The ID of the customer whose Keyword Plan ad groups are being modified.
     *
     * @generated from protobuf field: string customer_id = 1;
     */
    customerId: string;
    /**
     * Required. The list of operations to perform on individual Keyword Plan ad groups.
     *
     * @generated from protobuf field: repeated google.ads.googleads.v11.services.KeywordPlanAdGroupOperation operations = 2;
     */
    operations: KeywordPlanAdGroupOperation[];
    /**
     * 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, update, remove) on a Keyword Plan ad group.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.KeywordPlanAdGroupOperation
 */
export interface KeywordPlanAdGroupOperation {
    /**
     * The 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 Keyword Plan
         * ad group.
         *
         * @generated from protobuf field: google.ads.googleads.v11.resources.KeywordPlanAdGroup create = 1;
         */
        create: KeywordPlanAdGroup;
    } | {
        oneofKind: "update";
        /**
         * Update operation: The Keyword Plan ad group is expected to have a valid
         * resource name.
         *
         * @generated from protobuf field: google.ads.googleads.v11.resources.KeywordPlanAdGroup update = 2;
         */
        update: KeywordPlanAdGroup;
    } | {
        oneofKind: "remove";
        /**
         * Remove operation: A resource name for the removed Keyword Plan ad group
         * is expected, in this format:
         *
         * `customers/{customer_id}/keywordPlanAdGroups/{kp_ad_group_id}`
         *
         * @generated from protobuf field: string remove = 3;
         */
        remove: string;
    } | {
        oneofKind: undefined;
    };
}
/**
 * Response message for a Keyword Plan ad group mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateKeywordPlanAdGroupsResponse
 */
export interface MutateKeywordPlanAdGroupsResponse {
    /**
     * 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. The order of the results is determined by the
     * order of the keywords in the original request.
     *
     * @generated from protobuf field: repeated google.ads.googleads.v11.services.MutateKeywordPlanAdGroupResult results = 2;
     */
    results: MutateKeywordPlanAdGroupResult[];
}
/**
 * The result for the Keyword Plan ad group mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateKeywordPlanAdGroupResult
 */
export interface MutateKeywordPlanAdGroupResult {
    /**
     * Returned for successful operations.
     *
     * @generated from protobuf field: string resource_name = 1;
     */
    resourceName: string;
}
declare class MutateKeywordPlanAdGroupsRequest$Type extends MessageType<MutateKeywordPlanAdGroupsRequest> {
    constructor();
    create(value?: PartialMessage<MutateKeywordPlanAdGroupsRequest>): MutateKeywordPlanAdGroupsRequest;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateKeywordPlanAdGroupsRequest): MutateKeywordPlanAdGroupsRequest;
    internalBinaryWrite(message: MutateKeywordPlanAdGroupsRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateKeywordPlanAdGroupsRequest
 */
export declare const MutateKeywordPlanAdGroupsRequest: MutateKeywordPlanAdGroupsRequest$Type;
declare class KeywordPlanAdGroupOperation$Type extends MessageType<KeywordPlanAdGroupOperation> {
    constructor();
    create(value?: PartialMessage<KeywordPlanAdGroupOperation>): KeywordPlanAdGroupOperation;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: KeywordPlanAdGroupOperation): KeywordPlanAdGroupOperation;
    internalBinaryWrite(message: KeywordPlanAdGroupOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.KeywordPlanAdGroupOperation
 */
export declare const KeywordPlanAdGroupOperation: KeywordPlanAdGroupOperation$Type;
declare class MutateKeywordPlanAdGroupsResponse$Type extends MessageType<MutateKeywordPlanAdGroupsResponse> {
    constructor();
    create(value?: PartialMessage<MutateKeywordPlanAdGroupsResponse>): MutateKeywordPlanAdGroupsResponse;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateKeywordPlanAdGroupsResponse): MutateKeywordPlanAdGroupsResponse;
    internalBinaryWrite(message: MutateKeywordPlanAdGroupsResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateKeywordPlanAdGroupsResponse
 */
export declare const MutateKeywordPlanAdGroupsResponse: MutateKeywordPlanAdGroupsResponse$Type;
declare class MutateKeywordPlanAdGroupResult$Type extends MessageType<MutateKeywordPlanAdGroupResult> {
    constructor();
    create(value?: PartialMessage<MutateKeywordPlanAdGroupResult>): MutateKeywordPlanAdGroupResult;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateKeywordPlanAdGroupResult): MutateKeywordPlanAdGroupResult;
    internalBinaryWrite(message: MutateKeywordPlanAdGroupResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateKeywordPlanAdGroupResult
 */
export declare const MutateKeywordPlanAdGroupResult: MutateKeywordPlanAdGroupResult$Type;
/**
 * @generated ServiceType for protobuf service google.ads.googleads.v11.services.KeywordPlanAdGroupService
 */
export declare const KeywordPlanAdGroupService: ServiceType;
export {};