1. class
  2. Google
  3. \
  4. Service
  5. \
  6. AuthorizedBuyersMarketplace
  7. \
  8. Resource
  9. \
  10. BuyersClients

BuyersClients

class BuyersClients extends Resource (View source)

The "clients" collection of methods.

Typical usage is:

 $authorizedbuyersmarketplaceService = new Google\Service\AuthorizedBuyersMarketplace(...);
 $clients = $authorizedbuyersmarketplaceService->buyers_clients;

Methods

Client
activate(string $name, ActivateClientRequest $postBody, array $optParams = [])

Activates 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. (clients.activate)

Client
create(string $parent, Client $postBody, array $optParams = [])

Creates a new client. (clients.create)

Client
deactivate(string $name, DeactivateClientRequest $postBody, array $optParams = [])

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. (clients.deactivate)

Client
get(string $name, array $optParams = [])

Gets a client with a given resource name. (clients.get)

ListClientsResponse
listBuyersClients(string $parent, array $optParams = [])

Lists all the clients for the current buyer. (clients.listBuyersClients)

Client
patch(string $name, Client $postBody, array $optParams = [])

Updates an existing client. (clients.patch)

Details

at line 47
Client activate(string $name, ActivateClientRequest $postBody, array $optParams = [])

Activates 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. (clients.activate)

Parameters

string $name

Required. Format: buyers/{buyerAccountId}/clients/{clientAccountId}
ActivateClientRequest $postBody
array $optParams

Optional parameters.

Return Value

Client

Exceptions

Exception

at line 63
Client create(string $parent, Client $postBody, array $optParams = [])

Creates a new client. (clients.create)

Parameters

string $parent

Required. The name of the buyer. Format: buyers/{accountId}
Client $postBody
array $optParams

Optional parameters.

Return Value

Client

Exceptions

Exception

at line 81
Client deactivate(string $name, DeactivateClientRequest $postBody, array $optParams = [])

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. (clients.deactivate)

Parameters

string $name

Required. Format: buyers/{buyerAccountId}/clients/{clientAccountId}
DeactivateClientRequest $postBody
array $optParams

Optional parameters.

Return Value

Client

Exceptions

Exception

at line 96
Client get(string $name, array $optParams = [])

Gets a client with a given resource name. (clients.get)

Parameters

string $name

Required. Format: buyers/{accountId}/clients/{clientAccountId}
array $optParams

Optional parameters.

Return Value

Client

Exceptions

Exception

at line 125
ListClientsResponse listBuyersClients(string $parent, array $optParams = [])

Lists all the clients for the current buyer. (clients.listBuyersClients)

Parameters

string $parent

Required. The name of the buyer. Format: buyers/{accountId}
array $optParams

Optional parameters.

Return Value

ListClientsResponse

Exceptions

Exception

at line 152
Client patch(string $name, Client $postBody, array $optParams = [])

Updates an existing client. (clients.patch)

Parameters

string $name

Output only. The resource name of the client. Format: buyers/{accountId}/clients/{clientAccountId}
Client $postBody
array $optParams

Optional parameters.

Return Value

Client

Exceptions

Exception