Method: dimensionValues.query
Stay organized with collections
Save and categorize content based on your preferences.
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
.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-16 UTC.
[null,null,["Last updated 2024-10-16 UTC."],[[["\u003cp\u003eRetrieves a list of report dimension values for specified filters within a Campaign Manager 360 user profile.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering by dimension name, date range, and additional filters using a POST request.\u003c/p\u003e\n"],["\u003cp\u003eResults are paginated and include dimension values, kind, eTag, and a token for retrieving the next page.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/dfareporting\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eProvides details on the request and response body structure, including JSON representations.\u003c/p\u003e\n"]]],[],null,["# Method: dimensionValues.query\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.DimensionValueList.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [DimensionValueRequest](#DimensionValueRequest)\n - [JSON representation](#DimensionValueRequest.SCHEMA_REPRESENTATION)\n- [DimensionFilter](#DimensionFilter)\n - [JSON representation](#DimensionFilter.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\nRetrieves list of report dimension values for a list of filters.\n\n### HTTP request\n\n`POST https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/dimensionvalues/query`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|---------------|-------------------------------------------------------------------------------------------------------------------------------|\n| `profile``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The Campaign Manager 360 user profile ID. |\n\n### Query parameters\n\n| Parameters ||\n|----------------|--------------------------------------------------------------------|\n| `max``Results` | `integer` Maximum number of results to return. |\n| `page``Token` | `string` The value of the nextToken from the previous result page. |\n\n### Request body\n\nThe request body contains an instance of [DimensionValueRequest](/doubleclick-advertisers/rest/v4/dimensionValues/query#DimensionValueRequest).\n\n### Response body\n\nRepresents the list of DimensionValue resources.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"items\": [ { object (/doubleclick-advertisers/rest/v4/DimensionValue) } ], \"kind\": string, \"etag\": string, \"nextPageToken\": string } ``` |\n\n| Fields ||\n|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `items[]` | `object (`[DimensionValue](/doubleclick-advertisers/rest/v4/DimensionValue)`)` The dimension values returned in this response. |\n| `kind` | `string` The kind of list this is, in this case `dfareporting#dimensionValueList` . |\n| `etag` | `string` The eTag of this response for caching purposes. |\n| `next``Page``Token` | `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. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/dfareporting`\n\nDimensionValueRequest\n---------------------\n\nRepresents a DimensionValuesRequest.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"dimensionName\": string, \"filters\": [ { object (/doubleclick-advertisers/rest/v4/dimensionValues/query#DimensionFilter) } ], \"startDate\": string, \"endDate\": string, \"kind\": string } ``` |\n\n| Fields ||\n|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `dimension``Name` | `string` The name of the dimension for which values should be requested. |\n| `filters[]` | `object (`[DimensionFilter](/doubleclick-advertisers/rest/v4/dimensionValues/query#DimensionFilter)`)` The list of filters by which to filter values. The filters are ANDed. |\n| `start``Date` | `string` The start date of the date range for which to retrieve dimension values. A string of the format `\"yyyy-MM-dd\"` . |\n| `end``Date` | `string` The end date of the date range for which to retrieve dimension values. A string of the format `\"yyyy-MM-dd\"` . |\n| `kind` | `string` The kind of request this is, in this case `dfareporting#dimensionValueRequest` . |\n\nDimensionFilter\n---------------\n\nRepresents a dimension filter.\n\n| JSON representation |\n|----------------------------------------------------------------------|\n| ``` { \"dimensionName\": string, \"value\": string, \"kind\": string } ``` |\n\n| Fields ||\n|-------------------|--------------------------------------------------------------------------------------|\n| `dimension``Name` | `string` The name of the dimension to filter. |\n| `value` | `string` The value of the dimension to filter. |\n| `kind` | `string` The kind of resource this is, in this case `dfareporting#dimensionFilter` . |"]]
