google-ads-api-client
Version:
A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.
174 lines (173 loc) • 8.2 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 { CampaignCustomizer } from "../resources/campaign_customizer";
import { ResponseContentTypeEnum_ResponseContentType } from "../enums/response_content_type";
/**
* Request message for
* [CampaignCustomizerService.MutateCampaignCustomizers][google.ads.googleads.v11.services.CampaignCustomizerService.MutateCampaignCustomizers].
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateCampaignCustomizersRequest
*/
export interface MutateCampaignCustomizersRequest {
/**
* Required. The ID of the customer whose campaign customizers are being modified.
*
* @generated from protobuf field: string customer_id = 1;
*/
customerId: string;
/**
* Required. The list of operations to perform on individual campaign customizers.
*
* @generated from protobuf field: repeated google.ads.googleads.v11.services.CampaignCustomizerOperation operations = 2;
*/
operations: CampaignCustomizerOperation[];
/**
* 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, remove) on an customizer attribute.
*
* @generated from protobuf message google.ads.googleads.v11.services.CampaignCustomizerOperation
*/
export interface CampaignCustomizerOperation {
/**
* @generated from protobuf oneof: operation
*/
operation: {
oneofKind: "create";
/**
* Create operation: No resource name is expected for the new campaign
* customizer
*
* @generated from protobuf field: google.ads.googleads.v11.resources.CampaignCustomizer create = 1;
*/
create: CampaignCustomizer;
} | {
oneofKind: "remove";
/**
* Remove operation: A resource name for the removed campaign customizer is
* expected, in this format:
* `customers/{customer_id}/campaignCustomizers/{campaign_id}~{customizer_attribute_id}`
*
* @generated from protobuf field: string remove = 2;
*/
remove: string;
} | {
oneofKind: undefined;
};
}
/**
* Response message for an campaign customizer mutate.
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateCampaignCustomizersResponse
*/
export interface MutateCampaignCustomizersResponse {
/**
* All results for the mutate.
*
* @generated from protobuf field: repeated google.ads.googleads.v11.services.MutateCampaignCustomizerResult results = 1;
*/
results: MutateCampaignCustomizerResult[];
/**
* 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 campaign customizer mutate.
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateCampaignCustomizerResult
*/
export interface MutateCampaignCustomizerResult {
/**
* Returned for successful operations.
*
* @generated from protobuf field: string resource_name = 1;
*/
resourceName: string;
/**
* The mutated CampaignCustomizer 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.CampaignCustomizer campaign_customizer = 2;
*/
campaignCustomizer?: CampaignCustomizer;
}
declare class MutateCampaignCustomizersRequest$Type extends MessageType<MutateCampaignCustomizersRequest> {
constructor();
create(value?: PartialMessage<MutateCampaignCustomizersRequest>): MutateCampaignCustomizersRequest;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCampaignCustomizersRequest): MutateCampaignCustomizersRequest;
internalBinaryWrite(message: MutateCampaignCustomizersRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCampaignCustomizersRequest
*/
export declare const MutateCampaignCustomizersRequest: MutateCampaignCustomizersRequest$Type;
declare class CampaignCustomizerOperation$Type extends MessageType<CampaignCustomizerOperation> {
constructor();
create(value?: PartialMessage<CampaignCustomizerOperation>): CampaignCustomizerOperation;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: CampaignCustomizerOperation): CampaignCustomizerOperation;
internalBinaryWrite(message: CampaignCustomizerOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.CampaignCustomizerOperation
*/
export declare const CampaignCustomizerOperation: CampaignCustomizerOperation$Type;
declare class MutateCampaignCustomizersResponse$Type extends MessageType<MutateCampaignCustomizersResponse> {
constructor();
create(value?: PartialMessage<MutateCampaignCustomizersResponse>): MutateCampaignCustomizersResponse;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCampaignCustomizersResponse): MutateCampaignCustomizersResponse;
internalBinaryWrite(message: MutateCampaignCustomizersResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCampaignCustomizersResponse
*/
export declare const MutateCampaignCustomizersResponse: MutateCampaignCustomizersResponse$Type;
declare class MutateCampaignCustomizerResult$Type extends MessageType<MutateCampaignCustomizerResult> {
constructor();
create(value?: PartialMessage<MutateCampaignCustomizerResult>): MutateCampaignCustomizerResult;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCampaignCustomizerResult): MutateCampaignCustomizerResult;
internalBinaryWrite(message: MutateCampaignCustomizerResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCampaignCustomizerResult
*/
export declare const MutateCampaignCustomizerResult: MutateCampaignCustomizerResult$Type;
/**
* @generated ServiceType for protobuf service google.ads.googleads.v11.services.CampaignCustomizerService
*/
export declare const CampaignCustomizerService: ServiceType;
export {};