List all ad units in the specified ad client for this AdSense account. Try it now.
Deprecated: Due to the possibility of ambiguity, accounts with both an AdSense publisher account and an AdExchange account will throw an error when trying to use the default account. Always use accounts.list
to check if there's more than one account and let the user choose in that case. After that, specify the account ID on every call using the /accounts/
namespace.
Request
HTTP request
GET https://www.googleapis.com/adsense/v1.4/adclients/adClientId/adunits
Parameters
Parameter name | Value | Description |
---|---|---|
Path parameters | ||
adClientId |
string |
Ad client for which to list ad units. |
Optional query parameters | ||
includeInactive |
boolean |
Whether to include inactive ad units. Default: true. |
maxResults |
integer |
The maximum number of ad units to include in the response, used for paging.
Acceptable values are 0 to 10000 , inclusive.
|
pageToken |
string |
A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. |
Authorization
This request requires authorization with at least one of the following scopes:
Scope |
---|
https://www.googleapis.com/auth/adsense |
https://www.googleapis.com/auth/adsense.readonly |
For more information, see the authentication and authorization page.
Request body
Do not supply a request body with this method.
Response
If successful, this method returns a response body with the following structure:
{ "kind": "adsense#adUnits", "etag": etag, "nextPageToken": string, "items": [ adunits Resource ] }
Property name | Value | Description | Notes |
---|---|---|---|
kind |
string |
Kind of list this is, in this case adsense#adUnits. | |
etag |
etag |
ETag of this response for caching purposes. | |
nextPageToken |
string |
Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this. | |
items[] |
list |
The ad units returned in this list response. |
Try it!
Use the APIs Explorer below to call this method on live data and see the response.