- Solicitação HTTP
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- MinuteRange
- Faça um teste
Retorna um relatório personalizado com dados de eventos em tempo real da sua propriedade. Os eventos aparecem em relatórios em tempo real segundos depois de serem enviados ao Google Analytics. Os Relatórios de tempo real mostram dados de uso e eventos de períodos que vão do momento atual até 30 minutos atrás (até 60 minutos para as propriedades do Google Analytics 360).
Para conferir um guia sobre como criar solicitações em tempo real e entender as respostas, consulte Como criar um Relatório em tempo real.
Solicitação HTTP
POST https://analyticsdata.googleapis.com/v1beta/{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. |
dimensionFilter |
A cláusula de filtro das dimensões. 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. Não é possível usar dimensões neste filtro. |
limit |
O número de linhas a serem retornadas. Se não for especificado, 10.000 linhas serão retornadas. A API retorna no máximo 250.000 linhas por solicitação, independentemente de quantas linhas você solicitar. A API também pode retornar menos linhas do que o |
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. |
minuteRanges[] |
Os intervalos de minutos dos dados de eventos a serem lidos. Se não for especificado, o intervalo de um minuto para os últimos 30 minutos será usado. Se vários intervalos de minutos forem solicitados, cada linha de resposta terá um índice de intervalo de minutos baseado em zero. Se dois intervalos de minutos se sobrepuserem, os dados de eventos dos minutos sobrepostos serão incluídos nas linhas de resposta dos dois intervalos. |
Corpo da resposta
A tabela de relatórios de resposta em tempo real correspondente a uma solicitação.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
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. |
propertyQuota |
O estado da cota em tempo real desta propriedade do Google Analytics, incluindo a solicitação. |
kind |
Identifica o tipo de recurso da mensagem. Este |
Escopos de autorização
Requer um dos seguintes escopos de OAuth:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
MinuteRange
Um conjunto contíguo de minutos: startMinutesAgo
, startMinutesAgo + 1
, ..., endMinutesAgo
. As solicitações podem ter intervalos de até dois minutos.
Representação JSON |
---|
{ "name": string, "startMinutesAgo": integer, "endMinutesAgo": integer } |
Campos | |
---|---|
name |
Atribui um nome a esse intervalo de minutos. A dimensão |
startMinutesAgo |
O minuto de início inclusive para a consulta como um número de minutos antes de agora. Por exemplo, Se não for especificado, |
endMinutesAgo |
O minuto final inclusive para a consulta como um número de minutos antes de agora. Não pode ser anterior a Se não for especificado, |