The Campaign Manager 360 API v3.3 is deprecated and will be sunset on June 30th, 2021. All users must migrate to a newer API version by that date.

Method: reports.compatibleFields.query

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/v3.4/userprofiles/{profileId}/reports/compatiblefields/query

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
profileId

string (int64 format)

The Campaign Manager 360 user profile ID.

Request body

The request body contains an instance of Report.

Response body

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

Represents a response to the queryCompatibleFields method.

JSON representation
{
  "reportCompatibleFields": {
    object (ReportCompatibleFields)
  },
  "reachReportCompatibleFields": {
    object (ReachReportCompatibleFields)
  },
  "pathToConversionReportCompatibleFields": {
    object (PathToConversionReportCompatibleFields)
  },
  "crossDimensionReachReportCompatibleFields": {
    object (CrossDimensionReachReportCompatibleFields)
  },
  "floodlightReportCompatibleFields": {
    object (FloodlightReportCompatibleFields)
  },
  "pathReportCompatibleFields": {
    object (PathReportCompatibleFields)
  },
  "pathAttributionReportCompatibleFields": {
    object (PathReportCompatibleFields)
  },
  "kind": string
}
Fields
reportCompatibleFields

object (ReportCompatibleFields)

Contains items that are compatible to be selected for a report of type "STANDARD".

reachReportCompatibleFields

object (ReachReportCompatibleFields)

Contains items that are compatible to be selected for a report of type "REACH".

pathToConversionReportCompatibleFields

object (PathToConversionReportCompatibleFields)

Contains items that are compatible to be selected for a report of type "PATH_TO_CONVERSION".

crossDimensionReachReportCompatibleFields

object (CrossDimensionReachReportCompatibleFields)

Contains items that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH".

floodlightReportCompatibleFields

object (FloodlightReportCompatibleFields)

Contains items that are compatible to be selected for a report of type "FLOODLIGHT".

pathReportCompatibleFields

object (PathReportCompatibleFields)

Contains items that are compatible to be selected for a report of type "PATH".

pathAttributionReportCompatibleFields

object (PathReportCompatibleFields)

Contains items that are compatible to be selected for a report of type "PATH_ATTRIBUTION".

kind

string

The kind of resource this is, in this case

dfareporting#compatibleFields

.

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 (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dimensionFilters": [
    {
      object (Dimension)
    }
  ],
  "pivotedActivityMetrics": [
    {
      object (Metric)
    }
  ],
  "kind": string
}
Fields
dimensions[]

object (Dimension)

Dimensions which are compatible to be selected in the "dimensions" section of the report.

metrics[]

object (Metric)

Metrics which are compatible to be selected in the "metricNames" section of the report.

dimensionFilters[]

object (Dimension)

Dimensions which are compatible to be selected in the "dimensionFilters" section of the report.

pivotedActivityMetrics[]

object (Metric)

Metrics which are compatible to be selected as activity metrics to pivot on in the "activities" section of the report.

kind

string

The kind of resource this is, in this case

dfareporting#reportCompatibleFields

.

Dimension

Represents a dimension.

JSON representation
{
  "name": string,
  "kind": string
}
Fields
name

string

The dimension name, e.g. dfa:advertiser

kind

string

The kind of resource this is, in this case

dfareporting#dimension

.

Metric

Represents a metric.

JSON representation
{
  "name": string,
  "kind": string
}
Fields
name

string

The metric name, e.g. dfa:impressions

kind

string

The kind of resource this is, in this case

dfareporting#metric

.

ReachReportCompatibleFields

Represents fields that are compatible to be selected for a report of type "REACH".

JSON representation
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "reachByFrequencyMetrics": [
    {
      object (Metric)
    }
  ],
  "dimensionFilters": [
    {
      object (Dimension)
    }
  ],
  "pivotedActivityMetrics": [
    {
      object (Metric)
    }
  ],
  "kind": string
}
Fields
dimensions[]

object (Dimension)

Dimensions which are compatible to be selected in the "dimensions" section of the report.

