Method: accounts.clients.users.list

Lists all the known client users for a specified sponsor buyer account ID.

HTTP request

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

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
accountId

string (int64 format)

Numerical account ID of the sponsor buyer of the client to list users for. (required)

clientAccountId

string

The account ID of the client buyer to list users for. (required) You must specify either a string representation of a numerical account identifier or the - character to list all the client users for all the clients of a given sponsor buyer.

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 ListClientUsersResponse.nextPageToken returned from the previous call to the accounts.clients.users.list method.

Request body

The request body must be empty.

Response body

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

JSON representation
{
  "users": [
    {
      object(ClientUser)
    }
  ],
  "nextPageToken": string,
}
Fields
users[]

object(ClientUser)

The returned list of client users.

nextPageToken

string

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

Authorization

Requires the following OAuth scope:

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

Try it!

Send feedback about...

Buyer REST API
Buyer REST API