List all ad units in the specified ad client. Try it now.
Request
HTTP Request
GET https://www.googleapis.com/adsense/v1.1/adclients/adClientId/adunits
Parameters
In addition to the standard parameters, this method supports the following query parameters:
Parameter Name | Value | Type | Description |
---|---|---|---|
Required Parameters | |||
adClientId |
string |
path |
Ad client which contains the custom channel. |
Optional Parameters | |||
includeInactive |
boolean |
query |
Whether to include inactive ad units. Default: true. |
maxResults |
integer |
query |
The maximum number of ad units to include in the response, used for paging. The minimum value is 0 (zero) and the maximum value is 10000 (10 thousand). Default is 10000 (10 thousand). |
pageToken |
string |
query |
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. Default returns the first page of results. |
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 ] }
The properties of the response body structure are defined as follows:
Property Name | Value | Description |
---|---|---|
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!
You can use the APIs Explorer to call this method on live data and see the response.