google-ads-api-client
Version:
A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.
111 lines (110 loc) • 4.24 kB
TypeScript
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 { CustomerStatusEnum_CustomerStatus } from "../enums/customer_status";
/**
* A link between the given customer and a client customer. CustomerClients only
* exist for manager customers. All direct and indirect client customers are
* included, as well as the manager itself.
*
* @generated from protobuf message google.ads.googleads.v11.resources.CustomerClient
*/
export interface CustomerClient {
/**
* Output only. The resource name of the customer client.
* CustomerClient resource names have the form:
* `customers/{customer_id}/customerClients/{client_customer_id}`
*
* @generated from protobuf field: string resource_name = 1;
*/
resourceName: string;
/**
* Output only. The resource name of the client-customer which is linked to
* the given customer. Read only.
*
* @generated from protobuf field: optional string client_customer = 12;
*/
clientCustomer?: string;
/**
* Output only. Specifies whether this is a
* [hidden account](https://support.google.com/google-ads/answer/7519830).
* Read only.
*
* @generated from protobuf field: optional bool hidden = 13;
*/
hidden?: boolean;
/**
* Output only. Distance between given customer and client. For self link, the level value
* will be 0. Read only.
*
* @generated from protobuf field: optional int64 level = 14;
*/
level?: bigint;
/**
* Output only. Common Locale Data Repository (CLDR) string representation of the
* time zone of the client, for example, America/Los_Angeles. Read only.
*
* @generated from protobuf field: optional string time_zone = 15;
*/
timeZone?: string;
/**
* Output only. Identifies if the client is a test account. Read only.
*
* @generated from protobuf field: optional bool test_account = 16;
*/
testAccount?: boolean;
/**
* Output only. Identifies if the client is a manager. Read only.
*
* @generated from protobuf field: optional bool manager = 17;
*/
manager?: boolean;
/**
* Output only. Descriptive name for the client. Read only.
*
* @generated from protobuf field: optional string descriptive_name = 18;
*/
descriptiveName?: string;
/**
* Output only. Currency code (for example, 'USD', 'EUR') for the client. Read only.
*
* @generated from protobuf field: optional string currency_code = 19;
*/
currencyCode?: string;
/**
* Output only. The ID of the client customer. Read only.
*
* @generated from protobuf field: optional int64 id = 20;
*/
id?: bigint;
/**
* Output only. The resource names of the labels owned by the requesting customer that are
* applied to the client customer.
* Label resource names have the form:
*
* `customers/{customer_id}/labels/{label_id}`
*
* @generated from protobuf field: repeated string applied_labels = 21;
*/
appliedLabels: string[];
/**
* Output only. The status of the client customer. Read only.
*
* @generated from protobuf field: google.ads.googleads.v11.enums.CustomerStatusEnum.CustomerStatus status = 22;
*/
status: CustomerStatusEnum_CustomerStatus;
}
declare class CustomerClient$Type extends MessageType<CustomerClient> {
constructor();
create(value?: PartialMessage<CustomerClient>): CustomerClient;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: CustomerClient): CustomerClient;
internalBinaryWrite(message: CustomerClient, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.resources.CustomerClient
*/
export declare const CustomerClient: CustomerClient$Type;
export {};