Method: properties.runRealtimeReport

Retorna um relatório personalizado de dados de eventos em tempo real para sua propriedade. Os eventos aparecem nos relatórios em tempo real segundos após terem sido enviados ao Google Analytics. Os relatórios em tempo real mostram eventos e dados de uso de períodos desde o momento atual até 30 minutos atrás (até 60 minutos para propriedades do Google Analytics 360).

Para ver 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

string

Um identificador de propriedade do GA4 do Google Analytics cujos eventos são rastreados. Especificada no caminho do URL e não no corpo. Para saber mais, veja 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 (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "returnPropertyQuota": boolean,
  "minuteRanges": [
    {
      object (MinuteRange)
    }
  ]
}
Campos
dimensions[]

object (Dimension)

As dimensões solicitadas e exibidas.
metrics[]

object (Metric)

As métricas solicitadas e exibidas.
dimensionFilter

object (FilterExpression)

A cláusula de filtro de dimensões. Não é possível usar métricas neste filtro.
metricFilter

object (FilterExpression)

A cláusula de filtro de métricas. Aplicado na fase de pós-agregação, semelhante à cláusula SQL. Não é possível usar dimensões neste filtro.
limit

string (int64 format)

O número de linhas a serem retornadas. Se não for especificado, 10.000 linhas serão retornadas. A API retorna um máximo de 250.000 linhas por solicitação, independentemente de quantas linhas você solicitar. limit precisa ser positivo.

A API também pode retornar menos linhas do que o limit solicitado, se não houver tantos valores de dimensão quanto o limit. Por exemplo, há menos de 300 valores possíveis para a dimensão country. Portanto, ao gerar relatórios apenas de country, não será possível ver mais de 300 linhas, mesmo que você defina limit como um valor mais alto.
metricAggregations[]

enum (MetricAggregation)

Agregação de métricas. Os valores de métrica agregados serão exibidos nas linhas em que "dimensionValues" estiver definido como "RESERVED_(MetricAggregation)".
orderBys[]

object (OrderBy)

Especifica como as linhas são ordenadas na resposta.
returnPropertyQuota

boolean

Define se deve retornar o estado atual da cota em tempo real desta propriedade do Google Analytics. A cota é retornada em PropertyQuota.
minuteRanges[]

object (MinuteRange)

Os intervalos de minutos dos dados do evento a serem lidos. Se não for especificado, será usado um intervalo de um minuto para os últimos 30 minutos. Se vários intervalos de minutos forem solicitados, cada linha de resposta conterá um índice de intervalo de minutos com base em zero. Se os intervalos de dois minutos se sobrepuserem, os dados de evento dos minutos sobrepostos serão incluídos nas linhas de resposta de ambos os intervalos de minutos.

Corpo da resposta

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

A tabela do relatório de tempo real de resposta correspondente a uma solicitação.

Representação JSON 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "propertyQuota": {
    object (PropertyQuota)
  },
  "kind": string
}
Campos
dimensionHeaders[]

object (DimensionHeader)

Descreve colunas de dimensões. O número de DimensionHeaders e a ordem de DimensionHeaders corresponde às dimensões presentes nas linhas.
metricHeaders[]

object (MetricHeader)

Descreve colunas de métricas. O número de MetricHeaders e a ordem de MetricHeaders correspondem às métricas presentes nas linhas.
rows[]

object (Row)

Linhas de combinações de valores de dimensão e métricas no relatório.
totals[]

object (Row)

Se solicitado, os valores totalizados das métricas.
maximums[]

object (Row)

Se solicitado, os valores máximos das métricas.
minimums[]

object (Row)

Se solicitado, os valores mínimos das métricas.
rowCount

integer

O número total de linhas no resultado da consulta. rowCount é independente do número de linhas retornadas na resposta e do parâmetro de solicitação limit. Por exemplo, se uma consulta retorna 175 linhas e inclui limit de 50 na solicitação de API, a resposta conterá rowCount de 175, mas apenas 50 linhas.
propertyQuota

object (PropertyQuota)

O estado de cota em tempo real dessa propriedade do Google Analytics, incluindo essa solicitação.
kind

string

Identifica o tipo de recurso desta mensagem. Este kind é sempre a string fixa "analyticsData#runRealtimeReport". Útil para distinguir entre os tipos de resposta em JSON.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

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

Intervalo de minutos

Um conjunto contíguo de minutos: startMinutesAgo, startMinutesAgo + 1, ..., endMinutesAgo. As solicitações têm intervalos de até dois minutos.

Representação JSON 
{
  "name": string,
  "startMinutesAgo": integer,
  "endMinutesAgo": integer
}
Campos
name

string

Atribui um nome a este intervalo de minutos. A dimensão dateRange é avaliada de acordo com esse nome em uma resposta de relatório. Se definido, não pode começar com date_range_ ou RESERVED_. Se não for definido, os intervalos de minutos serão nomeados pelo índice baseado em zero na solicitação: date_range_0, date_range_1 etc.
startMinutesAgo

integer

O minuto de início inclusivo para a consulta como um número de minutos antes de agora. Por exemplo, "startMinutesAgo": 29 especifica que o relatório deve incluir dados de eventos de 29 minutos atrás e depois. Não pode ser posterior a endMinutesAgo.

Se não for especificado, startMinutesAgo será padronizado como 29. As propriedades padrão do Google Analytics podem solicitar até os últimos 30 minutos de dados de eventos (startMinutesAgo <= 29), e as propriedades do Google Analytics 360 podem solicitar até os últimos 60 minutos de dados de eventos (startMinutesAgo <= 59).
endMinutesAgo

integer

O minuto final inclusivo para a consulta como um número de minutos antes de agora. Não pode ser anterior a startMinutesAgo. Por exemplo, "endMinutesAgo": 15 especifica que o relatório precisa incluir dados de eventos de 15 minutos atrás.

Se não for especificado, endMinutesAgo será definido como 0 por padrão. As propriedades do Google Analytics padrão podem solicitar qualquer minuto nos últimos 30 minutos de dados do evento (endMinutesAgo <= 29), e as propriedades do Google Analytics 360 podem solicitar qualquer minuto nos últimos 60 minutos dos dados do evento (endMinutesAgo <= 59).