google-ads-api-client/dist/protos/bindings/ads/services/feed_item_target_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 { FeedItemTarget } from "../resources/feed_item_target";
import { ResponseContentTypeEnum_ResponseContentType } from "../enums/response_content_type";
/**
 * Request message for [FeedItemTargetService.MutateFeedItemTargets][google.ads.googleads.v11.services.FeedItemTargetService.MutateFeedItemTargets].
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateFeedItemTargetsRequest
 */
export interface MutateFeedItemTargetsRequest {
    /**
     * Required. The ID of the customer whose feed item targets are being modified.
     *
     * @generated from protobuf field: string customer_id = 1;
     */
    customerId: string;
    /**
     * Required. The list of operations to perform on individual feed item targets.
     *
     * @generated from protobuf field: repeated google.ads.googleads.v11.services.FeedItemTargetOperation operations = 2;
     */
    operations: FeedItemTargetOperation[];
    /**
     * 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 = 4;
     */
    partialFailure: boolean;
    /**
     * The response content type setting. Determines whether the mutable resource
     * or just the resource name should be returned post mutation.
     *
     * @generated from protobuf field: google.ads.googleads.v11.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
     */
    responseContentType: ResponseContentTypeEnum_ResponseContentType;
    /**
     * 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, remove) on an feed item target.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.FeedItemTargetOperation
 */
export interface FeedItemTargetOperation {
    /**
     * @generated from protobuf oneof: operation
     */
    operation: {
        oneofKind: "create";
        /**
         * Create operation: No resource name is expected for the new feed item
         * target.
         *
         * @generated from protobuf field: google.ads.googleads.v11.resources.FeedItemTarget create = 1;
         */
        create: FeedItemTarget;
    } | {
        oneofKind: "remove";
        /**
         * Remove operation: A resource name for the removed feed item target is
         * expected, in this format:
         *
         * `customers/{customer_id}/feedItemTargets/{feed_id}~{feed_item_id}~{feed_item_target_type}~{feed_item_target_id}`
         *
         * @generated from protobuf field: string remove = 2;
         */
        remove: string;
    } | {
        oneofKind: undefined;
    };
}
/**
 * Response message for an feed item target mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateFeedItemTargetsResponse
 */
export interface MutateFeedItemTargetsResponse {
    /**
     * 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.MutateFeedItemTargetResult results = 2;
     */
    results: MutateFeedItemTargetResult[];
}
/**
 * The result for the feed item target mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateFeedItemTargetResult
 */
export interface MutateFeedItemTargetResult {
    /**
     * Returned for successful operations.
     *
     * @generated from protobuf field: string resource_name = 1;
     */
    resourceName: string;
    /**
     * The mutated feed item target with only mutable fields after mutate. The
     * field will only be returned when response_content_type is set to
     * "MUTABLE_RESOURCE".
     *
     * @generated from protobuf field: google.ads.googleads.v11.resources.FeedItemTarget feed_item_target = 2;
     */
    feedItemTarget?: FeedItemTarget;
}
declare class MutateFeedItemTargetsRequest$Type extends MessageType<MutateFeedItemTargetsRequest> {
    constructor();
    create(value?: PartialMessage<MutateFeedItemTargetsRequest>): MutateFeedItemTargetsRequest;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateFeedItemTargetsRequest): MutateFeedItemTargetsRequest;
    internalBinaryWrite(message: MutateFeedItemTargetsRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateFeedItemTargetsRequest
 */
export declare const MutateFeedItemTargetsRequest: MutateFeedItemTargetsRequest$Type;
declare class FeedItemTargetOperation$Type extends MessageType<FeedItemTargetOperation> {
    constructor();
    create(value?: PartialMessage<FeedItemTargetOperation>): FeedItemTargetOperation;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: FeedItemTargetOperation): FeedItemTargetOperation;
    internalBinaryWrite(message: FeedItemTargetOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.FeedItemTargetOperation
 */
export declare const FeedItemTargetOperation: FeedItemTargetOperation$Type;
declare class MutateFeedItemTargetsResponse$Type extends MessageType<MutateFeedItemTargetsResponse> {
    constructor();
    create(value?: PartialMessage<MutateFeedItemTargetsResponse>): MutateFeedItemTargetsResponse;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateFeedItemTargetsResponse): MutateFeedItemTargetsResponse;
    internalBinaryWrite(message: MutateFeedItemTargetsResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateFeedItemTargetsResponse
 */
export declare const MutateFeedItemTargetsResponse: MutateFeedItemTargetsResponse$Type;
declare class MutateFeedItemTargetResult$Type extends MessageType<MutateFeedItemTargetResult> {
    constructor();
    create(value?: PartialMessage<MutateFeedItemTargetResult>): MutateFeedItemTargetResult;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateFeedItemTargetResult): MutateFeedItemTargetResult;
    internalBinaryWrite(message: MutateFeedItemTargetResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateFeedItemTargetResult
 */
export declare const MutateFeedItemTargetResult: MutateFeedItemTargetResult$Type;
/**
 * @generated ServiceType for protobuf service google.ads.googleads.v11.services.FeedItemTargetService
 */
export declare const FeedItemTargetService: ServiceType;
export {};