A API Campaign Manager 360 v3.4 foi descontinuada e será desativada em 24 de dezembro de 2021. Até essa data, todos os usuários precisam migrar para uma versão mais recente da API.

Reports.compatibleFields: query

Retorna os campos que são compatíveis para serem selecionados nas seções respectivas dos critérios de um relatório. Isso é feito de acordo com os campos de relatório de entrada e de permissões do usuário já selecionados. Teste agora.

Solicitação

Solicitação HTTP

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

Parâmetros

Nome do parâmetro Valor Descrição
Parâmetros de caminho
profileId long É o ID do perfil do usuário do Campaign Manager 360.

Autorização

Esta solicitação requer autorização com o seguinte escopo:

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

Para mais informações, consulte a página de autenticação e autorização.

Corpo da solicitação

No corpo da solicitação, forneça um recurso Reports.compatibleFields.

Resposta

Se for bem-sucedido, esse método retornará um corpo de resposta com esta estrutura:

{
  "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
      }
    ]
  },
  "pathReportCompatibleFields": {
    "kind": "dfareporting#pathReportCompatibleFields",
    "dimensions": [
      {
        "kind": "dfareporting#dimension",
        "name": string
      }
    ],
    "metrics": [
      {
        "kind": "dfareporting#metric",
        "name": string
      }
    ],
    "pathFilters": [
      {
        "kind": "dfareporting#dimension",
        "name": string
      }
    ],
    "channelGroupings": [
      {
        "kind": "dfareporting#dimension",
        "name": string
      }
    ]
  },
  "pathAttributionReportCompatibleFields": {
    "kind": "dfareporting#pathReportCompatibleFields",
    "dimensions": [
      {
        "kind": "dfareporting#dimension",
        "name": string
      }
    ],
    "metrics": [
      {
        "kind": "dfareporting#metric",
        "name": string
      }
    ],
    "pathFilters": [
      {
        "kind": "dfareporting#dimension",
        "name": string
      }
    ],
    "channelGroupings": [
      {
        "kind": "dfareporting#dimension",
        "name": string
      }
    ]
  }
}
Nome da propriedade Valor Descrição Observações
kind string É o tipo de recurso. Neste caso, dfareporting#compatibleFields.
reportCompatibleFields nested object Contém itens que são compatíveis para serem selecionados para um relatório do tipo "STANDARD".
reportCompatibleFields.kind string É o tipo de recurso. Neste caso, dfareporting#reportCompatibleFields.
reportCompatibleFields.dimensions[] list São as dimensões compatíveis para serem selecionadas na seção "dimensions" do relatório.
reportCompatibleFields.dimensions[].kind string É o tipo de recurso. Neste caso, dfareporting#dimension.
reportCompatibleFields.dimensions[].name string É o nome da dimensão. Por exemplo, dfa:advertiser.
reportCompatibleFields.metrics[] list São as métricas compatíveis para serem selecionadas na seção "metricNames" do relatório.
reportCompatibleFields.metrics[].kind string É o tipo de recurso. Neste caso, dfareporting#metric.
reportCompatibleFields.metrics[].name string É o nome da métrica. Por exemplo, dfa:impressions.
reportCompatibleFields.dimensionFilters[] list São as dimensões compatíveis para serem selecionadas na seção "dimensionFilters" do relatório.
reportCompatibleFields.dimensionFilters[].kind string É o tipo de recurso. Neste caso, dfareporting#dimension.
reportCompatibleFields.dimensionFilters[].name string É o nome da dimensão. Por exemplo, dfa:advertiser.
reportCompatibleFields.pivotedActivityMetrics[] list São as métricas compatíveis para serem selecionadas nas métricas de atividade a fim de dinamizar na seção "activities" do relatório.
reportCompatibleFields.pivotedActivityMetrics[].kind string É o tipo de recurso. Neste caso, dfareporting#metric.
reportCompatibleFields.pivotedActivityMetrics[].name string É o nome da métrica. Por exemplo, dfa:impressions.
reachReportCompatibleFields nested object Contém itens que são compatíveis para serem selecionados para um relatório do tipo "REACH".
reachReportCompatibleFields.kind string É o tipo de recurso. Neste caso, dfareporting#reachReportCompatibleFields.
reachReportCompatibleFields.dimensions[] list São as dimensões compatíveis para serem selecionadas na seção "dimensions" do relatório.
reachReportCompatibleFields.dimensions[].kind string É o tipo de recurso. Neste caso, dfareporting#dimension.
reachReportCompatibleFields.dimensions[].name string É o nome da dimensão. Por exemplo, dfa:advertiser.
reachReportCompatibleFields.metrics[] list São as métricas compatíveis para serem selecionadas na seção "metricNames" do relatório.
reachReportCompatibleFields.metrics[].kind string É o tipo de recurso. Neste caso, dfareporting#metric.
reachReportCompatibleFields.metrics[].name string É o nome da métrica. Por exemplo, dfa:impressions.
reachReportCompatibleFields.reachByFrequencyMetrics[] list São as métricas compatíveis para serem selecionadas na seção "reachByFrequencyMetricNames" do relatório.
reachReportCompatibleFields.reachByFrequencyMetrics[].kind string É o tipo de recurso. Neste caso, dfareporting#metric.
reachReportCompatibleFields.reachByFrequencyMetrics[].name string É o nome da métrica. Por exemplo, dfa:impressions.
reachReportCompatibleFields.dimensionFilters[] list São as dimensões compatíveis para serem selecionadas na seção "dimensionFilters" do relatório.
reachReportCompatibleFields.dimensionFilters[].kind string É o tipo de recurso. Neste caso, dfareporting#dimension.
reachReportCompatibleFields.dimensionFilters[].name string É o nome da dimensão. Por exemplo, dfa:advertiser.
reachReportCompatibleFields.pivotedActivityMetrics[] list São as métricas compatíveis para serem selecionadas nas métricas de atividade a fim de dinamizar na seção "activities" do relatório.
reachReportCompatibleFields.pivotedActivityMetrics[].kind string É o tipo de recurso. Neste caso, dfareporting#metric.
reachReportCompatibleFields.pivotedActivityMetrics[].name string É o nome da métrica. Por exemplo, dfa:impressions.
pathToConversionReportCompatibleFields nested object Contém itens que são compatíveis para serem selecionados para um relatório do tipo "PATH_TO_CONVERSION".
pathToConversionReportCompatibleFields.kind string É o tipo de recurso. Neste caso, dfareporting#pathToConversionReportCompatibleFields.
pathToConversionReportCompatibleFields.conversionDimensions[] list São as dimensões de conversão compatíveis para serem selecionadas na seção "conversionDimensions" do relatório.
pathToConversionReportCompatibleFields.conversionDimensions[].kind string É o tipo de recurso. Neste caso, dfareporting#dimension.
pathToConversionReportCompatibleFields.conversionDimensions[].name string É o nome da dimensão. Por exemplo, dfa:advertiser.
pathToConversionReportCompatibleFields.perInteractionDimensions[] list São as dimensões por interação compatíveis para serem selecionadas na seção "perInteractionDimensions" do relatório.
pathToConversionReportCompatibleFields.perInteractionDimensions[].kind string É o tipo de recurso. Neste caso, dfareporting#dimension.
pathToConversionReportCompatibleFields.perInteractionDimensions[].name string É o nome da dimensão. Por exemplo, dfa:advertiser.
pathToConversionReportCompatibleFields.metrics[] list São as métricas compatíveis para serem selecionadas na seção "metricNames" do relatório.
pathToConversionReportCompatibleFields.metrics[].kind string É o tipo de recurso. Neste caso, dfareporting#metric.
pathToConversionReportCompatibleFields.metrics[].name string É o nome da métrica. Por exemplo, dfa:impressions.
pathToConversionReportCompatibleFields.customFloodlightVariables[] list São as variáveis do Floodlight personalizadas compatíveis para serem selecionadas na seção "customFloodlightVariables" do relatório.
pathToConversionReportCompatibleFields.customFloodlightVariables[].kind string É o tipo de recurso. Neste caso, dfareporting#dimension.
pathToConversionReportCompatibleFields.customFloodlightVariables[].name string É o nome da dimensão. Por exemplo, dfa:advertiser.
crossDimensionReachReportCompatibleFields nested object Contém itens que são compatíveis para serem selecionados para um relatório do tipo "CROSS_DIMENSION_REACH".
crossDimensionReachReportCompatibleFields.kind string É o tipo de recurso. Neste caso, dfareporting#crossDimensionReachReportCompatibleFields.
crossDimensionReachReportCompatibleFields.breakdown[] list São as dimensões compatíveis para serem selecionadas na seção "breakdown" do relatório.
crossDimensionReachReportCompatibleFields.breakdown[].kind string É o tipo de recurso. Neste caso, dfareporting#dimension.
crossDimensionReachReportCompatibleFields.breakdown[].name string É o nome da dimensão. Por exemplo, dfa:advertiser.
crossDimensionReachReportCompatibleFields.metrics[] list São as métricas compatíveis para serem selecionadas na seção "metricNames" do relatório.
crossDimensionReachReportCompatibleFields.metrics[].kind string É o tipo de recurso. Neste caso, dfareporting#metric.
crossDimensionReachReportCompatibleFields.metrics[].name string É o nome da métrica. Por exemplo, dfa:impressions.
crossDimensionReachReportCompatibleFields.overlapMetrics[] list São as métricas compatíveis para serem selecionadas na seção "overlapMetricNames" do relatório.
crossDimensionReachReportCompatibleFields.overlapMetrics[].kind string É o tipo de recurso. Neste caso, dfareporting#metric.
crossDimensionReachReportCompatibleFields.overlapMetrics[].name string É o nome da métrica. Por exemplo, dfa:impressions.
crossDimensionReachReportCompatibleFields.dimensionFilters[] list São as dimensões compatíveis para serem selecionadas na seção "dimensionFilters" do relatório.
crossDimensionReachReportCompatibleFields.dimensionFilters[].kind string É o tipo de recurso. Neste caso, dfareporting#dimension.
crossDimensionReachReportCompatibleFields.dimensionFilters[].name string É o nome da dimensão. Por exemplo, dfa:advertiser.
floodlightReportCompatibleFields nested object Contém itens que são compatíveis para serem selecionados para um relatório do tipo "FLOODLIGHT".
floodlightReportCompatibleFields.kind string É o tipo de recurso. Neste caso, dfareporting#floodlightReportCompatibleFields.
floodlightReportCompatibleFields.dimensions[] list São as dimensões compatíveis para serem selecionadas na seção "dimensions" do relatório.
floodlightReportCompatibleFields.dimensions[].kind string É o tipo de recurso. Neste caso, dfareporting#dimension.
floodlightReportCompatibleFields.dimensions[].name string É o nome da dimensão. Por exemplo, dfa:advertiser.
floodlightReportCompatibleFields.metrics[] list São as métricas compatíveis para serem selecionadas na seção "metricNames" do relatório.
floodlightReportCompatibleFields.metrics[].kind string É o tipo de recurso. Neste caso, dfareporting#metric.
floodlightReportCompatibleFields.metrics[].name string É o nome da métrica. Por exemplo, dfa:impressions.
floodlightReportCompatibleFields.dimensionFilters[] list São as dimensões compatíveis para serem selecionadas na seção "dimensionFilters" do relatório.
floodlightReportCompatibleFields.dimensionFilters[].kind string É o tipo de recurso. Neste caso, dfareporting#dimension.
floodlightReportCompatibleFields.dimensionFilters[].name string É o nome da dimensão. Por exemplo, dfa:advertiser.
pathReportCompatibleFields nested object Contém itens compatíveis para serem selecionados para um relatório do tipo "PATH".
pathReportCompatibleFields.kind string É o tipo de recurso. Neste caso, dfareporting#pathReportCompatibleFields.
pathReportCompatibleFields.dimensions[] list São as dimensões compatíveis para serem selecionadas na seção "dimensions" do relatório.
pathReportCompatibleFields.dimensions[].kind string É o tipo de recurso. Neste caso, dfareporting#dimension.
pathReportCompatibleFields.dimensions[].name string É o nome da dimensão. Por exemplo, dfa:advertiser.
pathReportCompatibleFields.metrics[] list São as métricas compatíveis para serem selecionadas na seção "metricNames" do relatório.
pathReportCompatibleFields.metrics[].kind string É o tipo de recurso. Neste caso, dfareporting#metric.
pathReportCompatibleFields.metrics[].name string É o nome da métrica. Por exemplo, dfa:impressions.
pathReportCompatibleFields.pathFilters[] list São as dimensões compatíveis para serem selecionadas na seção "pathFilters" do relatório.
pathReportCompatibleFields.pathFilters[].kind string É o tipo de recurso. Neste caso, dfareporting#dimension.
pathReportCompatibleFields.pathFilters[].name string É o nome da dimensão. Por exemplo, dfa:advertiser.
pathReportCompatibleFields.channelGroupings[] list São as dimensões compatíveis para serem selecionadas na seção "channelGroupings" do relatório.
pathReportCompatibleFields.channelGroupings[].kind string É o tipo de recurso. Neste caso, dfareporting#dimension.
pathReportCompatibleFields.channelGroupings[].name string É o nome da dimensão. Por exemplo, dfa:advertiser.
pathAttributionReportCompatibleFields nested object Contém itens compatíveis para serem selecionados para um relatório do tipo "PATH_ATTRIBUTION".
pathAttributionReportCompatibleFields.kind string É o tipo de recurso. Neste caso, dfareporting#pathReportCompatibleFields.
pathAttributionReportCompatibleFields.dimensions[] list São as dimensões compatíveis para serem selecionadas na seção "dimensions" do relatório.
pathAttributionReportCompatibleFields.dimensions[].kind string É o tipo de recurso. Neste caso, dfareporting#dimension.
pathAttributionReportCompatibleFields.dimensions[].name string É o nome da dimensão. Por exemplo, dfa:advertiser.
pathAttributionReportCompatibleFields.metrics[] list São as métricas compatíveis para serem selecionadas na seção "metricNames" do relatório.
pathAttributionReportCompatibleFields.metrics[].kind string É o tipo de recurso. Neste caso, dfareporting#metric.
pathAttributionReportCompatibleFields.metrics[].name string É o nome da métrica. Por exemplo, dfa:impressions.
pathAttributionReportCompatibleFields.pathFilters[] list São as dimensões compatíveis para serem selecionadas na seção "pathFilters" do relatório.
pathAttributionReportCompatibleFields.pathFilters[].kind string É o tipo de recurso. Neste caso, dfareporting#dimension.
pathAttributionReportCompatibleFields.pathFilters[].name string É o nome da dimensão. Por exemplo, dfa:advertiser.
pathAttributionReportCompatibleFields.channelGroupings[] list São as dimensões compatíveis para serem selecionadas na seção "channelGroupings" do relatório.
pathAttributionReportCompatibleFields.channelGroupings[].kind string É o tipo de recurso. Neste caso, dfareporting#dimension.
pathAttributionReportCompatibleFields.channelGroupings[].name string É o nome da dimensão. Por exemplo, dfa:advertiser.

Faça um teste

Use o APIs Explorer abaixo para chamar esse método em dados ativos e ver a resposta.