Method: buyers.clients.list

  • The "List clients" method lists all clients associated with the current buyer.

  • This method uses an HTTP GET request with a URL that includes the buyer's account ID as a path parameter.

  • Optional query parameters like pageSize, pageToken, and filter can be used to control the results.

  • The request body must be empty, and the response body contains a list of clients and a nextPageToken for pagination.

  • Authorization requires the https://www.googleapis.com/auth/authorized-buyers-marketplace OAuth scope.

Lists all the clients for the current buyer.

HTTP request

GET https://authorizedbuyersmarketplace.googleapis.com/v1alpha/{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

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

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

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