Skip to main content

clients

Overview

Nameclients
TypeResource
Idgoogledevelopers.authorizedbuyersmarketplace.clients

Fields

NameDatatypeDescription
namestringOutput only. The resource name of the client. Format: buyers/{accountId}/clients/{clientAccountId}
rolestringRequired. The role assigned to the client. Each role implies a set of permissions granted to the client.
sellerVisiblebooleanWhether the client will be visible to sellers.
statestringOutput only. The state of the client.
displayNamestringRequired. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
partnerClientIdstringArbitrary 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.

Methods

NameAccessible byRequired ParamsDescription
buyers_clients_getSELECTbuyersId, clientsIdGets a client with a given resource name.
buyers_clients_listSELECTbuyersIdLists all the clients for the current buyer.
buyers_clients_createINSERTbuyersIdCreates a new client.
buyers_clients_activateEXECbuyersId, clientsIdActivates an existing client. The state of the client will be updated to "ACTIVE". This method has no effect if the client is already in "ACTIVE" state.
buyers_clients_deactivateEXECbuyersId, clientsIdDeactivates an existing client. The state of the client will be updated to "INACTIVE". This method has no effect if the client is already in "INACTIVE" state.
buyers_clients_patchEXECbuyersId, clientsIdUpdates an existing client.