google-ads-api-client/dist/protos/bindings/ads/services/merchant_center_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 { FieldMask } from "../../google/protobuf/field_mask";
import { MerchantCenterLink } from "../resources/merchant_center_link";
/**
 * Request message for [MerchantCenterLinkService.ListMerchantCenterLinks][google.ads.googleads.v11.services.MerchantCenterLinkService.ListMerchantCenterLinks].
 *
 * @generated from protobuf message google.ads.googleads.v11.services.ListMerchantCenterLinksRequest
 */
export interface ListMerchantCenterLinksRequest {
    /**
     * Required. The ID of the customer onto which to apply the Merchant Center link list
     * operation.
     *
     * @generated from protobuf field: string customer_id = 1;
     */
    customerId: string;
}
/**
 * Response message for [MerchantCenterLinkService.ListMerchantCenterLinks][google.ads.googleads.v11.services.MerchantCenterLinkService.ListMerchantCenterLinks].
 *
 * @generated from protobuf message google.ads.googleads.v11.services.ListMerchantCenterLinksResponse
 */
export interface ListMerchantCenterLinksResponse {
    /**
     * Merchant Center links available for the requested customer
     *
     * @generated from protobuf field: repeated google.ads.googleads.v11.resources.MerchantCenterLink merchant_center_links = 1;
     */
    merchantCenterLinks: MerchantCenterLink[];
}
/**
 * Request message for [MerchantCenterLinkService.GetMerchantCenterLink][google.ads.googleads.v11.services.MerchantCenterLinkService.GetMerchantCenterLink].
 *
 * @generated from protobuf message google.ads.googleads.v11.services.GetMerchantCenterLinkRequest
 */
export interface GetMerchantCenterLinkRequest {
    /**
     * Required. Resource name of the Merchant Center link.
     *
     * @generated from protobuf field: string resource_name = 1;
     */
    resourceName: string;
}
/**
 * Request message for [MerchantCenterLinkService.MutateMerchantCenterLink][google.ads.googleads.v11.services.MerchantCenterLinkService.MutateMerchantCenterLink].
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateMerchantCenterLinkRequest
 */
