GOgoogle
buyers

POST /v1/buyers/{buyersId}/clients/{clientsId}:deactivate

Changed on

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

Request

  • Base URL
    https://authorizedbuyersmarketplace.googleapis.com
  • URL
    https://authorizedbuyersmarketplace.googleapis.com/v1/buyers/{buyersId}/clients/{clientsId}:deactivate
  • 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

Request body

DeactivateClientRequest required

Request message for disabling a 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