metrics[]

object (Metric)

Metrics which are compatible to be selected in the "metricNames" section of the report.

reachByFrequencyMetrics[]

object (Metric)

Metrics which are compatible to be selected in the "reachByFrequencyMetricNames" section of the report.

dimensionFilters[]

object (Dimension)

Dimensions which are compatible to be selected in the "dimensionFilters" section of the report.

pivotedActivityMetrics[]

object (Metric)

Metrics which are compatible to be selected as activity metrics to pivot on in the "activities" section of the report.

kind

string

The kind of resource this is, in this case

dfareporting#reachReportCompatibleFields

.

PathToConversionReportCompatibleFields

Represents fields that are compatible to be selected for a report of type "PATH_TO_CONVERSION".

JSON representation
{
  "conversionDimensions": [
    {
      object (Dimension)
    }
  ],
  "perInteractionDimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "customFloodlightVariables": [
    {
      object (Dimension)
    }
  ],
  "kind": string
}
Fields
conversionDimensions[]

object (Dimension)

Conversion dimensions which are compatible to be selected in the "conversionDimensions" section of the report.

perInteractionDimensions[]

object (Dimension)

Per-interaction dimensions which are compatible to be selected in the "perInteractionDimensions" section of the report.

metrics[]

object (Metric)

Metrics which are compatible to be selected in the "metricNames" section of the report.

customFloodlightVariables[]

object (Dimension)

Custom floodlight variables which are compatible to be selected in the "customFloodlightVariables" section of the report.

kind

string

The kind of resource this is, in this case

dfareporting#pathToConversionReportCompatibleFields

.

CrossDimensionReachReportCompatibleFields

Represents fields that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH".

JSON representation
{
  "dimensionFilters": [
    {
      object (Dimension)
    }
  ],
  "breakdown": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "overlapMetrics": [
    {
      object (Metric)
    }
  ],
  "kind": string
}
Fields
dimensionFilters[]

object (Dimension)

Dimensions which are compatible to be selected in the "dimensionFilters" section of the report.

breakdown[]

object (Dimension)

Dimensions which are compatible to be selected in the "breakdown" section of the report.

metrics[]

object (Metric)

Metrics which are compatible to be selected in the "metricNames" section of the report.

overlapMetrics[]

object (Metric)

Metrics which are compatible to be selected in the "overlapMetricNames" section of the report.

kind

string

The kind of resource this is, in this case

dfareporting#crossDimensionReachReportCompatibleFields

.

FloodlightReportCompatibleFields

Represents fields that are compatible to be selected for a report of type "FlOODLIGHT".

JSON representation
{
  "dimensionFilters": [
    {
      object (Dimension)
    }
  ],
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "kind": string
}
Fields
dimensionFilters[]

object (Dimension)

Dimensions which are compatible to be selected in the "dimensionFilters" section of the report.

dimensions[]

object (Dimension)

Dimensions which are compatible to be selected in the "dimensions" section of the report.

metrics[]

object (Metric)

Metrics which are compatible to be selected in the "metricNames" section of the report.

kind

string

The kind of resource this is, in this case

dfareporting#floodlightReportCompatibleFields

.

PathReportCompatibleFields

Represents fields that are compatible to be selected for a report of type "PATH".

JSON representation
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "pathFilters": [
    {
      object (Dimension)
    }
  ],
  "channelGroupings": [
    {
      object (Dimension)
    }
  ],
  "kind": string
}
Fields
dimensions[]

object (Dimension)

Dimensions which are compatible to be selected in the "dimensions" section of the report.

metrics[]

object (Metric)

Metrics which are compatible to be selected in the "metricNames" section of the report.

pathFilters[]

object (Dimension)

Dimensions which are compatible to be selected in the "pathFilters" section of the report.

channelGroupings[]

object (Dimension)

Dimensions which are compatible to be selected in the "channelGroupings" section of the report.

kind

string

The kind of resource this is, in this case

dfareporting#pathReportCompatibleFields

.