Method: accounts.clients.users.list
Stay organized with collections
Save and categorize content based on your preferences.
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 gRPC Transcoding 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 |
integer
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 Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/adexchange.buyer
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-18 UTC.
[null,null,["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eLists all known client users for a specified sponsor buyer account, optionally filtering by a specific client account.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires specifying the sponsor buyer account ID and optionally the client account ID in the URL path.\u003c/p\u003e\n"],["\u003cp\u003eResults can be paginated using \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e query parameters.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes a list of client users and a token for retrieving the next page of results, if available.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/adexchange.buyer\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This describes how to list client users for a sponsor buyer account using a `GET` request. The request URL requires `accountId` and `clientAccountId` path parameters. Optional query parameters include `pageSize` and `pageToken` for pagination. The request body must be empty. A successful response returns a JSON body containing a list of `users` and an optional `nextPageToken` for further pagination. The request needs `https://www.googleapis.com/auth/adexchange.buyer` authorization scope.\n"],null,["# Method: accounts.clients.users.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListClientUsersResponse.SCHEMA_REPRESENTATION)\n- [Authorization Scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists all the known client users for a specified sponsor buyer account ID.\n\n### HTTP request\n\n`GET https://adexchangebuyer.googleapis.com/v2beta1/accounts/{accountId}/clients/{clientAccountId}/users`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `accountId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Numerical account ID of the sponsor buyer of the client to list users for. (required) |\n| `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. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Requested page size. The server may return fewer clients than requested. If unspecified, the server will pick an appropriate default. |\n| `pageToken` | `string` A token identifying a page of results the server should return. Typically, this is the value of [ListClientUsersResponse.nextPageToken](/authorized-buyers/apis/reference/rest/v2beta1/accounts.clients.users/list#body.ListClientUsersResponse.FIELDS.next_page_token) returned from the previous call to the [accounts.clients.users.list](/authorized-buyers/apis/reference/rest/v2beta1/accounts.clients.users/list#google.ads.adexchange.buyer.v2beta1.ClientUserService.ListClientUsers) method. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation ||\n|-------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"users\": [ { object (/authorized-buyers/apis/reference/rest/v2beta1/accounts.clients.users#ClientUser) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `users[]` | `object (`[ClientUser](/authorized-buyers/apis/reference/rest/v2beta1/accounts.clients.users#ClientUser)`)` The returned list of client users. |\n| `nextPageToken` | `string` A token to retrieve the next page of results. Pass this value in the [ListClientUsersRequest.pageToken](/authorized-buyers/apis/reference/rest/v2beta1/accounts.clients.users/list#body.QUERY_PARAMETERS.page_token) field in the subsequent call to the [clients.invitations.list](/authorized-buyers/apis/reference/rest/v2beta1/accounts.clients.users/list#google.ads.adexchange.buyer.v2beta1.ClientUserService.ListClientUsers) method to retrieve the next page of results. |\n\n### Authorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/adexchange.buyer`"]]
