DimensionValues: query

Requires authorization

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

Request

HTTP request

POST https://www.googleapis.com/dfareporting/v2.8/userprofiles/profileId/dimensionvalues/query

Parameters

Parameter name Value Description
Path parameters
profileId long The DFA user profile ID.
Optional query parameters
maxResults integer Maximum number of results to return. Acceptable values are 0 to 100, inclusive. (Default: 100)
pageToken string The value of the nextToken from the previous result page.

Authorization

This request requires authorization with the following scope (read more about authentication and authorization).

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

Request body

In the request body, supply data with the following structure:

{
  "kind": "dfareporting#dimensionValueRequest",
  "dimensionName": string,
  "startDate": date,
  "endDate": date,
  "filters": [
    {
      "kind": "dfareporting#dimensionFilter",
      "dimensionName": string,
      "value": string
    }
  ]
}
Property name Value Description Notes
kind string The kind of request this is, in this case dfareporting#dimensionValueRequest.
dimensionName string The name of the dimension for which values should be requested. writable
startDate date The start date of the date range for which to retrieve dimension values. A string of the format "yyyy-MM-dd". writable
endDate date The end date of the date range for which to retrieve dimension values. A string of the format "yyyy-MM-dd". writable
filters[] list The list of filters by which to filter values. The filters are ANDed. writable
filters[].kind string The kind of resource this is, in this case dfareporting#dimensionFilter.
filters[].dimensionName string The name of the dimension to filter.
filters[].value string The value of the dimension to filter.

Response

If successful, this method returns a response body with the following structure:

{
  "kind": "dfareporting#dimensionValueList",
  "etag": etag,
  "nextPageToken": string,
  "items": [
    dimensionValues Resource
  ]
}
Property name Value Description Notes
kind string The kind of list this is, in this case dfareporting#dimensionValueList.
etag etag 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.
items[] list The dimension values returned in this response.

Send feedback about...

DoubleClick Campaign Manager
DoubleClick Campaign Manager