REST Resource: buyers.clients

  • A client represents an agency, brand, or advertiser customer of the buyer, with varying access levels to the Marketplace based on their assigned role.

  • Client roles determine user permissions in the Marketplace, ranging from viewing proposals to negotiating and approving deals.

  • Clients can be in an active or inactive state, controlling their access to the Authorized Buyers UI.

  • The API provides methods to manage clients, including creating, updating, activating, deactivating, and listing them.

  • Client information includes name, role, state, display name, seller visibility, and an optional partner client ID for buyer-specific identification.

Resource: Client

A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.

JSON representation 
{
  "name": string,
  "role": enum (ClientRole),
  "state": enum (State),
  "displayName": string,
  "sellerVisible": boolean,
  "partnerClientId": string
}
Fields
name

string

Output only. The resource name of the client. Format: buyers/{accountId}/clients/{clientAccountId}
role

enum (ClientRole)

Required. The role assigned to the client. Each role implies a set of permissions granted to the client.
state

enum (State)

Output only. The state of the client.
displayName

string

Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
sellerVisible

boolean

Whether the client will be visible to sellers.
partnerClientId

string

Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients.

ClientRole

Client role type controlling what actions users of the client can perform in the Markeptlace UI.

Enums
CLIENT_ROLE_UNSPECIFIED A placeholder for an undefined client role. This value should never be specified in user input for create or update method, otherwise an error will be returned.
CLIENT_DEAL_VIEWER Users associated with this client role can only view proposals and deals in the Marketplace UI. They cannot negotiate or approve proposals and deals sent from publishers or send RFP to publishers.
CLIENT_DEAL_NEGOTIATOR Users associated with this client role can view and negotiate on the proposals and deals in the Marketplace UI sent from publishers and send RFP to publishers, but cannot approve the proposals and deals by themselves. The buyer can approve the proposals and deals on behalf of the client.
CLIENT_DEAL_APPROVER Users associated with this client role can view, negotiate and approve proposals and deals in the Marketplace UI and send RFP to publishers.

State

Client state.

Enums
STATE_UNSPECIFIED A placeholder for an undefined client state. Should not be used.
ACTIVE A client that is currently active and allowed to access the Authorized Buyers UI.
INACTIVE A client that is currently inactive and not allowed to access the Authorized Buyers UI.

Methods

activate

 Activates an existing client.

create

 Creates a new client.

deactivate

 Deactivates an existing client.

get

 Gets a client with a given resource name.

list

 Lists all the clients for the current buyer.

patch

 Updates an existing client.