Method: accounts.adclients.adunits.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists all ad units under a specified account and ad client.
HTTP request
GET https://adsense.googleapis.com/v2/{parent=accounts/*/adclients/*}/adunits
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The ad client which owns the collection of ad units. Format: accounts/{account}/adclients/{adclient}
|
Query parameters
| Parameters |
pageSize |
integer
The maximum number of ad units to include in the response, used for paging. If unspecified, at most 10000 ad units 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 adunits.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to adunits.list must match the call that provided the page token.
|
Request body
The request body must be empty.
Response body
Response definition for the adunit list rpc.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"adUnits": [
{
object (AdUnit)
}
],
"nextPageToken": string
} |
| Fields |
adUnits[] |
object (AdUnit)
The ad units returned in the list response.
|
nextPageToken |
string
Continuation token used to page through ad units. 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 units under a specified account and ad client using the \u003ccode\u003eadunits.list\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering by page size and using pagination for large result sets.\u003c/p\u003e\n"],["\u003cp\u003eResponse includes an array of ad units and a token for retrieving subsequent pages.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with either \u003ccode\u003eadsense\u003c/code\u003e or \u003ccode\u003eadsense.readonly\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This describes how to list ad units under a specific account and ad client using a `GET` request to the provided URL. The `parent` path parameter is required to specify the ad client. The `pageSize` and `pageToken` query parameters are available for pagination. The request body must be empty. The response includes an array of `adUnits` and a `nextPageToken` for pagination. The operation requires specific OAuth scopes for authorization.\n"],null,["# Method: accounts.adclients.adunits.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.ListAdUnitsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists all ad units under a specified account and ad client.\n\n### HTTP request\n\n`GET https://adsense.googleapis.com/v2/{parent=accounts/*/adclients/*}/adunits`\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 ad client which owns the collection of ad units. Format: accounts/{account}/adclients/{adclient} |\n\n### Query parameters\n\n| Parameters ||\n|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` The maximum number of ad units to include in the response, used for paging. If unspecified, at most 10000 ad units 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 `adunits.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `adunits.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 adunit list rpc.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"adUnits\": [ { object (/adsense/management/reference/rest/v2/accounts.adclients.adunits#AdUnit) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `adUnits[]` | `object (`[AdUnit](/adsense/management/reference/rest/v2/accounts.adclients.adunits#AdUnit)`)` The ad units returned in the list response. |\n| `nextPageToken` | `string` Continuation token used to page through ad units. 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`"]]
