Method: properties.runRealtimeReport

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

string

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 (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 das dimensões. Não é possível usar métricas neste filtro.
metricFilter

object (FilterExpression)

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

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 no máximo 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 um relatório somente para country, não será possível gerar mais de 300 linhas, mesmo que você defina limit como um valor mais alto.
metricAggregations[]

enum (MetricAggregation)

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[]

object (OrderBy)

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

boolean

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

object (MinuteRange)

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 (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 as colunas de dimensão. O número de DimensionHeaders e a ordem de DimensionHeaders correspondem às dimensões presentes nas linhas.
metricHeaders[]

object (MetricHeader)

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

object (Row)

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

object (Row)

Se solicitado, os valores totais 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 não depende do número de linhas retornadas na resposta e no parâmetro de solicitação limit. Por exemplo, se uma consulta retornar 175 linhas e incluir limit de 50 na solicitação de API, a resposta conterá rowCount de 175, mas apenas 50 linhas.
propertyQuota

object (PropertyQuota)

O estado da cota em tempo real desta propriedade do Google Analytics, incluindo a solicitação.
kind

string

Identifica o tipo de recurso da mensagem. Este kind é sempre a string fixa "analyticsData#runRealtimeReport". Útil para distinguir entre 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

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

string

Atribui um nome a esse intervalo de minutos. A dimensão dateRange é avaliada 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 inclusive para a consulta como um número de minutos antes de agora. Por exemplo, "startMinutesAgo": 29 especifica que o relatório precisa incluir dados de eventos de 29 minutos atrás e depois. Não pode ser depois de endMinutesAgo.

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

integer

O minuto final inclusive 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 até 15 minutos atrás.

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