List
|
|||||
|
|
List all saved ad styles 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 saved ad styles |
maxResults |
INTEGER |
The maximum number of saved ad styles to include in the response, used for paging |
pageToken |
STRING |
A continuation token, used to page through saved ad styles. 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 saved ad styles |
maxResults INTEGER The maximum number of saved ad styles to include in the response, used for paging |
pageToken STRING A continuation token, used to page through saved ad styles. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response |
Output
This building block provides 19 output parameters
Name | Format | Description |
---|---|---|
etag |
STRING |
ETag of this response for caching purposes |
items[] |
OBJECT |
|
items[].adStyle |
OBJECT |
|
items[].adStyle.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[].adStyle.colors.background |
STRING |
The color of the ad background |
items[].adStyle.colors.border |
STRING |
The color of the ad border |
items[].adStyle.colors.text |
STRING |
The color of the ad text |
items[].adStyle.colors.title |
STRING |
The color of the ad title |
items[].adStyle.colors.url |
STRING |
The color of the ad url |
items[].adStyle.corners |
STRING |
The style of the corners in the ad (deprecated: never populated, ignored) |
items[].adStyle.font |
OBJECT |
The font which is included in the style |
items[].adStyle.font.family |
STRING |
The family of the font |
items[].adStyle.font.size |
STRING |
The size of the font |
items[].adStyle.kind |
STRING |
Kind this is, in this case adsense#adStyle |
items[].id |
STRING |
Unique identifier of this saved ad style. 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#savedAdStyle |
items[].name |
STRING |
The user selected name of this SavedAdStyle |
kind |
STRING |
Kind of list this is, in this case adsense#savedAdStyles |
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[].adStyle OBJECT |
items[].adStyle.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[].adStyle.colors.background STRING The color of the ad background |
items[].adStyle.colors.border STRING The color of the ad border |
items[].adStyle.colors.text STRING The color of the ad text |
items[].adStyle.colors.title STRING The color of the ad title |
items[].adStyle.colors.url STRING The color of the ad url |
items[].adStyle.corners STRING The style of the corners in the ad (deprecated: never populated, ignored) |
items[].adStyle.font OBJECT The font which is included in the style |
items[].adStyle.font.family STRING The family of the font |
items[].adStyle.font.size STRING The size of the font |
items[].adStyle.kind STRING Kind this is, in this case adsense#adStyle |
items[].id STRING Unique identifier of this saved ad style. 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#savedAdStyle |
items[].name STRING The user selected name of this SavedAdStyle |
kind STRING Kind of list this is, in this case adsense#savedAdStyles |
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 |