Skip to main content

clients

Overview

Nameclients
TypeResource
Idgoogleads.adexchangebuyer2.clients

Fields

NameDatatypeDescription
entityNamestringThe name of the entity. This field is automatically fetched based on the type and ID. The value of this field is ignored in create and update operations.
visibleToSellerbooleanWhether the client buyer will be visible to sellers.
entityTypestringAn optional field for specifying the type of the client entity: ADVERTISER, BRAND, or AGENCY.
rolestringThe role which is assigned to the client buyer. Each role implies a set of permissions granted to the client. Must be one of CLIENT_DEAL_VIEWER, CLIENT_DEAL_NEGOTIATOR or CLIENT_DEAL_APPROVER.
clientAccountIdstringThe globally-unique numerical ID of the client. The value of this field is ignored in create and update operations.
clientNamestringName used to represent this client to publishers. You may have multiple clients that map to the same entity, but for each client the combination of clientName and entity must be unique. You can specify this field as empty. Maximum length of 255 characters is allowed.
entityIdstringNumerical identifier of the client entity. The entity can be an advertiser, a brand, or an agency. This identifier is unique among all the entities with the same type. The value of this field is ignored if the entity type is not provided. A list of all known advertisers with their identifiers is available in the advertisers.txt file. A list of all known brands with their identifiers is available in the brands.txt file. A list of all known agencies with their identifiers is available in the agencies.txt file.
statusstringThe status of the client buyer.
partnerClientIdstringOptional arbitrary unique identifier of this client buyer from the standpoint of its Ad Exchange sponsor buyer. This field can be used to associate a client buyer with the identifier in the namespace of its sponsor buyer, lookup client buyers by that identifier and verify whether an Ad Exchange counterpart of a given client buyer already exists. If present, must be unique among all the client buyers for its Ad Exchange sponsor buyer.

Methods

NameAccessible byRequired ParamsDescription
accounts_clients_getSELECTaccountId, clientAccountIdGets a client buyer with a given client account ID.
accounts_clients_listSELECTaccountIdLists all the clients for the current sponsor buyer.
accounts_clients_createINSERTaccountIdCreates a new client buyer.
accounts_clients_updateEXECaccountId, clientAccountIdUpdates an existing client buyer.