Method: buyers.clients.list

Lists all the clients for the current buyer.

HTTP request

GET https://authorizedbuyersmarketplace.googleapis.com/v1/{parent=buyers/*}/clients

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

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

Query parameters

Parameters
pageSize

integer

Requested page size. If left blank, a default page size of 500 will be applied.

pageToken

string

A token identifying a page of results the server should return. Typically, this is the value of [ListClientsResponse.nextPageToken][nextPageToken] returned from the previous call to the [list][clients.list] method.

filter

string

Query string using the Filtering Syntax Supported fields for filtering are:

  • partnerClientId

Use this field to filter the clients by the partnerClientId. For example, if the partnerClientId of the client is "1234", the value of this field should be partnerClientId = "1234", in order to get only the client whose partnerClientId is "1234" in the response.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response message for the [list][clients.list] method.

JSON representation
{
  "clients": [
    {
      object (Client)
    }
  ],
  "nextPageToken": string
}
Fields
clients[]

object (Client)

The returned list of clients.

nextPageToken

string

A token to retrieve the next page of results. Pass this value in the ListClientsRequest.pageToken field in the subsequent call to the [list][clients.list] method to retrieve the next page of results.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/authorized-buyers-marketplace