google-ads-api-client
Version:
A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.
136 lines (135 loc) • 6.69 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 { CustomerConversionGoal } from "../resources/customer_conversion_goal";
import { FieldMask } from "../../google/protobuf/field_mask";
/**
* Request message for
* [CustomerConversionGoalService.MutateCustomerConversionGoals][google.ads.googleads.v11.services.CustomerConversionGoalService.MutateCustomerConversionGoals].
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateCustomerConversionGoalsRequest
*/
export interface MutateCustomerConversionGoalsRequest {
/**
* Required. The ID of the customer whose customer conversion goals are being modified.
*
* @generated from protobuf field: string customer_id = 1;
*/
customerId: string;
/**
* Required. The list of operations to perform on individual customer conversion goal.
*
* @generated from protobuf field: repeated google.ads.googleads.v11.services.CustomerConversionGoalOperation operations = 2;
*/
operations: CustomerConversionGoalOperation[];
/**
* If true, the request is validated but not executed. Only errors are
* returned, not results.
*
* @generated from protobuf field: bool validate_only = 3;
*/
validateOnly: boolean;
}
/**
* A single operation (update) on a customer conversion goal.
*
* @generated from protobuf message google.ads.googleads.v11.services.CustomerConversionGoalOperation
*/
export interface CustomerConversionGoalOperation {
/**
* FieldMask that determines which resource fields are modified in an update.
*
* @generated from protobuf field: google.protobuf.FieldMask update_mask = 2;
*/
updateMask?: FieldMask;
/**
* @generated from protobuf oneof: operation
*/
operation: {
oneofKind: "update";
/**
* Update operation: The customer conversion goal is expected to have a
* valid resource name.
*
* @generated from protobuf field: google.ads.googleads.v11.resources.CustomerConversionGoal update = 1;
*/
update: CustomerConversionGoal;
} | {
oneofKind: undefined;
};
}
/**
* Response message for a customer conversion goal mutate.
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateCustomerConversionGoalsResponse
*/
export interface MutateCustomerConversionGoalsResponse {
/**
* All results for the mutate.
*
* @generated from protobuf field: repeated google.ads.googleads.v11.services.MutateCustomerConversionGoalResult results = 1;
*/
results: MutateCustomerConversionGoalResult[];
}
/**
* The result for the customer conversion goal mutate.
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateCustomerConversionGoalResult
*/
export interface MutateCustomerConversionGoalResult {
/**
* Returned for successful operations.
*
* @generated from protobuf field: string resource_name = 1;
*/
resourceName: string;
}
declare class MutateCustomerConversionGoalsRequest$Type extends MessageType<MutateCustomerConversionGoalsRequest> {
constructor();
create(value?: PartialMessage<MutateCustomerConversionGoalsRequest>): MutateCustomerConversionGoalsRequest;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCustomerConversionGoalsRequest): MutateCustomerConversionGoalsRequest;
internalBinaryWrite(message: MutateCustomerConversionGoalsRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCustomerConversionGoalsRequest
*/
export declare const MutateCustomerConversionGoalsRequest: MutateCustomerConversionGoalsRequest$Type;
declare class CustomerConversionGoalOperation$Type extends MessageType<CustomerConversionGoalOperation> {
constructor();
create(value?: PartialMessage<CustomerConversionGoalOperation>): CustomerConversionGoalOperation;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: CustomerConversionGoalOperation): CustomerConversionGoalOperation;
internalBinaryWrite(message: CustomerConversionGoalOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.CustomerConversionGoalOperation
*/
export declare const CustomerConversionGoalOperation: CustomerConversionGoalOperation$Type;
declare class MutateCustomerConversionGoalsResponse$Type extends MessageType<MutateCustomerConversionGoalsResponse> {
constructor();
create(value?: PartialMessage<MutateCustomerConversionGoalsResponse>): MutateCustomerConversionGoalsResponse;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCustomerConversionGoalsResponse): MutateCustomerConversionGoalsResponse;
internalBinaryWrite(message: MutateCustomerConversionGoalsResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCustomerConversionGoalsResponse
*/
export declare const MutateCustomerConversionGoalsResponse: MutateCustomerConversionGoalsResponse$Type;
declare class MutateCustomerConversionGoalResult$Type extends MessageType<MutateCustomerConversionGoalResult> {
constructor();
create(value?: PartialMessage<MutateCustomerConversionGoalResult>): MutateCustomerConversionGoalResult;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCustomerConversionGoalResult): MutateCustomerConversionGoalResult;
internalBinaryWrite(message: MutateCustomerConversionGoalResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCustomerConversionGoalResult
*/
export declare const MutateCustomerConversionGoalResult: MutateCustomerConversionGoalResult$Type;
/**
* @generated ServiceType for protobuf service google.ads.googleads.v11.services.CustomerConversionGoalService
*/
export declare const CustomerConversionGoalService: ServiceType;
export {};