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) • 7.67 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 { Feed } from "../resources/feed";
import { FieldMask } from "../../google/protobuf/field_mask";
import { ResponseContentTypeEnum_ResponseContentType } from "../enums/response_content_type";
/**
* Request message for [FeedService.MutateFeeds][google.ads.googleads.v11.services.FeedService.MutateFeeds].
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateFeedsRequest
*/
export interface MutateFeedsRequest {
/**
* Required. The ID of the customer whose feeds are being modified.
*
* @generated from protobuf field: string customer_id = 1;
*/
customerId: string;
/**
* Required. The list of operations to perform on individual feeds.
*
* @generated from protobuf field: repeated google.ads.googleads.v11.services.FeedOperation operations = 2;
*/
operations: FeedOperation[];
/**
* 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.
*
* @generated from protobuf message google.ads.googleads.v11.services.FeedOperation
*/
export interface FeedOperation {
/**
* 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.
*
* @generated from protobuf field: google.ads.googleads.v11.resources.Feed create = 1;
*/
create: Feed;
} | {
oneofKind: "update";
/**
* Update operation: The feed is expected to have a valid resource
* name.
*
* @generated from protobuf field: google.ads.googleads.v11.resources.Feed update = 2;
*/
update: Feed;
} | {
oneofKind: "remove";
/**
* Remove operation: A resource name for the removed feed is
* expected, in this format:
*
* `customers/{customer_id}/feeds/{feed_id}`
*
* @generated from protobuf field: string remove = 3;
*/
remove: string;
} | {
oneofKind: undefined;
};
}
/**
* Response message for an feed mutate.
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateFeedsResponse
*/
export interface MutateFeedsResponse {
/**
* 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.MutateFeedResult results = 2;
*/
results: MutateFeedResult[];
}
/**
* The result for the feed mutate.
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateFeedResult
*/
export interface MutateFeedResult {
/**
* Returned for successful operations.
*
* @generated from protobuf field: string resource_name = 1;
*/
resourceName: string;
/**
* The mutated feed 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.Feed feed = 2;
*/
feed?: Feed;
}
declare class MutateFeedsRequest$Type extends MessageType<MutateFeedsRequest> {
constructor();
create(value?: PartialMessage<MutateFeedsRequest>): MutateFeedsRequest;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateFeedsRequest): MutateFeedsRequest;
internalBinaryWrite(message: MutateFeedsRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateFeedsRequest
*/
export declare const MutateFeedsRequest: MutateFeedsRequest$Type;
declare class FeedOperation$Type extends MessageType<FeedOperation> {
constructor();
create(value?: PartialMessage<FeedOperation>): FeedOperation;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: FeedOperation): FeedOperation;
internalBinaryWrite(message: FeedOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.FeedOperation
*/
export declare const FeedOperation: FeedOperation$Type;
declare class MutateFeedsResponse$Type extends MessageType<MutateFeedsResponse> {
constructor();
create(value?: PartialMessage<MutateFeedsResponse>): MutateFeedsResponse;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateFeedsResponse): MutateFeedsResponse;
internalBinaryWrite(message: MutateFeedsResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateFeedsResponse
*/
export declare const MutateFeedsResponse: MutateFeedsResponse$Type;
declare class MutateFeedResult$Type extends MessageType<MutateFeedResult> {
constructor();
create(value?: PartialMessage<MutateFeedResult>): MutateFeedResult;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateFeedResult): MutateFeedResult;
internalBinaryWrite(message: MutateFeedResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateFeedResult
*/
export declare const MutateFeedResult: MutateFeedResult$Type;
/**
* @generated ServiceType for protobuf service google.ads.googleads.v11.services.FeedService
*/
export declare const FeedService: ServiceType;
export {};