REST Resource: accounts.clients

Resource: Client

A client resource represents a client buyer—an agency, a brand, or an advertiser customer of the sponsor buyer. Users associated with the client buyer have restricted access to the Ad Exchange Marketplace and certain other sections of the Ad Exchange Buyer UI based on the role granted to the client buyer. All fields are required unless otherwise specified.

JSON representation
{
  "clientAccountId": string,
  "role": enum(ClientRole),
  "status": enum(ClientStatus),
  "clientName": string,
  "visibleToSeller": boolean,
  "entityType": enum(EntityType),
  "entityId": string,
  "entityName": string,
}
Fields
clientAccountId

string (int64 format)

The globally-unique numerical ID of the client. The value of this field is ignored in create and update operations.

role

enum(ClientRole)

The 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.

status

enum(ClientStatus)

The status of the client buyer.

clientName

string

Name 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.

visibleToSeller

boolean

Whether the client buyer will be visible to sellers.

entityType

enum(EntityType)

The type of the client entity: ADVERTISER, BRAND, or AGENCY.

entityId

string (int64 format)

Numerical 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.

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.

entityName

string

The 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.

ClientRole

Client buyer role type.

Enums
CLIENT_ROLE_UNSPECIFIED A placeholder for an undefined client role.
CLIENT_DEAL_VIEWER Users associated with this client can see publisher deal offers in the Marketplace. They can neither negotiate proposals nor approve deals. If this client is visible to publishers, they can send deal proposals to this client.
CLIENT_DEAL_NEGOTIATOR Users associated with this client can respond to deal proposals sent to them by publishers. They can also initiate deal proposals of their own.
CLIENT_DEAL_APPROVER Users associated with this client can approve eligible deals on your behalf. Some deals may still explicitly require publisher finalization. If this role is not selected, the sponsor buyer will need to manually approve each of their deals.

ClientStatus

Valid client status.

Enums
CLIENT_STATUS_UNSPECIFIED A placeholder for an undefined client status.
DISABLED A client that is currently disabled.
ACTIVE A client that is currently active.

EntityType

Represents the type of a client entity.

Enums
ENTITY_TYPE_UNSPECIFIED A placeholder for an undefined client entity type. Should not be used.
ADVERTISER An advertiser.
BRAND A brand.
AGENCY An advertising agency.

Methods

create

Creates a new client buyer.

get

Gets a client buyer with a given client account ID.

list

Lists all the clients for the current sponsor buyer.

update

Updates an existing client buyer.

Send feedback about...

Buyer REST API
Buyer REST API