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