Method: properties.runRealtimeReport

A API Realtime do Google Analytics retorna um relatório personalizado de dados de eventos em tempo real para sua propriedade. Estes relatórios mostram os eventos e o uso 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

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)
    }
  ],
  "limit": string,
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "returnPropertyQuota": boolean
}
Campos
dimensions[]

object (Dimension)

As dimensões solicitadas e exibidas.
metrics[]

object (Metric)

As métricas solicitadas e exibidas.
limit

string (int64 format)

O número de linhas a serem retornadas. Se o parâmetro limit não for especificado, 10.000 linhas serão retornadas. A API retorna no máximo 100.000 linhas por solicitação, independentemente de quantas linhas você pedir.
dimensionFilter

object (FilterExpression)

A cláusula de filtro das dimensões. É necessário solicitar as dimensões para serem usadas nesse filtro. 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. As métricas precisam ser solicitadas para uso nesse filtro. Não é possível usar dimensões neste filtro.
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.

Corpo da resposta

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

A tabela do relatório de resposta em tempo real 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)
  }
}
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

Número total de linhas no resultado da consulta, independentemente do número de linhas retornadas na resposta. Por exemplo, se uma consulta retorna 175 linhas e inclui limit = 50 na solicitação da API, a resposta terá rowCount = 175, mas apenas 50 linhas.
propertyQuota

object (PropertyQuota)

O estado da cota em tempo real dessa propriedade do Google Analytics, incluindo esta solicitação.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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