export interface MutateMerchantCenterLinkRequest {
    /**
     * Required. The ID of the customer being modified.
     *
     * @generated from protobuf field: string customer_id = 1;
     */
    customerId: string;
    /**
     * Required. The operation to perform on the link
     *
     * @generated from protobuf field: google.ads.googleads.v11.services.MerchantCenterLinkOperation operation = 2;
     */
    operation?: MerchantCenterLinkOperation;
    /**
     * 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 update on a Merchant Center link.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MerchantCenterLinkOperation
 */
export interface MerchantCenterLinkOperation {
    /**
     * FieldMask that determines which resource fields are modified in an update.
     *
     * @generated from protobuf field: google.protobuf.FieldMask update_mask = 3;
     */
    updateMask?: FieldMask;
    /**
     * @generated from protobuf oneof: operation
     */
    operation: {
        oneofKind: "update";
        /**
         * Update operation: The merchant center link is expected to have a valid
         * resource name.
         *
         * @generated from protobuf field: google.ads.googleads.v11.resources.MerchantCenterLink update = 1;
         */
        update: MerchantCenterLink;
    } | {
        oneofKind: "remove";
        /**
         * Remove operation: A resource name for the removed merchant center link is
         * expected, in this format:
         *
         * `customers/{customer_id}/merchantCenterLinks/{merchant_center_id}`
         *
         * @generated from protobuf field: string remove = 2;
         */
        remove: string;
    } | {
        oneofKind: undefined;
    };
}
/**
 * Response message for Merchant Center link mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateMerchantCenterLinkResponse
 */
export interface MutateMerchantCenterLinkResponse {
    /**
     * Result for the mutate.
     *
     * @generated from protobuf field: google.ads.googleads.v11.services.MutateMerchantCenterLinkResult result = 2;
     */
    result?: MutateMerchantCenterLinkResult;
}
/**
 * The result for the Merchant Center link mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateMerchantCenterLinkResult
 */
export interface MutateMerchantCenterLinkResult {
    /**
     * Returned for successful operations.
     *
     * @generated from protobuf field: string resource_name = 1;
     */
    resourceName: string;
}
declare class ListMerchantCenterLinksRequest$Type extends MessageType<ListMerchantCenterLinksRequest> {
    constructor();
    create(value?: PartialMessage<ListMerchantCenterLinksRequest>): ListMerchantCenterLinksRequest;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: ListMerchantCenterLinksRequest): ListMerchantCenterLinksRequest;
    internalBinaryWrite(message: ListMerchantCenterLinksRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.ListMerchantCenterLinksRequest
 */
export declare const ListMerchantCenterLinksRequest: ListMerchantCenterLinksRequest$Type;
declare class ListMerchantCenterLinksResponse$Type extends MessageType<ListMerchantCenterLinksResponse> {
    constructor();
    create(value?: PartialMessage<ListMerchantCenterLinksResponse>): ListMerchantCenterLinksResponse;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: ListMerchantCenterLinksResponse): ListMerchantCenterLinksResponse;
    internalBinaryWrite(message: ListMerchantCenterLinksResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.ListMerchantCenterLinksResponse
 */
export declare const ListMerchantCenterLinksResponse: ListMerchantCenterLinksResponse$Type;
declare class GetMerchantCenterLinkRequest$Type extends MessageType<GetMerchantCenterLinkRequest> {
    constructor();
    create(value?: PartialMessage<GetMerchantCenterLinkRequest>): GetMerchantCenterLinkRequest;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: GetMerchantCenterLinkRequest): GetMerchantCenterLinkRequest;
    internalBinaryWrite(message: GetMerchantCenterLinkRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.GetMerchantCenterLinkRequest
 */
export declare const GetMerchantCenterLinkRequest: GetMerchantCenterLinkRequest$Type;
declare class MutateMerchantCenterLinkRequest$Type extends MessageType<MutateMerchantCenterLinkRequest> {
    constructor();
    create(value?: PartialMessage<MutateMerchantCenterLinkRequest>): MutateMerchantCenterLinkRequest;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateMerchantCenterLinkRequest): MutateMerchantCenterLinkRequest;
    internalBinaryWrite(message: MutateMerchantCenterLinkRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateMerchantCenterLinkRequest
 */
export declare const MutateMerchantCenterLinkRequest: MutateMerchantCenterLinkRequest$Type;
declare class MerchantCenterLinkOperation$Type extends MessageType<MerchantCenterLinkOperation> {
    constructor();
    create(value?: PartialMessage<MerchantCenterLinkOperation>): MerchantCenterLinkOperation;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MerchantCenterLinkOperation): MerchantCenterLinkOperation;
    internalBinaryWrite(message: MerchantCenterLinkOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MerchantCenterLinkOperation
 */
export declare const MerchantCenterLinkOperation: MerchantCenterLinkOperation$Type;
declare class MutateMerchantCenterLinkResponse$Type extends MessageType<MutateMerchantCenterLinkResponse> {
    constructor();
    create(value?: PartialMessage<MutateMerchantCenterLinkResponse>): MutateMerchantCenterLinkResponse;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateMerchantCenterLinkResponse): MutateMerchantCenterLinkResponse;
    internalBinaryWrite(message: MutateMerchantCenterLinkResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateMerchantCenterLinkResponse
 */
export declare const MutateMerchantCenterLinkResponse: MutateMerchantCenterLinkResponse$Type;
declare class MutateMerchantCenterLinkResult$Type extends MessageType<MutateMerchantCenterLinkResult> {
    constructor();
    create(value?: PartialMessage<MutateMerchantCenterLinkResult>): MutateMerchantCenterLinkResult;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateMerchantCenterLinkResult): MutateMerchantCenterLinkResult;
    internalBinaryWrite(message: MutateMerchantCenterLinkResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateMerchantCenterLinkResult
 */
export declare const MutateMerchantCenterLinkResult: MutateMerchantCenterLinkResult$Type;
/**
 * @generated ServiceType for protobuf service google.ads.googleads.v11.services.MerchantCenterLinkService
 */
export declare const MerchantCenterLinkService: ServiceType;
export {};