google-ads-api-client/dist/protos/bindings/ads/services/feed_item_set_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 { Status } from "../../google/rpc/status";
import { FeedItemSetLink } from "../resources/feed_item_set_link";
/**
 * Request message for [FeedItemSetLinkService.MutateFeedItemSetLinks][google.ads.googleads.v11.services.FeedItemSetLinkService.MutateFeedItemSetLinks].
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateFeedItemSetLinksRequest
 */
export interface MutateFeedItemSetLinksRequest {
    /**
     * Required. The ID of the customer whose feed item set links are being modified.
     *
     * @generated from protobuf field: string customer_id = 1;
     */
    customerId: string;
    /**
     * Required. The list of operations to perform on individual feed item set links.
     *
     * @generated from protobuf field: repeated google.ads.googleads.v11.services.FeedItemSetLinkOperation operations = 2;
     */
    operations: FeedItemSetLinkOperation[];
    /**
     * 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 feed item set link.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.FeedItemSetLinkOperation
 */
export interface FeedItemSetLinkOperation {
    /**
     * @generated from protobuf oneof: operation
     */
    operation: {
        oneofKind: "create";
        /**
         * Create operation: No resource name is expected for the
         * new feed item set link.
         *
         * @generated from protobuf field: google.ads.googleads.v11.resources.FeedItemSetLink create = 1;
         */
        create: FeedItemSetLink;
    } | {
        oneofKind: "remove";
        /**
         * Remove operation: A resource name for the removed feed item set link is
         * expected, in this format:
         *
         * `customers/{customer_id}/feedItemSetLinks/{feed_id}_{feed_item_set_id}_{feed_item_id}`
         *
         * @generated from protobuf field: string remove = 2;
         */
        remove: string;
    } | {
        oneofKind: undefined;
    };
}
/**
 * Response message for a feed item set link mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateFeedItemSetLinksResponse
 */
export interface MutateFeedItemSetLinksResponse {
    /**
     * All results for the mutate.
     *
     * @generated from protobuf field: repeated google.ads.googleads.v11.services.MutateFeedItemSetLinkResult results = 1;
     */
    results: MutateFeedItemSetLinkResult[];
    /**
     * 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 = 2;
     */
    partialFailureError?: Status;
}
/**
 * The result for the feed item set link mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateFeedItemSetLinkResult
 */
export interface MutateFeedItemSetLinkResult {
    /**
     * Returned for successful operations.
     *
     * @generated from protobuf field: string resource_name = 1;
     */
    resourceName: string;
}
declare class MutateFeedItemSetLinksRequest$Type extends MessageType<MutateFeedItemSetLinksRequest> {
    constructor();
    create(value?: PartialMessage<MutateFeedItemSetLinksRequest>): MutateFeedItemSetLinksRequest;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateFeedItemSetLinksRequest): MutateFeedItemSetLinksRequest;
    internalBinaryWrite(message: MutateFeedItemSetLinksRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateFeedItemSetLinksRequest
 */
export declare const MutateFeedItemSetLinksRequest: MutateFeedItemSetLinksRequest$Type;
declare class FeedItemSetLinkOperation$Type extends MessageType<FeedItemSetLinkOperation> {
    constructor();
    create(value?: PartialMessage<FeedItemSetLinkOperation>): FeedItemSetLinkOperation;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: FeedItemSetLinkOperation): FeedItemSetLinkOperation;
    internalBinaryWrite(message: FeedItemSetLinkOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.FeedItemSetLinkOperation
 */
export declare const FeedItemSetLinkOperation: FeedItemSetLinkOperation$Type;
declare class MutateFeedItemSetLinksResponse$Type extends MessageType<MutateFeedItemSetLinksResponse> {
    constructor();
    create(value?: PartialMessage<MutateFeedItemSetLinksResponse>): MutateFeedItemSetLinksResponse;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateFeedItemSetLinksResponse): MutateFeedItemSetLinksResponse;
    internalBinaryWrite(message: MutateFeedItemSetLinksResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateFeedItemSetLinksResponse
 */
export declare const MutateFeedItemSetLinksResponse: MutateFeedItemSetLinksResponse$Type;
declare class MutateFeedItemSetLinkResult$Type extends MessageType<MutateFeedItemSetLinkResult> {
    constructor();
    create(value?: PartialMessage<MutateFeedItemSetLinkResult>): MutateFeedItemSetLinkResult;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateFeedItemSetLinkResult): MutateFeedItemSetLinkResult;
    internalBinaryWrite(message: MutateFeedItemSetLinkResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateFeedItemSetLinkResult
 */
export declare const MutateFeedItemSetLinkResult: MutateFeedItemSetLinkResult$Type;
/**
 * @generated ServiceType for protobuf service google.ads.googleads.v11.services.FeedItemSetLinkService
 */
export declare const FeedItemSetLinkService: ServiceType;
export {};