GOgoogle
buyers

PATCH /v1/buyers/{buyersId}/clients/{clientsId}

Changed on

Updates an existing client.

Request

  • Base URL
    https://authorizedbuyersmarketplace.googleapis.com
  • URL
    https://authorizedbuyersmarketplace.googleapis.com/v1/buyers/{buyersId}/clients/{clientsId}
  • Auth
    OAuth 2 and OAuth 2
    Implicit: https://accounts.google.com/o/oauth2/auth
    Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
    Authorization code: https://accounts.google.com/o/oauth2/auth
    Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace

Path parameters

buyersIdstring required
clientsIdstring required

Query parameters

updateMaskstring google-fieldmask

List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.

Request body

displayNamestring

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

namestring

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

partnerClientIdstring

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.

role'CLIENT_ROLE_UNSPECIFIED' | 'CLIENT_DEAL_VIEWER' | 'CLIENT_DEAL_NEGOTIATOR' | 'CLIENT_DEAL_APPROVER'

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

sellerVisibleboolean

Whether the client will be visible to sellers.

state'STATE_UNSPECIFIED' | 'ACTIVE' | 'INACTIVE'

Output only. The state of the client.

Response

Successful response

displayNamestring

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

namestring

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

partnerClientIdstring

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.

role'CLIENT_ROLE_UNSPECIFIED' | 'CLIENT_DEAL_VIEWER' | 'CLIENT_DEAL_NEGOTIATOR' | 'CLIENT_DEAL_APPROVER'

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

sellerVisibleboolean

Whether the client will be visible to sellers.

state'STATE_UNSPECIFIED' | 'ACTIVE' | 'INACTIVE'

Output only. The state of the client.

Changes