google-ads-api-client
Version:
A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.
219 lines (218 loc) • 9.53 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 { FieldMask } from "../../google/protobuf/field_mask";
import { AccountLink } from "../resources/account_link";
/**
* Request message for
* [AccountLinkService.CreateAccountLink][google.ads.googleads.v11.services.AccountLinkService.CreateAccountLink].
*
* @generated from protobuf message google.ads.googleads.v11.services.CreateAccountLinkRequest
*/
export interface CreateAccountLinkRequest {
/**
* Required. The ID of the customer for which the account link is created.
*
* @generated from protobuf field: string customer_id = 1;
*/
customerId: string;
/**
* Required. The account link to be created.
*
* @generated from protobuf field: google.ads.googleads.v11.resources.AccountLink account_link = 2;
*/
accountLink?: AccountLink;
}
/**
* Response message for
* [AccountLinkService.CreateAccountLink][google.ads.googleads.v11.services.AccountLinkService.CreateAccountLink].
*
* @generated from protobuf message google.ads.googleads.v11.services.CreateAccountLinkResponse
*/
export interface CreateAccountLinkResponse {
/**
* Returned for successful operations. Resource name of the account link.
*
* @generated from protobuf field: string resource_name = 1;
*/
resourceName: string;
}
/**
* Request message for [AccountLinkService.MutateAccountLink][google.ads.googleads.v11.services.AccountLinkService.MutateAccountLink].
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateAccountLinkRequest
*/
export interface MutateAccountLinkRequest {
/**
* Required. The ID of the customer being modified.
*
* @generated from protobuf field: string customer_id = 1;
*/
customerId: string;
/**
* Required. The operation to perform on the link.
*
* @generated from protobuf field: google.ads.googleads.v11.services.AccountLinkOperation operation = 2;
*/
operation?: AccountLinkOperation;
/**
* 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 update on an account link.
*
* @generated from protobuf message google.ads.googleads.v11.services.AccountLinkOperation
*/
export interface AccountLinkOperation {
/**
* 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: "update";
/**
* Update operation: The account link is expected to have
* a valid resource name.
*
* @generated from protobuf field: google.ads.googleads.v11.resources.AccountLink update = 2;
*/
update: AccountLink;
} | {
oneofKind: "remove";
/**
* Remove operation: A resource name for the account link to remove is
* expected, in this format:
*
* `customers/{customer_id}/accountLinks/{account_link_id}`
*
* @generated from protobuf field: string remove = 3;
*/
remove: string;
} | {
oneofKind: undefined;
};
}
/**
* Response message for account link mutate.
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateAccountLinkResponse
*/
export interface MutateAccountLinkResponse {
/**
* Result for the mutate.
*
* @generated from protobuf field: google.ads.googleads.v11.services.MutateAccountLinkResult result = 1;
*/
result?: MutateAccountLinkResult;
/**
* 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 account link mutate.
*
* @generated from protobuf message google.ads.googleads.v11.services.MutateAccountLinkResult
*/
export interface MutateAccountLinkResult {
/**
* Returned for successful operations.
*
* @generated from protobuf field: string resource_name = 1;
*/
resourceName: string;
}
declare class CreateAccountLinkRequest$Type extends MessageType<CreateAccountLinkRequest> {
constructor();
create(value?: PartialMessage<CreateAccountLinkRequest>): CreateAccountLinkRequest;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: CreateAccountLinkRequest): CreateAccountLinkRequest;
internalBinaryWrite(message: CreateAccountLinkRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.CreateAccountLinkRequest
*/
export declare const CreateAccountLinkRequest: CreateAccountLinkRequest$Type;
declare class CreateAccountLinkResponse$Type extends MessageType<CreateAccountLinkResponse> {
constructor();
create(value?: PartialMessage<CreateAccountLinkResponse>): CreateAccountLinkResponse;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: CreateAccountLinkResponse): CreateAccountLinkResponse;
internalBinaryWrite(message: CreateAccountLinkResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.CreateAccountLinkResponse
*/
export declare const CreateAccountLinkResponse: CreateAccountLinkResponse$Type;
declare class MutateAccountLinkRequest$Type extends MessageType<MutateAccountLinkRequest> {
constructor();
create(value?: PartialMessage<MutateAccountLinkRequest>): MutateAccountLinkRequest;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateAccountLinkRequest): MutateAccountLinkRequest;
internalBinaryWrite(message: MutateAccountLinkRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateAccountLinkRequest
*/
export declare const MutateAccountLinkRequest: MutateAccountLinkRequest$Type;
declare class AccountLinkOperation$Type extends MessageType<AccountLinkOperation> {
constructor();
create(value?: PartialMessage<AccountLinkOperation>): AccountLinkOperation;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: AccountLinkOperation): AccountLinkOperation;
internalBinaryWrite(message: AccountLinkOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.AccountLinkOperation
*/
export declare const AccountLinkOperation: AccountLinkOperation$Type;
declare class MutateAccountLinkResponse$Type extends MessageType<MutateAccountLinkResponse> {
constructor();
create(value?: PartialMessage<MutateAccountLinkResponse>): MutateAccountLinkResponse;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateAccountLinkResponse): MutateAccountLinkResponse;
internalBinaryWrite(message: MutateAccountLinkResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateAccountLinkResponse
*/
export declare const MutateAccountLinkResponse: MutateAccountLinkResponse$Type;
declare class MutateAccountLinkResult$Type extends MessageType<MutateAccountLinkResult> {
constructor();
create(value?: PartialMessage<MutateAccountLinkResult>): MutateAccountLinkResult;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateAccountLinkResult): MutateAccountLinkResult;
internalBinaryWrite(message: MutateAccountLinkResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateAccountLinkResult
*/
export declare const MutateAccountLinkResult: MutateAccountLinkResult$Type;
/**
* @generated ServiceType for protobuf service google.ads.googleads.v11.services.AccountLinkService
*/
export declare const AccountLinkService: ServiceType;
export {};