Method: accounts.adclients.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists all the ad clients available in an account.
HTTP request
GET https://adsense.googleapis.com/v2/{parent=accounts/*}/adclients
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The account which owns the collection of ad clients. Format: accounts/{account}
|
Query parameters
| Parameters |
pageSize |
integer
The maximum number of ad clients to include in the response, used for paging. If unspecified, at most 10000 ad clients will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
|
pageToken |
string
A page token, received from a previous adclients.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to adclients.list must match the call that provided the page token.
|
Request body
The request body must be empty.
Response body
Response definition for the ad client list rpc.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"adClients": [
{
object (AdClient)
}
],
"nextPageToken": string
} |
| Fields |
adClients[] |
object (AdClient)
The ad clients returned in this list response.
|
nextPageToken |
string
Continuation token used to page through ad clients. To retrieve the next page of the results, set the next request's "pageToken" value to this.
|
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/adsense
https://www.googleapis.com/auth/adsense.readonly
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 2025-02-28 UTC.
[null,null,["Last updated 2025-02-28 UTC."],[[["\u003cp\u003eLists all ad clients associated with a specific AdSense account.\u003c/p\u003e\n"],["\u003cp\u003eAllows for pagination to retrieve large sets of ad clients using \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e parameters.\u003c/p\u003e\n"],["\u003cp\u003eReturns an array of ad clients along with a continuation token for subsequent pages.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with either \u003ccode\u003ehttps://www.googleapis.com/auth/adsense\u003c/code\u003e or \u003ccode\u003ehttps://www.googleapis.com/auth/adsense.readonly\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This document details how to retrieve a list of ad clients associated with an account. A `GET` request is made to `https://adsense.googleapis.com/v2/{parent=accounts/*}/adclients`, using the account ID in the `parent` path parameter. Optional `pageSize` and `pageToken` query parameters manage result paging. The request body must be empty. The successful response contains a list of `adClients` and a `nextPageToken` for subsequent pages. It requires either `adsense` or `adsense.readonly` authorization scopes.\n"],null,["# Method: accounts.adclients.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.ListAdClientsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists all the ad clients available in an account.\n\n### HTTP request\n\n`GET https://adsense.googleapis.com/v2/{parent=accounts/*}/adclients`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|----------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The account which owns the collection of ad clients. Format: accounts/{account} |\n\n### Query parameters\n\n| Parameters ||\n|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` The maximum number of ad clients to include in the response, used for paging. If unspecified, at most 10000 ad clients will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000. |\n| `pageToken` | `string` A page token, received from a previous `adclients.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `adclients.list` must match the call that provided the page token. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse definition for the ad client list rpc.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"adClients\": [ { object (/adsense/management/reference/rest/v2/accounts.adclients#AdClient) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `adClients[]` | `object (`[AdClient](/adsense/management/reference/rest/v2/accounts.adclients#AdClient)`)` The ad clients returned in this list response. |\n| `nextPageToken` | `string` Continuation token used to page through ad clients. To retrieve the next page of the results, set the next request's \"pageToken\" value to this. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/adsense`\n- `\n https://www.googleapis.com/auth/adsense.readonly`"]]
