google-ads-api-client
Version:
A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.
144 lines (143 loc) • 6.46 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 { CustomInterest } from "../resources/custom_interest";
import { FieldMask } from "../../google/protobuf/field_mask";
/**
* Request message for [CustomInterestService.MutateCustomInterests][google.ads.googleads.v11.services.CustomInterestService.MutateCustomInterests].
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateCustomInterestsRequest
*/
export interface MutateCustomInterestsRequest {
/**
* Required. The ID of the customer whose custom interests are being modified.
*
* @generated from protobuf field: string customer_id = 1;
*/
customerId: string;
/**
* Required. The list of operations to perform on individual custom interests.
*
* @generated from protobuf field: repeated google.ads.googleads.v11.services.CustomInterestOperation operations = 2;
*/
operations: CustomInterestOperation[];
/**
* 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, update) on a custom interest.
*
* @generated from protobuf message google.ads.googleads.v11.services.CustomInterestOperation
*/
export interface CustomInterestOperation {
/**
* 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 custom
* interest.
*
* @generated from protobuf field: google.ads.googleads.v11.resources.CustomInterest create = 1;
*/
create: CustomInterest;
} | {
oneofKind: "update";
/**
* Update operation: The custom interest is expected to have a valid
* resource name.
*
* @generated from protobuf field: google.ads.googleads.v11.resources.CustomInterest update = 2;
*/
update: CustomInterest;
} | {
oneofKind: undefined;
};
}
/**
* Response message for custom interest mutate.
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateCustomInterestsResponse
*/
export interface MutateCustomInterestsResponse {
/**
* All results for the mutate.
*
* @generated from protobuf field: repeated google.ads.googleads.v11.services.MutateCustomInterestResult results = 2;
*/
results: MutateCustomInterestResult[];
}
/**
* The result for the custom interest mutate.
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateCustomInterestResult
*/
export interface MutateCustomInterestResult {
/**
* Returned for successful operations.
*
* @generated from protobuf field: string resource_name = 1;
*/
resourceName: string;
}
declare class MutateCustomInterestsRequest$Type extends MessageType<MutateCustomInterestsRequest> {
constructor();
create(value?: PartialMessage<MutateCustomInterestsRequest>): MutateCustomInterestsRequest;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCustomInterestsRequest): MutateCustomInterestsRequest;
internalBinaryWrite(message: MutateCustomInterestsRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCustomInterestsRequest
*/
export declare const MutateCustomInterestsRequest: MutateCustomInterestsRequest$Type;
declare class CustomInterestOperation$Type extends MessageType<CustomInterestOperation> {
constructor();
create(value?: PartialMessage<CustomInterestOperation>): CustomInterestOperation;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: CustomInterestOperation): CustomInterestOperation;
internalBinaryWrite(message: CustomInterestOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.CustomInterestOperation
*/
export declare const CustomInterestOperation: CustomInterestOperation$Type;
declare class MutateCustomInterestsResponse$Type extends MessageType<MutateCustomInterestsResponse> {
constructor();
create(value?: PartialMessage<MutateCustomInterestsResponse>): MutateCustomInterestsResponse;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCustomInterestsResponse): MutateCustomInterestsResponse;
internalBinaryWrite(message: MutateCustomInterestsResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCustomInterestsResponse
*/
export declare const MutateCustomInterestsResponse: MutateCustomInterestsResponse$Type;
declare class MutateCustomInterestResult$Type extends MessageType<MutateCustomInterestResult> {
constructor();
create(value?: PartialMessage<MutateCustomInterestResult>): MutateCustomInterestResult;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCustomInterestResult): MutateCustomInterestResult;
internalBinaryWrite(message: MutateCustomInterestResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCustomInterestResult
*/
export declare const MutateCustomInterestResult: MutateCustomInterestResult$Type;
/**
* @generated ServiceType for protobuf service google.ads.googleads.v11.services.CustomInterestService
*/
export declare const CustomInterestService: ServiceType;
export {};