google-ads-api-client
Version:
A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.
134 lines (133 loc) • 5.71 kB
TypeScript
import type { RpcTransport } from "@protobuf-ts/runtime-rpc";
import type { ServiceInfo } from "@protobuf-ts/runtime-rpc";
import type { CreateCustomerClientResponse } from "./customer_service";
import type { CreateCustomerClientRequest } from "./customer_service";
import type { ListAccessibleCustomersResponse } from "./customer_service";
import type { ListAccessibleCustomersRequest } from "./customer_service";
import type { MutateCustomerResponse } from "./customer_service";
import type { MutateCustomerRequest } from "./customer_service";
import type { UnaryCall } from "@protobuf-ts/runtime-rpc";
import type { RpcOptions } from "@protobuf-ts/runtime-rpc";
/**
* Service to manage customers.
*
* @generated from protobuf service google.ads.googleads.v11.services.CustomerService
*/
export interface ICustomerServiceClient {
/**
* Updates a customer. Operation statuses are returned.
*
* List of thrown errors:
* [AuthenticationError]()
* [AuthorizationError]()
* [DatabaseError]()
* [FieldMaskError]()
* [HeaderError]()
* [InternalError]()
* [QuotaError]()
* [RequestError]()
* [UrlFieldError]()
*
* @generated from protobuf rpc: MutateCustomer(google.ads.googleads.v11.services.MutateCustomerRequest) returns (google.ads.googleads.v11.services.MutateCustomerResponse);
*/
mutateCustomer(input: MutateCustomerRequest, options?: RpcOptions): UnaryCall<MutateCustomerRequest, MutateCustomerResponse>;
/**
* Returns resource names of customers directly accessible by the
* user authenticating the call.
*
* List of thrown errors:
* [AuthenticationError]()
* [AuthorizationError]()
* [HeaderError]()
* [InternalError]()
* [QuotaError]()
* [RequestError]()
*
* @generated from protobuf rpc: ListAccessibleCustomers(google.ads.googleads.v11.services.ListAccessibleCustomersRequest) returns (google.ads.googleads.v11.services.ListAccessibleCustomersResponse);
*/
listAccessibleCustomers(input: ListAccessibleCustomersRequest, options?: RpcOptions): UnaryCall<ListAccessibleCustomersRequest, ListAccessibleCustomersResponse>;
/**
* Creates a new client under manager. The new client customer is returned.
*
* List of thrown errors:
* [AccessInvitationError]()
* [AuthenticationError]()
* [AuthorizationError]()
* [CurrencyCodeError]()
* [HeaderError]()
* [InternalError]()
* [ManagerLinkError]()
* [QuotaError]()
* [RequestError]()
* [StringLengthError]()
* [TimeZoneError]()
*
* @generated from protobuf rpc: CreateCustomerClient(google.ads.googleads.v11.services.CreateCustomerClientRequest) returns (google.ads.googleads.v11.services.CreateCustomerClientResponse);
*/
createCustomerClient(input: CreateCustomerClientRequest, options?: RpcOptions): UnaryCall<CreateCustomerClientRequest, CreateCustomerClientResponse>;
}
/**
* Service to manage customers.
*
* @generated from protobuf service google.ads.googleads.v11.services.CustomerService
*/
export declare class CustomerServiceClient implements ICustomerServiceClient, ServiceInfo {
private readonly _transport;
typeName: string;
methods: import("@protobuf-ts/runtime-rpc").MethodInfo<any, any>[];
options: {
[extensionName: string]: import("@protobuf-ts/runtime").JsonValue;
};
constructor(_transport: RpcTransport);
/**
* Updates a customer. Operation statuses are returned.
*
* List of thrown errors:
* [AuthenticationError]()
* [AuthorizationError]()
* [DatabaseError]()
* [FieldMaskError]()
* [HeaderError]()
* [InternalError]()
* [QuotaError]()
* [RequestError]()
* [UrlFieldError]()
*
* @generated from protobuf rpc: MutateCustomer(google.ads.googleads.v11.services.MutateCustomerRequest) returns (google.ads.googleads.v11.services.MutateCustomerResponse);
*/
mutateCustomer(input: MutateCustomerRequest, options?: RpcOptions): UnaryCall<MutateCustomerRequest, MutateCustomerResponse>;
/**
* Returns resource names of customers directly accessible by the
* user authenticating the call.
*
* List of thrown errors:
* [AuthenticationError]()
* [AuthorizationError]()
* [HeaderError]()
* [InternalError]()
* [QuotaError]()
* [RequestError]()
*
* @generated from protobuf rpc: ListAccessibleCustomers(google.ads.googleads.v11.services.ListAccessibleCustomersRequest) returns (google.ads.googleads.v11.services.ListAccessibleCustomersResponse);
*/
listAccessibleCustomers(input: ListAccessibleCustomersRequest, options?: RpcOptions): UnaryCall<ListAccessibleCustomersRequest, ListAccessibleCustomersResponse>;
/**
* Creates a new client under manager. The new client customer is returned.
*
* List of thrown errors:
* [AccessInvitationError]()
* [AuthenticationError]()
* [AuthorizationError]()
* [CurrencyCodeError]()
* [HeaderError]()
* [InternalError]()
* [ManagerLinkError]()
* [QuotaError]()
* [RequestError]()
* [StringLengthError]()
* [TimeZoneError]()
*
* @generated from protobuf rpc: CreateCustomerClient(google.ads.googleads.v11.services.CreateCustomerClientRequest) returns (google.ads.googleads.v11.services.CreateCustomerClientResponse);
*/
createCustomerClient(input: CreateCustomerClientRequest, options?: RpcOptions): UnaryCall<CreateCustomerClientRequest, CreateCustomerClientResponse>;
}