Method: accounts.clients.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists all the clients for the current sponsor buyer.
HTTP request
GET https://adexchangebuyer.googleapis.com/v2beta1/accounts/{accountId}/clients
The URL uses gRPC Transcoding 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 |
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 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
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 clients associated with the current sponsor buyer.\u003c/p\u003e\n"],["\u003cp\u003eUses an HTTP GET request with path and query parameters to filter results.\u003c/p\u003e\n"],["\u003cp\u003eRequires \u003ccode\u003ehttps://www.googleapis.com/auth/adexchange.buyer\u003c/code\u003e authorization scope for access.\u003c/p\u003e\n"],["\u003cp\u003eResponse includes a list of clients and a token for pagination if needed.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must be empty for this operation.\u003c/p\u003e\n"]]],["This document details how to list clients for a sponsor buyer using the `GET` method with the URL `https://adexchangebuyer.googleapis.com/v2beta1/accounts/{accountId}/clients`. It requires the `accountId` path parameter and allows optional `pageSize`, `pageToken`, and `partnerClientId` query parameters. The request body must be empty. The response includes a list of client objects and a `nextPageToken` for pagination. Requires authorization scope: `https://www.googleapis.com/auth/adexchange.buyer`.\n"],null,["# Method: accounts.clients.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.ListClientsResponse.SCHEMA_REPRESENTATION)\n- [Authorization Scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists all the clients for the current sponsor buyer.\n\n### HTTP request\n\n`GET https://adexchangebuyer.googleapis.com/v2beta1/accounts/{accountId}/clients`\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)` Unique numerical account ID of the sponsor buyer to list the clients for. |\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 [ListClientsResponse.nextPageToken](/authorized-buyers/apis/reference/rest/v2beta1/accounts.clients/list#body.ListClientsResponse.FIELDS.next_page_token) returned from the previous call to the [accounts.clients.list](/authorized-buyers/apis/reference/rest/v2beta1/accounts.clients/list#google.ads.adexchange.buyer.v2beta1.ClientService.ListClients) method. |\n| `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. |\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| ``` { \"clients\": [ { object (/authorized-buyers/apis/reference/rest/v2beta1/accounts.clients#Client) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `clients[]` | `object (`[Client](/authorized-buyers/apis/reference/rest/v2beta1/accounts.clients#Client)`)` The returned list of clients. |\n| `nextPageToken` | `string` A token to retrieve the next page of results. Pass this value in the [ListClientsRequest.pageToken](/authorized-buyers/apis/reference/rest/v2beta1/accounts.clients/list#body.QUERY_PARAMETERS.page_token) field in the subsequent call to the [accounts.clients.list](/authorized-buyers/apis/reference/rest/v2beta1/accounts.clients/list#google.ads.adexchange.buyer.v2beta1.ClientService.ListClients) 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`"]]
