List
|
|||||
|
|
||||
List all URL channels in the specified ad client for 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 4 input parameters
| Name | Format | Description |
|---|---|---|
accountId Required |
STRING |
Account to which the ad client belongs |
adClientId Required |
STRING |
Ad client for which to list URL channels |
maxResults |
INTEGER |
The maximum number of URL channels to include in the response, used for paging |
pageToken |
STRING |
A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response |
= Parameter name
= Format
|
accountId STRING Required Account to which the ad client belongs |
|
adClientId STRING Required Ad client for which to list URL channels |
|
maxResults INTEGER The maximum number of URL channels to include in the response, used for paging |
|
pageToken STRING A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response |
Output
This building block provides 7 output parameters
| Name | Format | Description |
|---|---|---|
etag |
STRING |
ETag of this response for caching purposes |
items[] |
OBJECT |
|
items[].id |
STRING |
Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format |
items[].kind |
STRING |
Kind of resource this is, in this case adsense#urlChannel |
items[].urlPattern |
STRING |
URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home |
kind |
STRING |
Kind of list this is, in this case adsense#urlChannels |
nextPageToken |
STRING |
Continuation token used to page through URL channels. 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[].id STRING Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format |
|
items[].kind STRING Kind of resource this is, in this case adsense#urlChannel |
|
items[].urlPattern STRING URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home |
|
kind STRING Kind of list this is, in this case adsense#urlChannels |
|
nextPageToken STRING Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's "pageToken" value to this |