Method: dimensionValues.query

  • This page describes how to retrieve a list of report dimension values based on a list of filters.

  • The request is made using a POST HTTP request to a specified URL, which includes a profile ID as a path parameter.

  • Optional query parameters like maxResults and pageToken can be used to control the number of results and page through the data.

  • The request body requires a DimensionValueRequest object, which specifies the dimension name, filters, and a date range.

  • The response body contains a list of DimensionValue resources along with pagination information.

Retrieves list of report dimension values for a list of filters.

HTTP request

POST https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/dimensionvalues/query

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
profileId

string (int64 format)

The Campaign Manager 360 user profile ID.

Query parameters

Parameters
maxResults

integer

Maximum number of results to return.
pageToken

string

The value of the nextToken from the previous result page.

Request body

The request body contains an instance of DimensionValueRequest.

Response body

Represents the list of DimensionValue resources.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "items": [
    {
      object (DimensionValue)
    }
  ],
  "kind": string,
  "etag": string,
  "nextPageToken": string
}
Fields
items[]

object (DimensionValue)

The dimension values returned in this response.
kind

string

The kind of list this is, in this case

dfareporting#dimensionValueList

.
etag

string

The eTag of this response for caching purposes.
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.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/dfareporting

DimensionValueRequest

Represents a DimensionValuesRequest.

JSON representation 
{
  "dimensionName": string,
  "filters": [
    {
      object (DimensionFilter)
    }
  ],
  "startDate": string,
  "endDate": string,
  "kind": string
}
Fields
dimensionName

string

The name of the dimension for which values should be requested.
filters[]

object (DimensionFilter)

The list of filters by which to filter values. The filters are ANDed.
startDate

string

The start date of the date range for which to retrieve dimension values. A string of the format

"yyyy-MM-dd"

.
endDate

string

The end date of the date range for which to retrieve dimension values. A string of the format

"yyyy-MM-dd"

.
kind

string

The kind of request this is, in this case

dfareporting#dimensionValueRequest

.

DimensionFilter

Represents a dimension filter.

JSON representation 
{
  "dimensionName": string,
  "value": string,
  "kind": string
}
Fields
dimensionName

string

The name of the dimension to filter.
value

string

The value of the dimension to filter.
kind

string

The kind of resource this is, in this case

dfareporting#dimensionFilter

.