google-ads-api-client
Version:
A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.
181 lines (180 loc) • 8.54 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 { CustomizerAttribute } from "../resources/customizer_attribute";
import { FieldMask } from "../../google/protobuf/field_mask";
import { ResponseContentTypeEnum_ResponseContentType } from "../enums/response_content_type";
/**
* Request message for
* [CustomizerAttributeService.MutateCustomizerAttributes][google.ads.googleads.v11.services.CustomizerAttributeService.MutateCustomizerAttributes].
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateCustomizerAttributesRequest
*/
export interface MutateCustomizerAttributesRequest {
/**
* Required. The ID of the customer whose customizer attributes are being modified.
*
* @generated from protobuf field: string customer_id = 1;
*/
customerId: string;
/**
* Required. The list of operations to perform on individual customizer attributes.
*
* @generated from protobuf field: repeated google.ads.googleads.v11.services.CustomizerAttributeOperation operations = 2;
*/
operations: CustomizerAttributeOperation[];
/**
* 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.CustomizerAttributeOperation
*/
export interface CustomizerAttributeOperation {
/**
* 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 customizer
* attribute
*
* @generated from protobuf field: google.ads.googleads.v11.resources.CustomizerAttribute create = 1;
*/
create: CustomizerAttribute;
} | {
oneofKind: "remove";
/**
* Remove operation: A resource name for the removed customizer attribute is
* expected, in this format:
* `customers/{customer_id}/customizerAttributes/{customizer_attribute_id}`
*
* @generated from protobuf field: string remove = 2;
*/
remove: string;
} | {
oneofKind: undefined;
};
}
/**
* Response message for an customizer attribute mutate.
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateCustomizerAttributesResponse
*/
export interface MutateCustomizerAttributesResponse {
/**
* All results for the mutate.
*
* @generated from protobuf field: repeated google.ads.googleads.v11.services.MutateCustomizerAttributeResult results = 1;
*/
results: MutateCustomizerAttributeResult[];
/**
* 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 customizer attribute mutate.
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateCustomizerAttributeResult
*/
export interface MutateCustomizerAttributeResult {
/**
* Returned for successful operations.
*
* @generated from protobuf field: string resource_name = 1;
*/
resourceName: string;
/**
* The mutated CustomizerAttribute 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.CustomizerAttribute customizer_attribute = 2;
*/
customizerAttribute?: CustomizerAttribute;
}
declare class MutateCustomizerAttributesRequest$Type extends MessageType<MutateCustomizerAttributesRequest> {
constructor();
create(value?: PartialMessage<MutateCustomizerAttributesRequest>): MutateCustomizerAttributesRequest;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCustomizerAttributesRequest): MutateCustomizerAttributesRequest;
internalBinaryWrite(message: MutateCustomizerAttributesRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCustomizerAttributesRequest
*/
export declare const MutateCustomizerAttributesRequest: MutateCustomizerAttributesRequest$Type;
declare class CustomizerAttributeOperation$Type extends MessageType<CustomizerAttributeOperation> {
constructor();
create(value?: PartialMessage<CustomizerAttributeOperation>): CustomizerAttributeOperation;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: CustomizerAttributeOperation): CustomizerAttributeOperation;
internalBinaryWrite(message: CustomizerAttributeOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.CustomizerAttributeOperation
*/
export declare const CustomizerAttributeOperation: CustomizerAttributeOperation$Type;
declare class MutateCustomizerAttributesResponse$Type extends MessageType<MutateCustomizerAttributesResponse> {
constructor();
create(value?: PartialMessage<MutateCustomizerAttributesResponse>): MutateCustomizerAttributesResponse;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCustomizerAttributesResponse): MutateCustomizerAttributesResponse;
internalBinaryWrite(message: MutateCustomizerAttributesResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCustomizerAttributesResponse
*/
export declare const MutateCustomizerAttributesResponse: MutateCustomizerAttributesResponse$Type;
declare class MutateCustomizerAttributeResult$Type extends MessageType<MutateCustomizerAttributeResult> {
constructor();
create(value?: PartialMessage<MutateCustomizerAttributeResult>): MutateCustomizerAttributeResult;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCustomizerAttributeResult): MutateCustomizerAttributeResult;
internalBinaryWrite(message: MutateCustomizerAttributeResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCustomizerAttributeResult
*/
export declare const MutateCustomizerAttributeResult: MutateCustomizerAttributeResult$Type;
/**
* @generated ServiceType for protobuf service google.ads.googleads.v11.services.CustomizerAttributeService
*/
export declare const CustomizerAttributeService: ServiceType;
export {};