- Solicitação HTTP
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- Compatibilidade
- DimensionCompatibility
- MetricCompatibility
- Faça um teste
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 |
Um identificador de propriedade do GA4 do Google Analytics com eventos rastreados. Para saber mais, confira onde encontrar o ID da propriedade. Exemplo: properties/1234 |
Corpo da solicitação
O corpo da solicitação contém dados com a seguinte estrutura:
Representação JSON |
---|
{ "dimensions": [ { object ( |
Campos | |
---|---|
dimensions[] |
As dimensões deste relatório. |
metrics[] |
As métricas neste relatório. |
dimensionFilter |
A cláusula de filtro das dimensões. |
metricFilter |
A cláusula de filtro das métricas. |
compatibilityFilter |
Filtra as dimensões e métricas na resposta apenas a essa compatibilidade. Geralmente usado como |
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 ( |
Campos | |
---|---|
dimensionCompatibilities[] |
A compatibilidade de cada dimensão. |
metricCompatibilities[] |
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 ( |
Campos | |
---|---|
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 |
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 ( |
Campos | |
---|---|
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 |
A compatibilidade dessa métrica. Se a compatibilidade for COMPATÍVEL, essa métrica poderá ser adicionada ao relatório. |