Method: properties.checkCompatibility

Esse método de compatibilidade lista dimensões e métricas que podem ser adicionadas a uma solicitação de relatório e mantém a compatibilidade. Esse método falhará se as dimensões e métricas da solicitação forem incompatíveis.

No Google Analytics, os relatórios falham quando solicitam dimensões e/ou métricas incompatíveis. Nesse caso, é necessário remover essas dimensões e/ou métricas do relatório incompatível até que ele seja compatível.

Os relatórios "Em tempo real" e "Principais" têm regras de compatibilidade diferentes. Esse método verifica a compatibilidade dos relatórios principais.

Solicitação HTTP

POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:checkCompatibility

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
property

string

Um identificador de propriedade do GA4 do Google Analytics com eventos rastreados. Para saber mais, confira onde encontrar o ID da propriedade. property precisa ter o mesmo valor da solicitação runReport.

Exemplo: properties/1234

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "compatibilityFilter": enum (Compatibility)
}
Campos
dimensions[]

object (Dimension)

As dimensões deste relatório. dimensions precisa ter o mesmo valor da solicitação runReport.
metrics[]

object (Metric)

As métricas neste relatório. metrics precisa ter o mesmo valor da solicitação runReport.
dimensionFilter

object (FilterExpression)

A cláusula de filtro das dimensões. dimensionFilter precisa ter o mesmo valor da solicitação runReport.
metricFilter

object (FilterExpression)

A cláusula de filtro das métricas. metricFilter precisa ter o mesmo valor que em sua solicitação runReport
compatibilityFilter

enum (Compatibility)

Filtra as dimensões e métricas na resposta apenas a essa compatibilidade. Geralmente usado como ”compatibilityFilter”: “COMPATIBLE” para retornar somente dimensões e métricas compatíveis.

Corpo da resposta

A resposta de compatibilidade com a compatibilidade de cada dimensão e métrica.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "dimensionCompatibilities": [
    {
      object (DimensionCompatibility)
    }
  ],
  "metricCompatibilities": [
    {
      object (MetricCompatibility)
    }
  ]
}
Campos
dimensionCompatibilities[]

object (DimensionCompatibility)

A compatibilidade de cada dimensão.
metricCompatibilities[]

object (MetricCompatibility)

A compatibilidade de cada métrica.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

Compatibilidade

Os tipos de compatibilidade para uma única dimensão ou métrica.

Enums
COMPATIBILITY_UNSPECIFIED Compatibilidade não especificada.
COMPATIBLE A dimensão ou métrica é compatível. Essa dimensão ou métrica pode ser adicionada a um relatório.
INCOMPATIBLE A dimensão ou métrica é incompatível. Não é possível adicionar essa dimensão ou métrica a um relatório.

DimensionCompatibility

A compatibilidade com uma única dimensão.

Representação JSON 
{
  "dimensionMetadata": {
    object (DimensionMetadata)
  },
  "compatibility": enum (Compatibility)
}
Campos
dimensionMetadata

object (DimensionMetadata)

Os metadados de dimensão contêm o nome da API dessas informações de compatibilidade. Os metadados de dimensão também contêm outras informações úteis, como o nome e a descrição da IU.
compatibility

enum (Compatibility)

A compatibilidade dessa dimensão. Se a compatibilidade for COMPATÍVEL, essa dimensão poderá ser adicionada ao relatório.

MetricCompatibility

A compatibilidade com uma única métrica.

Representação JSON 
{
  "metricMetadata": {
    object (MetricMetadata)
  },
  "compatibility": enum (Compatibility)
}
Campos
metricMetadata

object (MetricMetadata)

Os metadados da métrica contêm o nome da API dessas informações de compatibilidade. Os metadados da métrica também contêm outras informações úteis, como o nome e a descrição da interface.
compatibility

enum (Compatibility)

A compatibilidade dessa métrica. Se a compatibilidade for COMPATÍVEL, essa métrica poderá ser adicionada ao relatório.