google-ads-api-client/dist/protos/bindings/ads/services/feed_item_set_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 { FeedItemSet } from "../resources/feed_item_set";
import { FieldMask } from "../../google/protobuf/field_mask";
/**
 * Request message for [FeedItemSetService.MutateFeedItemSets][google.ads.googleads.v11.services.FeedItemSetService.MutateFeedItemSets].
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateFeedItemSetsRequest
 */
export interface MutateFeedItemSetsRequest {
    /**
     * Required. The ID of the customer whose feed item sets are being modified.
     *
     * @generated from protobuf field: string customer_id = 1;
     */
    customerId: string;
    /**
     * Required. The list of operations to perform on individual feed item sets.
     *
     * @generated from protobuf field: repeated google.ads.googleads.v11.services.FeedItemSetOperation operations = 2;
     */
    operations: FeedItemSetOperation[];
    /**
     * 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, remove) on an feed item set.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.FeedItemSetOperation
 */
export interface FeedItemSetOperation {
    /**
     * 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 feed item set
         *
         * @generated from protobuf field: google.ads.googleads.v11.resources.FeedItemSet create = 1;
         */
        create: FeedItemSet;
    } | {
        oneofKind: "update";
        /**
         * Update operation: The feed item set is expected to have a valid resource
         * name.
         *
         * @generated from protobuf field: google.ads.googleads.v11.resources.FeedItemSet update = 2;
         */
        update: FeedItemSet;
    } | {
        oneofKind: "remove";
        /**
         * Remove operation: A resource name for the removed feed item is
         * expected, in this format:
         * `customers/{customer_id}/feedItems/{feed_id}~{feed_item_set_id}`
         *
         * @generated from protobuf field: string remove = 3;
         */
        remove: string;
    } | {
        oneofKind: undefined;
    };
}
/**
 * Response message for an feed item set mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateFeedItemSetsResponse
 */
export interface MutateFeedItemSetsResponse {
    /**
     * All results for the mutate.
     *
     * @generated from protobuf field: repeated google.ads.googleads.v11.services.MutateFeedItemSetResult results = 1;
     */
    results: MutateFeedItemSetResult[];
    /**
     * 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 mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateFeedItemSetResult
 */
export interface MutateFeedItemSetResult {
    /**
     * Returned for successful operations.
     *
     * @generated from protobuf field: string resource_name = 1;
     */
    resourceName: string;
}
declare class MutateFeedItemSetsRequest$Type extends MessageType<MutateFeedItemSetsRequest> {
    constructor();
    create(value?: PartialMessage<MutateFeedItemSetsRequest>): MutateFeedItemSetsRequest;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateFeedItemSetsRequest): MutateFeedItemSetsRequest;
    internalBinaryWrite(message: MutateFeedItemSetsRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateFeedItemSetsRequest
 */
export declare const MutateFeedItemSetsRequest: MutateFeedItemSetsRequest$Type;
declare class FeedItemSetOperation$Type extends MessageType<FeedItemSetOperation> {
    constructor();
    create(value?: PartialMessage<FeedItemSetOperation>): FeedItemSetOperation;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: FeedItemSetOperation): FeedItemSetOperation;
    internalBinaryWrite(message: FeedItemSetOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.FeedItemSetOperation
 */
export declare const FeedItemSetOperation: FeedItemSetOperation$Type;
declare class MutateFeedItemSetsResponse$Type extends MessageType<MutateFeedItemSetsResponse> {
    constructor();
    create(value?: PartialMessage<MutateFeedItemSetsResponse>): MutateFeedItemSetsResponse;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateFeedItemSetsResponse): MutateFeedItemSetsResponse;
    internalBinaryWrite(message: MutateFeedItemSetsResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateFeedItemSetsResponse
 */
export declare const MutateFeedItemSetsResponse: MutateFeedItemSetsResponse$Type;
declare class MutateFeedItemSetResult$Type extends MessageType<MutateFeedItemSetResult> {
    constructor();
    create(value?: PartialMessage<MutateFeedItemSetResult>): MutateFeedItemSetResult;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateFeedItemSetResult): MutateFeedItemSetResult;
    internalBinaryWrite(message: MutateFeedItemSetResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateFeedItemSetResult
 */
export declare const MutateFeedItemSetResult: MutateFeedItemSetResult$Type;
/**
 * @generated ServiceType for protobuf service google.ads.googleads.v11.services.FeedItemSetService
 */
export declare const FeedItemSetService: ServiceType;
export {};