Method: properties.runRealtimeReport

Retorna um relatório personalizado dos dados de eventos em tempo real da sua propriedade. Os eventos aparecem nos relatórios em tempo real segundos depois de serem enviados ao Google Analytics. Os relatórios em tempo real mostram eventos e dados de uso para os períodos que vão do momento atual até 30 minutos atrás (até 60 minutos para propriedades do Google Analytics 360).

Para um guia sobre como criar solicitações em tempo real e entender as respostas, consulte 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 Google Analytics cujos eventos são rastreados. Especificado no caminho do URL e não no corpo. Para saber mais, consulte 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. As métricas não podem ser usadas nesse filtro.
metricFilter

object (FilterExpression)

A cláusula de filtro de métricas. Aplicada na fase de pós-agregação, semelhante à cláusula "having" do SQL. As dimensões não podem ser usadas nesse filtro.
limit

string (int64 format)

O número de linhas que serão 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, não importa quantas você peça. 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 sobre country, não é possível receber mais de 300 linhas, mesmo que você defina limit como um valor maior.
metricAggregations[]

enum (MetricAggregation)

Agregação de métricas. Os valores de métricas agregados serão mostrados em linhas em que os valores de dimensão estão definidos como "RESERVED_(MetricAggregation)".
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, um intervalo de minutos para os últimos 30 minutos será usado. Se vários intervalos de minutos forem solicitados, cada linha de resposta vai conter 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 para ambos os intervalos.

Corpo da resposta

A tabela de relatórios em tempo real da resposta 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 deles correspondem às dimensões presentes nas linhas.
metricHeaders[]

object (MetricHeader)

Descreve colunas de métricas. O número de MetricHeaders e a ordem deles 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 é independente 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 vai conter rowCount de 175, mas apenas 50 linhas.
propertyQuota

object (PropertyQuota)

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

string

Identifica o tipo de recurso dessa 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 são permitidas em até dois intervalos de 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 estiver 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 inicial inclusivo da 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 depois de endMinutesAgo.

Se não for especificado, startMinutesAgo será definido como 29. As propriedades padrão do Analytics podem solicitar até os últimos 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 inclusivo da consulta como um número de minutos antes de agora. Não pode ser antes de startMinutesAgo. Por exemplo, "endMinutesAgo": 15 especifica que o relatório deve incluir dados de eventos de antes de 15 minutos atrás.

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