List
|
|||||
|
|
||||
List all custom channels which the specified ad unit belongs to
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 |
|---|---|---|
adClientId Required |
STRING |
Ad client which contains the ad unit |
adUnitId Required |
STRING |
Ad unit for which to list custom channels |
maxResults |
INTEGER |
The maximum number of custom channels to include in the response, used for paging |
pageToken |
STRING |
A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response |
= Parameter name
= Format
|
adClientId STRING Required Ad client which contains the ad unit |
|
adUnitId STRING Required Ad unit for which to list custom channels |
|
maxResults INTEGER The maximum number of custom channels to include in the response, used for paging |
|
pageToken STRING A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response |
Output
This building block provides 13 output parameters
| Name | Format | Description |
|---|---|---|
etag |
STRING |
ETag of this response for caching purposes |
items[] |
OBJECT |
|
items[].code |
STRING |
Code of this custom channel, not necessarily unique across ad clients |
items[].id |
STRING |
Unique identifier of this custom 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#customChannel |
items[].name |
STRING |
Name of this custom channel |
items[].targetingInfo |
OBJECT |
The targeting information of this custom channel, if activated |
items[].targetingInfo.adsAppearOn |
STRING |
The name used to describe this channel externally |
items[].targetingInfo.description |
STRING |
The external description of the channel |
items[].targetingInfo.location |
STRING |
The locations in which ads appear. (Only valid for content and mobile content ads (deprecated)). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads (deprecated) are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS |
items[].targetingInfo.siteLanguage |
STRING |
The language of the sites ads will be displayed on |
kind |
STRING |
Kind of list this is, in this case adsense#customChannels |
nextPageToken |
STRING |
Continuation token used to page through custom 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[].code STRING Code of this custom channel, not necessarily unique across ad clients |
|
items[].id STRING Unique identifier of this custom 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#customChannel |
|
items[].name STRING Name of this custom channel |
|
items[].targetingInfo OBJECT The targeting information of this custom channel, if activated |
|
items[].targetingInfo.adsAppearOn STRING The name used to describe this channel externally |
|
items[].targetingInfo.description STRING The external description of the channel |
|
items[].targetingInfo.location STRING The locations in which ads appear. (Only valid for content and mobile content ads (deprecated)). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads (deprecated) are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS |
|
items[].targetingInfo.siteLanguage STRING The language of the sites ads will be displayed on |
|
kind STRING Kind of list this is, in this case adsense#customChannels |
|
nextPageToken STRING Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this |