List
|
|||||
|
|
||||
List all ad clients in the specified account
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your AdSense data
- View your AdSense data
Input
This building block consumes 3 input parameters
| Name | Format | Description |
|---|---|---|
accountId Required |
STRING |
Account for which to list ad clients |
maxResults |
INTEGER |
The maximum number of ad clients to include in the response, used for paging |
pageToken |
STRING |
A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response |
= Parameter name
= Format
|
accountId STRING Required Account for which to list ad clients |
|
maxResults INTEGER The maximum number of ad clients to include in the response, used for paging |
|
pageToken STRING A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response |
Output
This building block provides 9 output parameters
| Name | Format | Description |
|---|---|---|
etag |
STRING |
ETag of this response for caching purposes |
items[] |
OBJECT |
|
items[].arcOptIn |
BOOLEAN |
Whether this ad client is opted in to ARC |
items[].id |
STRING |
Unique identifier of this ad client |
items[].kind |
STRING |
Kind of resource this is, in this case adsense#adClient |
items[].productCode |
STRING |
This ad client's product code, which corresponds to the PRODUCT_CODE report dimension |
items[].supportsReporting |
BOOLEAN |
Whether this ad client supports being reported on |
kind |
STRING |
Kind of list this is, in this case adsense#adClients |
nextPageToken |
STRING |
Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's "pageToken" value to this |
= Parameter name
= Format
|
etag STRING ETag of this response for caching purposes |
|
items[] OBJECT |
|
items[].arcOptIn BOOLEAN Whether this ad client is opted in to ARC |
|
items[].id STRING Unique identifier of this ad client |
|
items[].kind STRING Kind of resource this is, in this case adsense#adClient |
|
items[].productCode STRING This ad client's product code, which corresponds to the PRODUCT_CODE report dimension |
|
items[].supportsReporting BOOLEAN Whether this ad client supports being reported on |
|
kind STRING Kind of list this is, in this case adsense#adClients |
|
nextPageToken STRING Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's "pageToken" value to this |