google-ads-api-client/dist/protos/bindings/ads/services/keyword_plan_campaign_keyword_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 { KeywordPlanCampaignKeyword } from "../resources/keyword_plan_campaign_keyword";
import { FieldMask } from "../../google/protobuf/field_mask";
/**
 * Request message for
 * [KeywordPlanCampaignKeywordService.MutateKeywordPlanCampaignKeywords][google.ads.googleads.v11.services.KeywordPlanCampaignKeywordService.MutateKeywordPlanCampaignKeywords].
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateKeywordPlanCampaignKeywordsRequest
 */
export interface MutateKeywordPlanCampaignKeywordsRequest {
    /**
     * Required. The ID of the customer whose campaign keywords are being modified.
     *
     * @generated from protobuf field: string customer_id = 1;
     */
    customerId: string;
    /**
     * Required. The list of operations to perform on individual Keyword Plan campaign
     * keywords.
     *
     * @generated from protobuf field: repeated google.ads.googleads.v11.services.KeywordPlanCampaignKeywordOperation operations = 2;
     */
    operations: KeywordPlanCampaignKeywordOperation[];
    /**
     * 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 campaign
 * keyword.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.KeywordPlanCampaignKeywordOperation
 */
export interface KeywordPlanCampaignKeywordOperation {
    /**
     * 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
         * campaign keyword.
         *
         * @generated from protobuf field: google.ads.googleads.v11.resources.KeywordPlanCampaignKeyword create = 1;
         */
        create: KeywordPlanCampaignKeyword;
    } | {
        oneofKind: "update";
        /**
         * Update operation: The Keyword Plan campaign keyword expected to have a
         * valid resource name.
         *
         * @generated from protobuf field: google.ads.googleads.v11.resources.KeywordPlanCampaignKeyword update = 2;
         */
        update: KeywordPlanCampaignKeyword;
    } | {
        oneofKind: "remove";
        /**
         * Remove operation: A resource name for the removed Keyword Plan campaign
         * keywords expected in this format:
         *
         * `customers/{customer_id}/keywordPlanCampaignKeywords/{kp_campaign_keyword_id}`
         *
         * @generated from protobuf field: string remove = 3;
         */
        remove: string;
    } | {
        oneofKind: undefined;
    };
}
/**
 * Response message for a Keyword Plan campaign keyword mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateKeywordPlanCampaignKeywordsResponse
 */
export interface MutateKeywordPlanCampaignKeywordsResponse {
    /**
     * 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.MutateKeywordPlanCampaignKeywordResult results = 2;
     */
    results: MutateKeywordPlanCampaignKeywordResult[];
}
/**
 * The result for the Keyword Plan campaign keyword mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateKeywordPlanCampaignKeywordResult
 */
export interface MutateKeywordPlanCampaignKeywordResult {
    /**
     * Returned for successful operations.
     *
     * @generated from protobuf field: string resource_name = 1;
     */
    resourceName: string;
}
declare class MutateKeywordPlanCampaignKeywordsRequest$Type extends MessageType<MutateKeywordPlanCampaignKeywordsRequest> {
    constructor();
    create(value?: PartialMessage<MutateKeywordPlanCampaignKeywordsRequest>): MutateKeywordPlanCampaignKeywordsRequest;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateKeywordPlanCampaignKeywordsRequest): MutateKeywordPlanCampaignKeywordsRequest;
    internalBinaryWrite(message: MutateKeywordPlanCampaignKeywordsRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateKeywordPlanCampaignKeywordsRequest
 */
export declare const MutateKeywordPlanCampaignKeywordsRequest: MutateKeywordPlanCampaignKeywordsRequest$Type;
declare class KeywordPlanCampaignKeywordOperation$Type extends MessageType<KeywordPlanCampaignKeywordOperation> {
    constructor();
    create(value?: PartialMessage<KeywordPlanCampaignKeywordOperation>): KeywordPlanCampaignKeywordOperation;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: KeywordPlanCampaignKeywordOperation): KeywordPlanCampaignKeywordOperation;
    internalBinaryWrite(message: KeywordPlanCampaignKeywordOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.KeywordPlanCampaignKeywordOperation
 */
export declare const KeywordPlanCampaignKeywordOperation: KeywordPlanCampaignKeywordOperation$Type;
declare class MutateKeywordPlanCampaignKeywordsResponse$Type extends MessageType<MutateKeywordPlanCampaignKeywordsResponse> {
    constructor();
    create(value?: PartialMessage<MutateKeywordPlanCampaignKeywordsResponse>): MutateKeywordPlanCampaignKeywordsResponse;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateKeywordPlanCampaignKeywordsResponse): MutateKeywordPlanCampaignKeywordsResponse;
    internalBinaryWrite(message: MutateKeywordPlanCampaignKeywordsResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateKeywordPlanCampaignKeywordsResponse
 */
export declare const MutateKeywordPlanCampaignKeywordsResponse: MutateKeywordPlanCampaignKeywordsResponse$Type;
declare class MutateKeywordPlanCampaignKeywordResult$Type extends MessageType<MutateKeywordPlanCampaignKeywordResult> {
    constructor();
    create(value?: PartialMessage<MutateKeywordPlanCampaignKeywordResult>): MutateKeywordPlanCampaignKeywordResult;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateKeywordPlanCampaignKeywordResult): MutateKeywordPlanCampaignKeywordResult;
    internalBinaryWrite(message: MutateKeywordPlanCampaignKeywordResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateKeywordPlanCampaignKeywordResult
 */
export declare const MutateKeywordPlanCampaignKeywordResult: MutateKeywordPlanCampaignKeywordResult$Type;
/**
 * @generated ServiceType for protobuf service google.ads.googleads.v11.services.KeywordPlanCampaignKeywordService
 */
export declare const KeywordPlanCampaignKeywordService: ServiceType;
export {};