google-ads-api-client/dist/protos/bindings/ads/services/customer_client_link_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 { CustomerClientLink } from "../resources/customer_client_link";
import { FieldMask } from "../../google/protobuf/field_mask";
/**
 * Request message for [CustomerClientLinkService.MutateCustomerClientLink][google.ads.googleads.v11.services.CustomerClientLinkService.MutateCustomerClientLink].
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateCustomerClientLinkRequest
 */
export interface MutateCustomerClientLinkRequest {
    /**
     * Required. The ID of the customer whose customer link are being modified.
     *
     * @generated from protobuf field: string customer_id = 1;
     */
    customerId: string;
    /**
     * Required. The operation to perform on the individual CustomerClientLink.
     *
     * @generated from protobuf field: google.ads.googleads.v11.services.CustomerClientLinkOperation operation = 2;
     */
    operation?: CustomerClientLinkOperation;
    /**
     * 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 CustomerClientLink.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.CustomerClientLinkOperation
 */
export interface CustomerClientLinkOperation {
    /**
     * 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 link.
         *
         * @generated from protobuf field: google.ads.googleads.v11.resources.CustomerClientLink create = 1;
         */
        create: CustomerClientLink;
    } | {
        oneofKind: "update";
        /**
         * Update operation: The link is expected to have a valid resource name.
         *
         * @generated from protobuf field: google.ads.googleads.v11.resources.CustomerClientLink update = 2;
         */
        update: CustomerClientLink;
    } | {
        oneofKind: undefined;
    };
}
/**
 * Response message for a CustomerClientLink mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateCustomerClientLinkResponse
 */
export interface MutateCustomerClientLinkResponse {
    /**
     * A result that identifies the resource affected by the mutate request.
     *
     * @generated from protobuf field: google.ads.googleads.v11.services.MutateCustomerClientLinkResult result = 1;
     */
    result?: MutateCustomerClientLinkResult;
}
/**
 * The result for a single customer client link mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateCustomerClientLinkResult
 */
export interface MutateCustomerClientLinkResult {
    /**
     * Returned for successful operations.
     *
     * @generated from protobuf field: string resource_name = 1;
     */
    resourceName: string;
}
declare class MutateCustomerClientLinkRequest$Type extends MessageType<MutateCustomerClientLinkRequest> {
    constructor();
    create(value?: PartialMessage<MutateCustomerClientLinkRequest>): MutateCustomerClientLinkRequest;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCustomerClientLinkRequest): MutateCustomerClientLinkRequest;
    internalBinaryWrite(message: MutateCustomerClientLinkRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCustomerClientLinkRequest
 */
export declare const MutateCustomerClientLinkRequest: MutateCustomerClientLinkRequest$Type;
declare class CustomerClientLinkOperation$Type extends MessageType<CustomerClientLinkOperation> {
    constructor();
    create(value?: PartialMessage<CustomerClientLinkOperation>): CustomerClientLinkOperation;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: CustomerClientLinkOperation): CustomerClientLinkOperation;
    internalBinaryWrite(message: CustomerClientLinkOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.CustomerClientLinkOperation
 */
export declare const CustomerClientLinkOperation: CustomerClientLinkOperation$Type;
declare class MutateCustomerClientLinkResponse$Type extends MessageType<MutateCustomerClientLinkResponse> {
    constructor();
    create(value?: PartialMessage<MutateCustomerClientLinkResponse>): MutateCustomerClientLinkResponse;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCustomerClientLinkResponse): MutateCustomerClientLinkResponse;
    internalBinaryWrite(message: MutateCustomerClientLinkResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCustomerClientLinkResponse
 */
export declare const MutateCustomerClientLinkResponse: MutateCustomerClientLinkResponse$Type;
declare class MutateCustomerClientLinkResult$Type extends MessageType<MutateCustomerClientLinkResult> {
    constructor();
    create(value?: PartialMessage<MutateCustomerClientLinkResult>): MutateCustomerClientLinkResult;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCustomerClientLinkResult): MutateCustomerClientLinkResult;
    internalBinaryWrite(message: MutateCustomerClientLinkResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCustomerClientLinkResult
 */
export declare const MutateCustomerClientLinkResult: MutateCustomerClientLinkResult$Type;
/**
 * @generated ServiceType for protobuf service google.ads.googleads.v11.services.CustomerClientLinkService
 */
export declare const CustomerClientLinkService: ServiceType;
export {};