Method: accounts.clients.list

Lists all the clients for the current sponsor buyer.

HTTP request

GET https://adexchangebuyer.googleapis.com/v2beta1/accounts/{accountId}/clients

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
accountId

string (int64 format)

Unique numerical account ID of the sponsor buyer to list the clients for.

Query parameters

Parameters
pageSize

number

Requested page size. The server may return fewer clients than requested. If unspecified, the server will pick an appropriate default.

pageToken

string

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

partnerClientId

string

Optional unique identifier (from the standpoint of an Ad Exchange sponsor buyer partner) of the client to return. If specified, at most one client will be returned in the response.

Request body

The request body must be empty.

Response body

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 accounts.clients.list method to retrieve the next page of results.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adexchange.buyer

Try it!

Send feedback about...

Buyer REST API
Buyer REST API