google-ads-api-client
Version:
A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.
188 lines (187 loc) • 8.01 kB
TypeScript
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 { FeedItem } from "../resources/feed_item";
import { FieldMask } from "../../google/protobuf/field_mask";
import { ResponseContentTypeEnum_ResponseContentType } from "../enums/response_content_type";
/**
* Request message for [FeedItemService.MutateFeedItems][google.ads.googleads.v11.services.FeedItemService.MutateFeedItems].
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateFeedItemsRequest
*/
export interface MutateFeedItemsRequest {
/**
* Required. The ID of the customer whose feed items are being modified.
*
* @generated from protobuf field: string customer_id = 1;
*/
customerId: string;
/**
* Required. The list of operations to perform on individual feed items.
*
* @generated from protobuf field: repeated google.ads.googleads.v11.services.FeedItemOperation operations = 2;
*/
operations: FeedItemOperation[];
/**
* 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;
/**
* 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;
}
/**
* A single operation (create, update, remove) on an feed item.
*
* @generated from protobuf message google.ads.googleads.v11.services.FeedItemOperation
*/
export interface FeedItemOperation {
/**
* 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.
*
* @generated from protobuf field: google.ads.googleads.v11.resources.FeedItem create = 1;
*/
create: FeedItem;
} | {
oneofKind: "update";
/**
* Update operation: The feed item is expected to have a valid resource
* name.
*
* @generated from protobuf field: google.ads.googleads.v11.resources.FeedItem update = 2;
*/
update: FeedItem;
} | {
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_id}`
*
* @generated from protobuf field: string remove = 3;
*/
remove: string;
} | {
oneofKind: undefined;
};
}
/**
* Response message for an feed item mutate.
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateFeedItemsResponse
*/
export interface MutateFeedItemsResponse {
/**
* 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.MutateFeedItemResult results = 2;
*/
results: MutateFeedItemResult[];
}
/**
* The result for the feed item mutate.
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateFeedItemResult
*/
export interface MutateFeedItemResult {
/**
* Returned for successful operations.
*
* @generated from protobuf field: string resource_name = 1;
*/
resourceName: string;
/**
* The mutated feed item 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.FeedItem feed_item = 2;
*/
feedItem?: FeedItem;
}
declare class MutateFeedItemsRequest$Type extends MessageType<MutateFeedItemsRequest> {
constructor();
create(value?: PartialMessage<MutateFeedItemsRequest>): MutateFeedItemsRequest;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateFeedItemsRequest): MutateFeedItemsRequest;
internalBinaryWrite(message: MutateFeedItemsRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateFeedItemsRequest
*/
export declare const MutateFeedItemsRequest: MutateFeedItemsRequest$Type;
declare class FeedItemOperation$Type extends MessageType<FeedItemOperation> {
constructor();
create(value?: PartialMessage<FeedItemOperation>): FeedItemOperation;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: FeedItemOperation): FeedItemOperation;
internalBinaryWrite(message: FeedItemOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.FeedItemOperation
*/
export declare const FeedItemOperation: FeedItemOperation$Type;
declare class MutateFeedItemsResponse$Type extends MessageType<MutateFeedItemsResponse> {
constructor();
create(value?: PartialMessage<MutateFeedItemsResponse>): MutateFeedItemsResponse;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateFeedItemsResponse): MutateFeedItemsResponse;
internalBinaryWrite(message: MutateFeedItemsResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateFeedItemsResponse
*/
export declare const MutateFeedItemsResponse: MutateFeedItemsResponse$Type;
declare class MutateFeedItemResult$Type extends MessageType<MutateFeedItemResult> {
constructor();
create(value?: PartialMessage<MutateFeedItemResult>): MutateFeedItemResult;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateFeedItemResult): MutateFeedItemResult;
internalBinaryWrite(message: MutateFeedItemResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateFeedItemResult
*/
export declare const MutateFeedItemResult: MutateFeedItemResult$Type;
/**
* @generated ServiceType for protobuf service google.ads.googleads.v11.services.FeedItemService
*/
export declare const FeedItemService: ServiceType;
export {};