Method: properties.runRealtimeReport

Retorna um relatório personalizado de dados de eventos em tempo real da sua propriedade. Os eventos aparecem nos Relatórios de tempo real segundos depois de serem enviados ao Google Analytics. Os Relatórios de tempo real mostram eventos e dados de uso de 30 minutos a 30 minutos (até 60 minutos para propriedades do Google Analytics 360).

Para orientações sobre como criar solicitações 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 que são acompanhados. Especificado no caminho do URL e não no corpo. Para saber mais, veja onde encontrar seu ID da propriedade.

Exemplo: propriedades/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, de forma semelhante à cláusula do 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ê pedir. limit precisa ser positivo.

A API também poderá 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 somente sobre country, não é 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 de métricas agregados serão mostrados nas linhas em que dimensionValues estiverem definidos como "RESERVED_(MetricAggregate)".
orderBys[]

object (OrderBy)

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

boolean

Alterna se o estado atual da cota em tempo real dessa propriedade do Google Analytics será 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, será usado o intervalo de um minuto referente aos últimos 30 minutos. Se vários intervalos de minutos forem solicitados, cada linha de resposta conterá um índice de intervalo de minutos baseado em zero. Se os intervalos de dois minutos se sobrepuserem, os dados de evento dos minutos em sobreposição serão incluídos nas linhas de resposta para ambos os intervalos de minutos.

Corpo da resposta

A tabela do relatório 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 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 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 valores de métrica 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 não depende do número de linhas retornadas na resposta e do 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 dessa propriedade do Google Analytics, incluindo esta solicitação.
kind

string

Identifica o tipo de recurso da mensagem. Esse 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 do 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 ao intervalo de minutos. A dimensão dateRange é avaliada para 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

Minuto de início inclusivo da 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. As propriedades padrão do Google Analytics podem solicitar dados de eventos dos últimos 30 minutos (startMinutesAgo <= 29), e as propriedades do Analytics 360 podem solicitar dados de eventos dos últimos 60 minutos (startMinutesAgo <= 59).
endMinutesAgo

integer

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

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