Query
|
|||||
|
|
||||
Retrieves list of report dimension values for a list of filters
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage DoubleClick for Advertisers reports
Input
This building block consumes 11 input parameters
| Name | Format | Description |
|---|---|---|
profileId Required |
INTEGER |
The DFA user profile ID |
maxResults |
INTEGER |
Maximum number of results to return |
pageToken |
STRING |
The value of the nextToken from the previous result page |
dimensionName |
STRING |
The name of the dimension for which values should be requested |
endDate |
DATE |
The end date of the date range for which to retrieve dimension values. A string of the format "yyyy-MM-dd" |
filters[] |
OBJECT |
Represents a dimension filter |
filters[].dimensionName |
STRING |
The name of the dimension to filter |
filters[].kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionFilter |
filters[].value |
STRING |
The value of the dimension to filter |
kind |
STRING |
The kind of request this is, in this case dfareporting#dimensionValueRequest |
startDate |
DATE |
The start date of the date range for which to retrieve dimension values. A string of the format "yyyy-MM-dd" |
= Parameter name
= Format
|
profileId INTEGER Required The DFA user profile ID |
|
maxResults INTEGER Maximum number of results to return |
|
pageToken STRING The value of the nextToken from the previous result page |
|
dimensionName STRING The name of the dimension for which values should be requested |
|
endDate DATE The end date of the date range for which to retrieve dimension values. A string of the format "yyyy-MM-dd" |
|
filters[] OBJECT Represents a dimension filter |
|
filters[].dimensionName STRING The name of the dimension to filter |
|
filters[].kind STRING The kind of resource this is, in this case dfareporting#dimensionFilter |
|
filters[].value STRING The value of the dimension to filter |
|
kind STRING The kind of request this is, in this case dfareporting#dimensionValueRequest |
|
startDate DATE The start date of the date range for which to retrieve dimension values. A string of the format "yyyy-MM-dd" |
Output
This building block provides 10 output parameters
| Name | Format | Description |
|---|---|---|
etag |
STRING |
The eTag of this response for caching purposes |
items[] |
OBJECT |
Represents a DimensionValue resource |
items[].dimensionName |
STRING |
The name of the dimension |
items[].etag |
STRING |
The eTag of this response for caching purposes |
items[].id |
STRING |
The ID associated with the value if available |
items[].kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
items[].matchType |
ENUMERATION |
Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
items[].value |
STRING |
The value of the dimension |
kind |
STRING |
The kind of list this is, in this case dfareporting#dimensionValueList |
nextPageToken |
STRING |
Continuation token used to page through dimension values. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted |
= Parameter name
= Format
|
etag STRING The eTag of this response for caching purposes |
|
items[] OBJECT Represents a DimensionValue resource |
|
items[].dimensionName STRING The name of the dimension |
|
items[].etag STRING The eTag of this response for caching purposes |
|
items[].id STRING The ID associated with the value if available |
|
items[].kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
items[].matchType ENUMERATION Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
|
items[].value STRING The value of the dimension |
|
kind STRING The kind of list this is, in this case dfareporting#dimensionValueList |
|
nextPageToken STRING Continuation token used to page through dimension values. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted |