google-ads-api-client
Version:
A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.
158 lines (157 loc) • 7.03 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 { CustomerLabel } from "../resources/customer_label";
/**
* Request message for [CustomerLabelService.MutateCustomerLabels][google.ads.googleads.v11.services.CustomerLabelService.MutateCustomerLabels].
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateCustomerLabelsRequest
*/
export interface MutateCustomerLabelsRequest {
/**
* Required. ID of the customer whose customer-label relationships are being modified.
*
* @generated from protobuf field: string customer_id = 1;
*/
customerId: string;
/**
* Required. The list of operations to perform on customer-label relationships.
*
* @generated from protobuf field: repeated google.ads.googleads.v11.services.CustomerLabelOperation operations = 2;
*/
operations: CustomerLabelOperation[];
/**
* 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;
}
/**
* A single operation (create, remove) on a customer-label relationship.
*
* @generated from protobuf message google.ads.googleads.v11.services.CustomerLabelOperation
*/
export interface CustomerLabelOperation {
/**
* @generated from protobuf oneof: operation
*/
operation: {
oneofKind: "create";
/**
* Create operation: No resource name is expected for the new customer-label
* relationship.
*
* @generated from protobuf field: google.ads.googleads.v11.resources.CustomerLabel create = 1;
*/
create: CustomerLabel;
} | {
oneofKind: "remove";
/**
* Remove operation: A resource name for the customer-label relationship
* being removed, in this format:
*
* `customers/{customer_id}/customerLabels/{label_id}`
*
* @generated from protobuf field: string remove = 2;
*/
remove: string;
} | {
oneofKind: undefined;
};
}
/**
* Response message for a customer labels mutate.
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateCustomerLabelsResponse
*/
export interface MutateCustomerLabelsResponse {
/**
* 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.MutateCustomerLabelResult results = 2;
*/
results: MutateCustomerLabelResult[];
}
/**
* The result for a customer label mutate.
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateCustomerLabelResult
*/
export interface MutateCustomerLabelResult {
/**
* Returned for successful operations.
*
* @generated from protobuf field: string resource_name = 1;
*/
resourceName: string;
}
declare class MutateCustomerLabelsRequest$Type extends MessageType<MutateCustomerLabelsRequest> {
constructor();
create(value?: PartialMessage<MutateCustomerLabelsRequest>): MutateCustomerLabelsRequest;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCustomerLabelsRequest): MutateCustomerLabelsRequest;
internalBinaryWrite(message: MutateCustomerLabelsRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCustomerLabelsRequest
*/
export declare const MutateCustomerLabelsRequest: MutateCustomerLabelsRequest$Type;
declare class CustomerLabelOperation$Type extends MessageType<CustomerLabelOperation> {
constructor();
create(value?: PartialMessage<CustomerLabelOperation>): CustomerLabelOperation;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: CustomerLabelOperation): CustomerLabelOperation;
internalBinaryWrite(message: CustomerLabelOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.CustomerLabelOperation
*/
export declare const CustomerLabelOperation: CustomerLabelOperation$Type;
declare class MutateCustomerLabelsResponse$Type extends MessageType<MutateCustomerLabelsResponse> {
constructor();
create(value?: PartialMessage<MutateCustomerLabelsResponse>): MutateCustomerLabelsResponse;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCustomerLabelsResponse): MutateCustomerLabelsResponse;
internalBinaryWrite(message: MutateCustomerLabelsResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCustomerLabelsResponse
*/
export declare const MutateCustomerLabelsResponse: MutateCustomerLabelsResponse$Type;
declare class MutateCustomerLabelResult$Type extends MessageType<MutateCustomerLabelResult> {
constructor();
create(value?: PartialMessage<MutateCustomerLabelResult>): MutateCustomerLabelResult;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCustomerLabelResult): MutateCustomerLabelResult;
internalBinaryWrite(message: MutateCustomerLabelResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCustomerLabelResult
*/
export declare const MutateCustomerLabelResult: MutateCustomerLabelResult$Type;
/**
* @generated ServiceType for protobuf service google.ads.googleads.v11.services.CustomerLabelService
*/
export declare const CustomerLabelService: ServiceType;
export {};