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, será necessário remover dimensões e/ou métricas do relatório incompatível até que ele seja compatível.

Os Relatórios de 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 que são acompanhados. Para saber mais, veja onde encontrar seu ID da propriedade. property precisa ter o mesmo valor da solicitação runReport.

Exemplo: propriedades/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)

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

object (Metric)

As métricas deste 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 da solicitação runReport
compatibilityFilter

enum (Compatibility)

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

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 do 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 para uma única dimensão.

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

object (DimensionMetadata)

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

enum (Compatibility)

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

MetricCompatibility

A compatibilidade de 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 para essas 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 desta métrica. Se a compatibilidade for COMPATÍVEL, esta métrica poderá ser adicionada ao relatório.