Retrieves list of report dimension values for a list of filters.
HTTP request
POST https://dfareporting.googleapis.com/dfareporting/v3.4/userprofiles/{profileId}/dimensionvalues/query
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
profileId |
The Campaign Manager 360 user profile ID. |
Query parameters
Parameters | |
---|---|
maxResults |
Maximum number of results to return. |
pageToken |
The value of the nextToken from the previous result page. |
Request body
The request body contains an instance of DimensionValueRequest
.
Response body
If successful, the response body contains data with the following structure:
Represents the list of DimensionValue resources.
JSON representation | |
---|---|
{
"items": [
{
object ( |
Fields | |
---|---|
items[] |
The dimension values returned in this response. |
kind |
The kind of list this is, in this case
. |
etag |
The eTag of this response for caching purposes. |
nextPageToken |
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. |
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/dfareporting
DimensionValueRequest
Represents a DimensionValuesRequest.
JSON representation | |
---|---|
{
"dimensionName": string,
"filters": [
{
object ( |
Fields | |
---|---|
dimensionName |
The name of the dimension for which values should be requested. |
filters[] |
The list of filters by which to filter values. The filters are ANDed. |
startDate |
The start date of the date range for which to retrieve dimension values. A string of the format
. |
endDate |
The end date of the date range for which to retrieve dimension values. A string of the format
. |
kind |
The kind of request this is, in this case
. |
DimensionFilter
Represents a dimension filter.
JSON representation | |
---|---|
{ "dimensionName": string, "value": string, "kind": string } |
Fields | |
---|---|
dimensionName |
The name of the dimension to filter. |
value |
The value of the dimension to filter. |
kind |
The kind of resource this is, in this case
. |