Reports.compatibleFields: query

Requires authorization

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. Try it now.

Request

HTTP request

POST https://www.googleapis.com/dfareporting/v3.2/userprofiles/profileId/reports/compatiblefields/query

Parameters

Parameter name	Value	Description
Path parameters
`profileId`	`long`	The DFA user profile ID.

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 a Reports.compatibleFields resource.

Response

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

{
  "kind": "dfareporting#compatibleFields",
  "reportCompatibleFields": {
    "kind": "dfareporting#reportCompatibleFields",
    "dimensions": [
      {
        "kind": "dfareporting#dimension",
        "name": string
      }
    ],
    "metrics": [
      {
        "kind": "dfareporting#metric",
        "name": string
      }
    ],
    "dimensionFilters": [
      {
        "kind": "dfareporting#dimension",
        "name": string
      }
    ],
    "pivotedActivityMetrics": [
      {
        "kind": "dfareporting#metric",
        "name": string
      }
    ]
  },
  "reachReportCompatibleFields": {
    "kind": "dfareporting#reachReportCompatibleFields",
    "dimensions": [
      {
        "kind": "dfareporting#dimension",
        "name": string
      }
    ],
    "metrics": [
      {
        "kind": "dfareporting#metric",
        "name": string
      }
    ],
    "reachByFrequencyMetrics": [
      {
        "kind": "dfareporting#metric",
        "name": string
      }
    ],
    "dimensionFilters": [
      {
        "kind": "dfareporting#dimension",
        "name": string
      }
    ],
    "pivotedActivityMetrics": [
      {
        "kind": "dfareporting#metric",
        "name": string
      }
    ]
  },
  "pathToConversionReportCompatibleFields": {
    "kind": "dfareporting#pathToConversionReportCompatibleFields",
    "conversionDimensions": [
      {
        "kind": "dfareporting#dimension",
        "name": string
      }
    ],
    "perInteractionDimensions": [
      {
        "kind": "dfareporting#dimension",
        "name": string
      }
    ],
    "metrics": [
      {
        "kind": "dfareporting#metric",
        "name": string
      }
    ],
    "customFloodlightVariables": [
      {
        "kind": "dfareporting#dimension",
        "name": string
      }
    ]
  },
  "crossDimensionReachReportCompatibleFields": {
    "kind": "dfareporting#crossDimensionReachReportCompatibleFields",
    "breakdown": [
      {
        "kind": "dfareporting#dimension",
        "name": string
      }
    ],
    "metrics": [
      {
        "kind": "dfareporting#metric",
        "name": string
      }
    ],
    "overlapMetrics": [
      {
        "kind": "dfareporting#metric",
        "name": string
      }
    ],
    "dimensionFilters": [
      {
        "kind": "dfareporting#dimension",
        "name": string
      }
    ]
  },
  "floodlightReportCompatibleFields": {
    "kind": "dfareporting#floodlightReportCompatibleFields",
    "dimensions": [
      {
        "kind": "dfareporting#dimension",
        "name": string
      }
    ],
    "metrics": [
      {
        "kind": "dfareporting#metric",
        "name": string
      }
    ],
    "dimensionFilters": [
      {
        "kind": "dfareporting#dimension",
        "name": string
      }
    ]
  }
}

