- Solicitação HTTP
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- Faça um teste
A API Realtime do Google Analytics retorna um relatório personalizado com dados de eventos em tempo real da sua propriedade. Esses relatórios mostram o uso e os eventos dos últimos 30 minutos.
Solicitação HTTP
POST https://analyticsdata.googleapis.com/v1alpha/{property=properties/*}:runRealtimeReport
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. Especificado no caminho do URL, e não no corpo. 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 solicitadas e exibidas. |
metrics[] |
As métricas solicitadas e exibidas. |
limit |
O número de linhas a serem retornadas. Se o parâmetro |
dimensionFilter |
A cláusula de filtro das dimensões. É preciso solicitar as dimensões para usar nesse filtro. Não é possível usar métricas neste filtro. |
metricFilter |
A cláusula de filtro das métricas. Aplicado na fase pós-agregação, semelhante à cláusula SQL. É preciso solicitar as métricas para usá-las nesse filtro. Não é possível usar dimensões neste filtro. |
metricAggregations[] |
Agregação de métricas. Os valores das métricas agregadas serão mostrados nas linhas em que "dimensionValues" estiver definido como "RESERVED_(Metric separadamente)". |
orderBys[] |
Especifica como as linhas são ordenadas na resposta. |
returnPropertyQuota |
Define se o estado atual da cota em tempo real dessa propriedade do Google Analytics é retornado. A cota é retornada em PropertyQuota. |
Corpo da resposta
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
A tabela de relatórios de resposta em tempo real correspondente a uma solicitação.
Representação JSON | |
---|---|
{ "dimensionHeaders": [ { object ( |
Campos | |
---|---|
dimensionHeaders[] |
Descreve as colunas de dimensão. O número de DimensionHeaders e a ordem de DimensionHeaders correspondem às dimensões presentes nas linhas. |
metricHeaders[] |
Descreve as colunas de métricas. O número de MetricHeaders e ordem de MetricHeaders correspondem às métricas presentes nas linhas. |
rows[] |
Linhas de combinações de valores de dimensão e valores de métricas no relatório. |
totals[] |
Se solicitado, os valores totais das métricas. |
maximums[] |
Se solicitado, os valores máximos das métricas. |
minimums[] |
Se solicitado, os valores mínimos das métricas. |
rowCount |
O número total de linhas no resultado da consulta, independentemente do número de linhas retornadas na resposta. Por exemplo, se uma consulta retornar 175 linhas e incluir limit = 50 na solicitação da API, a resposta conterá rowCount = 175, mas apenas 50 linhas. |
propertyQuota |
O estado da cota em tempo real desta propriedade do Google Analytics, incluindo a solicitação. |
Escopos de autorização
Requer um dos seguintes escopos de OAuth:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics