google-ads-api-client
Version:
A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.
292 lines (291 loc) • 13.4 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 { CampaignDraft } from "../resources/campaign_draft";
import { FieldMask } from "../../google/protobuf/field_mask";
import { ResponseContentTypeEnum_ResponseContentType } from "../enums/response_content_type";
/**
* Request message for [CampaignDraftService.MutateCampaignDrafts][google.ads.googleads.v11.services.CampaignDraftService.MutateCampaignDrafts].
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateCampaignDraftsRequest
*/
export interface MutateCampaignDraftsRequest {
/**
* Required. The ID of the customer whose campaign drafts are being modified.
*
* @generated from protobuf field: string customer_id = 1;
*/
customerId: string;
/**
* Required. The list of operations to perform on individual campaign drafts.
*
* @generated from protobuf field: repeated google.ads.googleads.v11.services.CampaignDraftOperation operations = 2;
*/
operations: CampaignDraftOperation[];
/**
* 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;
}
/**
* Request message for [CampaignDraftService.PromoteCampaignDraft][google.ads.googleads.v11.services.CampaignDraftService.PromoteCampaignDraft].
*
* @generated from protobuf message google.ads.googleads.v11.services.PromoteCampaignDraftRequest
*/
export interface PromoteCampaignDraftRequest {
/**
* Required. The resource name of the campaign draft to promote.
*
* @generated from protobuf field: string campaign_draft = 1;
*/
campaignDraft: string;
/**
* If true, the request is validated but no Long Running Operation is created.
* Only errors are returned.
*
* @generated from protobuf field: bool validate_only = 2;
*/
validateOnly: boolean;
}
/**
* A single operation (create, update, remove) on a campaign draft.
*
* @generated from protobuf message google.ads.googleads.v11.services.CampaignDraftOperation
*/
export interface CampaignDraftOperation {
/**
* 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 campaign
* draft.
*
* @generated from protobuf field: google.ads.googleads.v11.resources.CampaignDraft create = 1;
*/
create: CampaignDraft;
} | {
oneofKind: "update";
/**
* Update operation: The campaign draft is expected to have a valid
* resource name.
*
* @generated from protobuf field: google.ads.googleads.v11.resources.CampaignDraft update = 2;
*/
update: CampaignDraft;
} | {
oneofKind: "remove";
/**
* Remove operation: The campaign draft is expected to have a valid
* resource name, in this format:
*
* `customers/{customer_id}/campaignDrafts/{base_campaign_id}~{draft_id}`
*
* @generated from protobuf field: string remove = 3;
*/
remove: string;
} | {
oneofKind: undefined;
};
}
/**
* Response message for campaign draft mutate.
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateCampaignDraftsResponse
*/
export interface MutateCampaignDraftsResponse {
/**
* 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.MutateCampaignDraftResult results = 2;
*/
results: MutateCampaignDraftResult[];
}
/**
* The result for the campaign draft mutate.
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateCampaignDraftResult
*/
export interface MutateCampaignDraftResult {
/**
* Returned for successful operations.
*
* @generated from protobuf field: string resource_name = 1;
*/
resourceName: string;
/**
* The mutated campaign draft 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.CampaignDraft campaign_draft = 2;
*/
campaignDraft?: CampaignDraft;
}
/**
* Request message for [CampaignDraftService.ListCampaignDraftAsyncErrors][google.ads.googleads.v11.services.CampaignDraftService.ListCampaignDraftAsyncErrors].
*
* @generated from protobuf message google.ads.googleads.v11.services.ListCampaignDraftAsyncErrorsRequest
*/
export interface ListCampaignDraftAsyncErrorsRequest {
/**
* Required. The name of the campaign draft from which to retrieve the async errors.
*
* @generated from protobuf field: string resource_name = 1;
*/
resourceName: string;
/**
* Token of the page to retrieve. If not specified, the first
* page of results will be returned. Use the value obtained from
* `next_page_token` in the previous response in order to request
* the next page of results.
*
* @generated from protobuf field: string page_token = 2;
*/
pageToken: string;
/**
* Number of elements to retrieve in a single page.
* When a page request is too large, the server may decide to
* further limit the number of returned resources.
*
* @generated from protobuf field: int32 page_size = 3;
*/
pageSize: number;
}
/**
* Response message for [CampaignDraftService.ListCampaignDraftAsyncErrors][google.ads.googleads.v11.services.CampaignDraftService.ListCampaignDraftAsyncErrors].
*
* @generated from protobuf message google.ads.googleads.v11.services.ListCampaignDraftAsyncErrorsResponse
*/
export interface ListCampaignDraftAsyncErrorsResponse {
/**
* Details of the errors when performing the asynchronous operation.
*
* @generated from protobuf field: repeated google.rpc.Status errors = 1;
*/
errors: Status[];
/**
* Pagination token used to retrieve the next page of results.
* Pass the content of this string as the `page_token` attribute of
* the next request. `next_page_token` is not returned for the last
* page.
*
* @generated from protobuf field: string next_page_token = 2;
*/
nextPageToken: string;
}
declare class MutateCampaignDraftsRequest$Type extends MessageType<MutateCampaignDraftsRequest> {
constructor();
create(value?: PartialMessage<MutateCampaignDraftsRequest>): MutateCampaignDraftsRequest;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCampaignDraftsRequest): MutateCampaignDraftsRequest;
internalBinaryWrite(message: MutateCampaignDraftsRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCampaignDraftsRequest
*/
export declare const MutateCampaignDraftsRequest: MutateCampaignDraftsRequest$Type;
declare class PromoteCampaignDraftRequest$Type extends MessageType<PromoteCampaignDraftRequest> {
constructor();
create(value?: PartialMessage<PromoteCampaignDraftRequest>): PromoteCampaignDraftRequest;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: PromoteCampaignDraftRequest): PromoteCampaignDraftRequest;
internalBinaryWrite(message: PromoteCampaignDraftRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.PromoteCampaignDraftRequest
*/
export declare const PromoteCampaignDraftRequest: PromoteCampaignDraftRequest$Type;
declare class CampaignDraftOperation$Type extends MessageType<CampaignDraftOperation> {
constructor();
create(value?: PartialMessage<CampaignDraftOperation>): CampaignDraftOperation;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: CampaignDraftOperation): CampaignDraftOperation;
internalBinaryWrite(message: CampaignDraftOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.CampaignDraftOperation
*/
export declare const CampaignDraftOperation: CampaignDraftOperation$Type;
declare class MutateCampaignDraftsResponse$Type extends MessageType<MutateCampaignDraftsResponse> {
constructor();
create(value?: PartialMessage<MutateCampaignDraftsResponse>): MutateCampaignDraftsResponse;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCampaignDraftsResponse): MutateCampaignDraftsResponse;
internalBinaryWrite(message: MutateCampaignDraftsResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCampaignDraftsResponse
*/
export declare const MutateCampaignDraftsResponse: MutateCampaignDraftsResponse$Type;
declare class MutateCampaignDraftResult$Type extends MessageType<MutateCampaignDraftResult> {
constructor();
create(value?: PartialMessage<MutateCampaignDraftResult>): MutateCampaignDraftResult;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCampaignDraftResult): MutateCampaignDraftResult;
internalBinaryWrite(message: MutateCampaignDraftResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCampaignDraftResult
*/
export declare const MutateCampaignDraftResult: MutateCampaignDraftResult$Type;
declare class ListCampaignDraftAsyncErrorsRequest$Type extends MessageType<ListCampaignDraftAsyncErrorsRequest> {
constructor();
create(value?: PartialMessage<ListCampaignDraftAsyncErrorsRequest>): ListCampaignDraftAsyncErrorsRequest;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: ListCampaignDraftAsyncErrorsRequest): ListCampaignDraftAsyncErrorsRequest;
internalBinaryWrite(message: ListCampaignDraftAsyncErrorsRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.ListCampaignDraftAsyncErrorsRequest
*/
export declare const ListCampaignDraftAsyncErrorsRequest: ListCampaignDraftAsyncErrorsRequest$Type;
declare class ListCampaignDraftAsyncErrorsResponse$Type extends MessageType<ListCampaignDraftAsyncErrorsResponse> {
constructor();
create(value?: PartialMessage<ListCampaignDraftAsyncErrorsResponse>): ListCampaignDraftAsyncErrorsResponse;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: ListCampaignDraftAsyncErrorsResponse): ListCampaignDraftAsyncErrorsResponse;
internalBinaryWrite(message: ListCampaignDraftAsyncErrorsResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.ListCampaignDraftAsyncErrorsResponse
*/
export declare const ListCampaignDraftAsyncErrorsResponse: ListCampaignDraftAsyncErrorsResponse$Type;
/**
* @generated ServiceType for protobuf service google.ads.googleads.v11.services.CampaignDraftService
*/
export declare const CampaignDraftService: ServiceType;
export {};