Property name	Value	Description
`kind`	`string`	The kind of resource this is, in this case `dfareporting#compatibleFields`.
`reportCompatibleFields`	`nested object`	Contains items that are compatible to be selected for a report of type "STANDARD".
`reportCompatibleFields.kind`	`string`	The kind of resource this is, in this case `dfareporting#reportCompatibleFields`.
`reportCompatibleFields.dimensions[]`	`list`	Dimensions which are compatible to be selected in the "dimensions" section of the report.
`reportCompatibleFields.dimensions[].kind`	`string`	The kind of resource this is, in this case `dfareporting#dimension`.
`reportCompatibleFields.dimensions[].name`	`string`	The dimension name, e.g. dfa:advertiser
`reportCompatibleFields.metrics[]`	`list`	Metrics which are compatible to be selected in the "metricNames" section of the report.
`reportCompatibleFields.metrics[].kind`	`string`	The kind of resource this is, in this case `dfareporting#metric`.
`reportCompatibleFields.metrics[].name`	`string`	The metric name, e.g. dfa:impressions
`reportCompatibleFields.dimensionFilters[]`	`list`	Dimensions which are compatible to be selected in the "dimensionFilters" section of the report.
`reportCompatibleFields.dimensionFilters[].kind`	`string`	The kind of resource this is, in this case `dfareporting#dimension`.
`reportCompatibleFields.dimensionFilters[].name`	`string`	The dimension name, e.g. dfa:advertiser
`reportCompatibleFields.pivotedActivityMetrics[]`	`list`	Metrics which are compatible to be selected as activity metrics to pivot on in the "activities" section of the report.
`reportCompatibleFields.pivotedActivityMetrics[].kind`	`string`	The kind of resource this is, in this case `dfareporting#metric`.
`reportCompatibleFields.pivotedActivityMetrics[].name`	`string`	The metric name, e.g. dfa:impressions
`reachReportCompatibleFields`	`nested object`	Contains items that are compatible to be selected for a report of type "REACH".
`reachReportCompatibleFields.kind`	`string`	The kind of resource this is, in this case `dfareporting#reachReportCompatibleFields`.
`reachReportCompatibleFields.dimensions[]`	`list`	Dimensions which are compatible to be selected in the "dimensions" section of the report.
`reachReportCompatibleFields.dimensions[].kind`	`string`	The kind of resource this is, in this case `dfareporting#dimension`.
`reachReportCompatibleFields.dimensions[].name`	`string`	The dimension name, e.g. dfa:advertiser
`reachReportCompatibleFields.metrics[]`	`list`	Metrics which are compatible to be selected in the "metricNames" section of the report.
`reachReportCompatibleFields.metrics[].kind`	`string`	The kind of resource this is, in this case `dfareporting#metric`.
`reachReportCompatibleFields.metrics[].name`	`string`	The metric name, e.g. dfa:impressions
`reachReportCompatibleFields.reachByFrequencyMetrics[]`	`list`	Metrics which are compatible to be selected in the "reachByFrequencyMetricNames" section of the report.
`reachReportCompatibleFields.reachByFrequencyMetrics[].kind`	`string`	The kind of resource this is, in this case `dfareporting#metric`.
`reachReportCompatibleFields.reachByFrequencyMetrics[].name`	`string`	The metric name, e.g. dfa:impressions
`reachReportCompatibleFields.dimensionFilters[]`	`list`	Dimensions which are compatible to be selected in the "dimensionFilters" section of the report.
`reachReportCompatibleFields.dimensionFilters[].kind`	`string`	The kind of resource this is, in this case `dfareporting#dimension`.
`reachReportCompatibleFields.dimensionFilters[].name`	`string`	The dimension name, e.g. dfa:advertiser
`reachReportCompatibleFields.pivotedActivityMetrics[]`	`list`	Metrics which are compatible to be selected as activity metrics to pivot on in the "activities" section of the report.
`reachReportCompatibleFields.pivotedActivityMetrics[].kind`	`string`	The kind of resource this is, in this case `dfareporting#metric`.
`reachReportCompatibleFields.pivotedActivityMetrics[].name`	`string`	The metric name, e.g. dfa:impressions
`pathToConversionReportCompatibleFields`	`nested object`	Contains items that are compatible to be selected for a report of type "PATH_TO_CONVERSION".
`pathToConversionReportCompatibleFields.kind`	`string`	The kind of resource this is, in this case `dfareporting#pathToConversionReportCompatibleFields`.
`pathToConversionReportCompatibleFields.conversionDimensions[]`	`list`	Conversion dimensions which are compatible to be selected in the "conversionDimensions" section of the report.
`pathToConversionReportCompatibleFields.conversionDimensions[].kind`	`string`	The kind of resource this is, in this case `dfareporting#dimension`.
`pathToConversionReportCompatibleFields.conversionDimensions[].name`	`string`	The dimension name, e.g. dfa:advertiser
`pathToConversionReportCompatibleFields.perInteractionDimensions[]`	`list`	Per-interaction dimensions which are compatible to be selected in the "perInteractionDimensions" section of the report.
`pathToConversionReportCompatibleFields.perInteractionDimensions[].kind`	`string`	The kind of resource this is, in this case `dfareporting#dimension`.
`pathToConversionReportCompatibleFields.perInteractionDimensions[].name`	`string`	The dimension name, e.g. dfa:advertiser
`pathToConversionReportCompatibleFields.metrics[]`	`list`	Metrics which are compatible to be selected in the "metricNames" section of the report.
`pathToConversionReportCompatibleFields.metrics[].kind`	`string`	The kind of resource this is, in this case `dfareporting#metric`.
`pathToConversionReportCompatibleFields.metrics[].name`	`string`	The metric name, e.g. dfa:impressions
`pathToConversionReportCompatibleFields.customFloodlightVariables[]`	`list`	Custom floodlight variables which are compatible to be selected in the "customFloodlightVariables" section of the report.
`pathToConversionReportCompatibleFields.customFloodlightVariables[].kind`	`string`	The kind of resource this is, in this case `dfareporting#dimension`.
`pathToConversionReportCompatibleFields.customFloodlightVariables[].name`	`string`	The dimension name, e.g. dfa:advertiser
`crossDimensionReachReportCompatibleFields`	`nested object`	Contains items that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH".
`crossDimensionReachReportCompatibleFields.kind`	`string`	The kind of resource this is, in this case `dfareporting#crossDimensionReachReportCompatibleFields`.
`crossDimensionReachReportCompatibleFields.breakdown[]`	`list`	Dimensions which are compatible to be selected in the "breakdown" section of the report.
`crossDimensionReachReportCompatibleFields.breakdown[].kind`	`string`	The kind of resource this is, in this case `dfareporting#dimension`.
`crossDimensionReachReportCompatibleFields.breakdown[].name`	`string`	The dimension name, e.g. dfa:advertiser
`crossDimensionReachReportCompatibleFields.metrics[]`	`list`	Metrics which are compatible to be selected in the "metricNames" section of the report.
`crossDimensionReachReportCompatibleFields.metrics[].kind`	`string`	The kind of resource this is, in this case `dfareporting#metric`.
`crossDimensionReachReportCompatibleFields.metrics[].name`	`string`	The metric name, e.g. dfa:impressions
`crossDimensionReachReportCompatibleFields.overlapMetrics[]`	`list`	Metrics which are compatible to be selected in the "overlapMetricNames" section of the report.
`crossDimensionReachReportCompatibleFields.overlapMetrics[].kind`	`string`	The kind of resource this is, in this case `dfareporting#metric`.
`crossDimensionReachReportCompatibleFields.overlapMetrics[].name`	`string`	The metric name, e.g. dfa:impressions
`crossDimensionReachReportCompatibleFields.dimensionFilters[]`	`list`	Dimensions which are compatible to be selected in the "dimensionFilters" section of the report.
`crossDimensionReachReportCompatibleFields.dimensionFilters[].kind`	`string`	The kind of resource this is, in this case `dfareporting#dimension`.
`crossDimensionReachReportCompatibleFields.dimensionFilters[].name`	`string`	The dimension name, e.g. dfa:advertiser
`floodlightReportCompatibleFields`	`nested object`	Contains items that are compatible to be selected for a report of type "FLOODLIGHT".
`floodlightReportCompatibleFields.kind`	`string`	The kind of resource this is, in this case `dfareporting#floodlightReportCompatibleFields`.
`floodlightReportCompatibleFields.dimensions[]`	`list`	Dimensions which are compatible to be selected in the "dimensions" section of the report.
`floodlightReportCompatibleFields.dimensions[].kind`	`string`	The kind of resource this is, in this case `dfareporting#dimension`.
`floodlightReportCompatibleFields.dimensions[].name`	`string`	The dimension name, e.g. dfa:advertiser
`floodlightReportCompatibleFields.metrics[]`	`list`	Metrics which are compatible to be selected in the "metricNames" section of the report.
`floodlightReportCompatibleFields.metrics[].kind`	`string`	The kind of resource this is, in this case `dfareporting#metric`.
`floodlightReportCompatibleFields.metrics[].name`	`string`	The metric name, e.g. dfa:impressions
`floodlightReportCompatibleFields.dimensionFilters[]`	`list`	Dimensions which are compatible to be selected in the "dimensionFilters" section of the report.
`floodlightReportCompatibleFields.dimensionFilters[].kind`	`string`	The kind of resource this is, in this case `dfareporting#dimension`.
`floodlightReportCompatibleFields.dimensionFilters[].name`	`string`	The dimension name, e.g. dfa:advertiser

Try it!

Use the APIs Explorer below to call this method on live data and see the response.