- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- ReportCompatibleFields
- Dimension
- Metric
- ReachReportCompatibleFields
- PathToConversionReportCompatibleFields
- CrossDimensionReachReportCompatibleFields
- FloodlightReportCompatibleFields
- Try it!
Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions.
HTTP request
POST https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/reports/compatiblefields/query
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
profileId |
The Campaign Manager 360 user profile ID. |
Request body
The request body contains an instance of Report
.
Response body
Represents a response to the queryCompatibleFields method.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "reportCompatibleFields": { object ( |
Fields | |
---|---|
reportCompatibleFields |
Contains items that are compatible to be selected for a report of type "STANDARD". |
reachReportCompatibleFields |
Contains items that are compatible to be selected for a report of type "REACH". |
pathToConversionReportCompatibleFields |
Contains items that are compatible to be selected for a report of type "PATH_TO_CONVERSION". |
crossDimensionReachReportCompatibleFields |
Contains items that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH". |
floodlightReportCompatibleFields |
Contains items that are compatible to be selected for a report of type "FLOODLIGHT". |
kind |
The kind of resource this is, in this case
. |
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/dfareporting
ReportCompatibleFields
Represents fields that are compatible to be selected for a report of type "STANDARD".
JSON representation |
---|
{ "dimensions": [ { object ( |
Fields | |
---|---|
dimensions[] |
Dimensions which are compatible to be selected in the "dimensions" section of the report. |
metrics[] |
Metrics which are compatible to be selected in the "metricNames" section of the report. |
dimensionFilters[] |
Dimensions which are compatible to be selected in the "dimensionFilters" section of the report. |
pivotedActivityMetrics[] |
Metrics which are compatible to be selected as activity metrics to pivot on in the "activities" section of the report. |
kind |
The kind of resource this is, in this case
. |
Dimension
Represents a dimension.
JSON representation |
---|
{ "name": string, "kind": string } |
Fields | |
---|---|
name |
The dimension name, e.g. advertiser |
kind |
The kind of resource this is, in this case
. |
Metric
Represents a metric.
JSON representation |
---|
{ "name": string, "kind": string } |
Fields | |
---|---|
name |
The metric name, e.g. impressions |
kind |
The kind of resource this is, in this case
. |
ReachReportCompatibleFields
Represents fields that are compatible to be selected for a report of type "REACH".
JSON representation |
---|
{ "dimensions": [ { object ( |
Fields | |
---|---|
dimensions[] |
Dimensions which are compatible to be selected in the "dimensions" section of the report. |
metrics[] |
Metrics which are compatible to be selected in the "metricNames" section of the report. |
reachByFrequencyMetrics[] |
Metrics which are compatible to be selected in the "reachByFrequencyMetricNames" section of the report. |
dimensionFilters[] |
Dimensions which are compatible to be selected in the "dimensionFilters" section of the report. |
pivotedActivityMetrics[] |
Metrics which are compatible to be selected as activity metrics to pivot on in the "activities" section of the report. |
kind |
The kind of resource this is, in this case
. |
PathToConversionReportCompatibleFields
Represents fields that are compatible to be selected for a report of type "PATH_TO_CONVERSION".
JSON representation |
---|
{ "conversionDimensions": [ { object ( |
Fields | |
---|---|
conversionDimensions[] |
Conversion dimensions which are compatible to be selected in the "conversionDimensions" section of the report. |
perInteractionDimensions[] |
Per-interaction dimensions which are compatible to be selected in the "perInteractionDimensions" section of the report. |
metrics[] |
Metrics which are compatible to be selected in the "metricNames" section of the report. |
customFloodlightVariables[] |
Custom floodlight variables which are compatible to be selected in the "customFloodlightVariables" section of the report. |
kind |
The kind of resource this is, in this case
. |
CrossDimensionReachReportCompatibleFields
Represents fields that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH".
JSON representation |
---|
{ "dimensionFilters": [ { object ( |
Fields | |
---|---|
dimensionFilters[] |
Dimensions which are compatible to be selected in the "dimensionFilters" section of the report. |
breakdown[] |
Dimensions which are compatible to be selected in the "breakdown" section of the report. |
metrics[] |
Metrics which are compatible to be selected in the "metricNames" section of the report. |
overlapMetrics[] |
Metrics which are compatible to be selected in the "overlapMetricNames" section of the report. |
kind |
The kind of resource this is, in this case
. |
FloodlightReportCompatibleFields
Represents fields that are compatible to be selected for a report of type "FlOODLIGHT".
JSON representation |
---|
{ "dimensionFilters": [ { object ( |
Fields | |
---|---|
dimensionFilters[] |
Dimensions which are compatible to be selected in the "dimensionFilters" section of the report. |
dimensions[] |
Dimensions which are compatible to be selected in the "dimensions" section of the report. |
metrics[] |
Metrics which are compatible to be selected in the "metricNames" section of the report. |
kind |
The kind of resource this is, in this case
. |