List
|
|||||
|
|
||||
List all ad units 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 5 input parameters
| Name | Format | Description |
|---|---|---|
accountId Required |
STRING |
Account to which the ad client belongs |
adClientId Required |
STRING |
Ad client for which to list ad units |
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 |
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 |
= Parameter name
= Format
|
accountId STRING Required Account to which the ad client belongs |
|
adClientId STRING Required Ad client for which to list ad units |
|
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 |
|
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 |
Output
This building block provides 39 output parameters
| Name | Format | Description |
|---|---|---|
etag |
STRING |
ETag of this response for caching purposes |
items[] |
OBJECT |
|
items[].code |
STRING |
Identity code of this ad unit, not necessarily unique across ad clients |
items[].contentAdsSettings |
OBJECT |
Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated) |
items[].contentAdsSettings.backupOption |
OBJECT |
The backup option to be used in instances where no ad is available |
items[].contentAdsSettings.backupOption.color |
STRING |
Color to use when type is set to COLOR |
items[].contentAdsSettings.backupOption.type |
STRING |
Type of the backup option. Possible values are BLANK, COLOR and URL |
items[].contentAdsSettings.backupOption.url |
STRING |
URL to use when type is set to URL |
items[].contentAdsSettings.size |
STRING |
Size of this ad unit |
items[].contentAdsSettings.type |
STRING |
Type of this ad unit |
items[].customStyle |
OBJECT |
|
items[].customStyle.colors |
OBJECT |
The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash |
items[].customStyle.colors.background |
STRING |
The color of the ad background |
items[].customStyle.colors.border |
STRING |
The color of the ad border |
items[].customStyle.colors.text |
STRING |
The color of the ad text |
items[].customStyle.colors.title |
STRING |
The color of the ad title |
items[].customStyle.colors.url |
STRING |
The color of the ad url |
items[].customStyle.corners |
STRING |
The style of the corners in the ad (deprecated: never populated, ignored) |
items[].customStyle.font |
OBJECT |
The font which is included in the style |
items[].customStyle.font.family |
STRING |
The family of the font |
items[].customStyle.font.size |
STRING |
The size of the font |
items[].customStyle.kind |
STRING |
Kind this is, in this case adsense#adStyle |
items[].feedAdsSettings |
OBJECT |
Settings specific to feed ads (AFF) - deprecated |
items[].feedAdsSettings.adPosition |
STRING |
The position of the ads relative to the feed entries |
items[].feedAdsSettings.frequency |
INTEGER |
The frequency at which ads should appear in the feed (i.e. every N entries) |
items[].feedAdsSettings.minimumWordCount |
INTEGER |
The minimum length an entry should be in order to have attached ads |
items[].feedAdsSettings.type |
STRING |
The type of ads which should appear |
items[].id |
STRING |
Unique identifier of this ad unit. 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#adUnit |
items[].mobileContentAdsSettings |
OBJECT |
Settings specific to WAP mobile content ads (AFMC) - deprecated |
items[].mobileContentAdsSettings.markupLanguage |
STRING |
The markup language to use for this ad unit |
items[].mobileContentAdsSettings.scriptingLanguage |
STRING |
The scripting language to use for this ad unit |
items[].mobileContentAdsSettings.size |
STRING |
Size of this ad unit |
items[].mobileContentAdsSettings.type |
STRING |
Type of this ad unit |
items[].name |
STRING |
Name of this ad unit |
items[].savedStyleId |
STRING |
ID of the saved ad style which holds this ad unit's style information |
items[].status |
STRING |
Status of this ad unit. Possible values are: NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it. ACTIVE: Indicates that there has been activity on this ad unit in the last seven days. INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days |
kind |
STRING |
Kind of list this is, in this case adsense#adUnits |
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 |
= Parameter name
= Format
|
etag STRING ETag of this response for caching purposes |
|
items[] OBJECT |
|
items[].code STRING Identity code of this ad unit, not necessarily unique across ad clients |
|
items[].contentAdsSettings OBJECT Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated) |
|
items[].contentAdsSettings.backupOption OBJECT The backup option to be used in instances where no ad is available |
|
items[].contentAdsSettings.backupOption.color STRING Color to use when type is set to COLOR |
|
items[].contentAdsSettings.backupOption.type STRING Type of the backup option. Possible values are BLANK, COLOR and URL |
|
items[].contentAdsSettings.backupOption.url STRING URL to use when type is set to URL |
|
items[].contentAdsSettings.size STRING Size of this ad unit |
|
items[].contentAdsSettings.type STRING Type of this ad unit |
|
items[].customStyle OBJECT |
|
items[].customStyle.colors OBJECT The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash |
|
items[].customStyle.colors.background STRING The color of the ad background |
|
items[].customStyle.colors.border STRING The color of the ad border |
|
items[].customStyle.colors.text STRING The color of the ad text |
|
items[].customStyle.colors.title STRING The color of the ad title |
|
items[].customStyle.colors.url STRING The color of the ad url |
|
items[].customStyle.corners STRING The style of the corners in the ad (deprecated: never populated, ignored) |
|
items[].customStyle.font OBJECT The font which is included in the style |
|
items[].customStyle.font.family STRING The family of the font |
|
items[].customStyle.font.size STRING The size of the font |
|
items[].customStyle.kind STRING Kind this is, in this case adsense#adStyle |
|
items[].feedAdsSettings OBJECT Settings specific to feed ads (AFF) - deprecated |
|
items[].feedAdsSettings.adPosition STRING The position of the ads relative to the feed entries |
|
items[].feedAdsSettings.frequency INTEGER The frequency at which ads should appear in the feed (i.e. every N entries) |
|
items[].feedAdsSettings.minimumWordCount INTEGER The minimum length an entry should be in order to have attached ads |
|
items[].feedAdsSettings.type STRING The type of ads which should appear |
|
items[].id STRING Unique identifier of this ad unit. 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#adUnit |
|
items[].mobileContentAdsSettings OBJECT Settings specific to WAP mobile content ads (AFMC) - deprecated |
|
items[].mobileContentAdsSettings.markupLanguage STRING The markup language to use for this ad unit |
|
items[].mobileContentAdsSettings.scriptingLanguage STRING The scripting language to use for this ad unit |
|
items[].mobileContentAdsSettings.size STRING Size of this ad unit |
|
items[].mobileContentAdsSettings.type STRING Type of this ad unit |
|
items[].name STRING Name of this ad unit |
|
items[].savedStyleId STRING ID of the saved ad style which holds this ad unit's style information |
|
items[].status STRING Status of this ad unit. Possible values are: NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it. ACTIVE: Indicates that there has been activity on this ad unit in the last seven days. INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days |
|
kind STRING Kind of list this is, in this case adsense#adUnits |
|
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 |