Method: properties.runRealtimeReport

Muestra un informe personalizado de los datos de eventos en tiempo real de tu propiedad. Los eventos aparecen en los informes en tiempo real segundos después de que se envían a Google Analytics. Los informes En tiempo real muestran eventos y datos de uso para los períodos que van desde el momento actual hasta 30 minutos atrás (hasta 60 minutos para las propiedades de Google Analytics 360).

Para obtener una guía sobre cómo crear solicitudes en tiempo real y comprender las respuestas, consulta Cómo crear un informe en tiempo real.

Solicitud HTTP

POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:runRealtimeReport

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
property

string

Es un identificador de propiedad de Google Analytics cuyos eventos se registran. Se especifica en la ruta de URL y no en el cuerpo. Para obtener más información, consulta dónde encontrar el ID de tu propiedad.

Ejemplo: properties/1234

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación 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)

Las dimensiones solicitadas y mostradas
metrics[]

object (Metric)

Las métricas solicitadas y mostradas
dimensionFilter

object (FilterExpression)

La cláusula de filtro de las dimensiones. No se pueden usar métricas en este filtro.
metricFilter

object (FilterExpression)

Es la cláusula de filtro de las métricas. Se aplica en la fase posterior a la agregación, de manera similar a la cláusula having de SQL. No se pueden usar dimensiones en este filtro.
limit

string (int64 format)

Es la cantidad de filas que se mostrarán. Si no se especifica, se devuelven 10,000 filas. La API muestra un máximo de 250,000 filas por solicitud, independientemente de cuántas solicites. limit debe ser positivo.

La API también puede mostrar menos filas que el limit solicitado, si no hay tantos valores de dimensión como el limit. Por ejemplo, hay menos de 300 valores posibles para la dimensión country, por lo que, cuando se informa solo sobre country, no se pueden obtener más de 300 filas, incluso si se establece limit en un valor más alto.
metricAggregations[]

enum (MetricAggregation)

Agregación de métricas. Los valores de las métricas agregadas se mostrarán en las filas en las que los dimensionValues estén configurados como "RESERVED_(MetricAggregation)".
orderBys[]

object (OrderBy)

Especifica cómo se ordenan las filas en la respuesta.
returnPropertyQuota

boolean

Activa o desactiva si se debe mostrar el estado actual de la cuota de Realtime de esta propiedad de Google Analytics. La cuota se muestra en PropertyQuota.
minuteRanges[]

object (MinuteRange)

Los intervalos de minutos de los datos de eventos que se deben leer. Si no se especifica, se usará un rango de un minuto para los últimos 30 minutos. Si se solicitan varios rangos de minutos, cada fila de respuesta contendrá un índice de rango de minutos basado en cero. Si se superponen dos intervalos de minutos, los datos del evento de los minutos superpuestos se incluyen en las filas de respuesta de ambos intervalos.

Cuerpo de la respuesta

La tabla del informe de respuesta en tiempo real correspondiente a una solicitud.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación 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)

Describe las columnas de dimensiones. La cantidad de DimensionHeaders y el orden de DimensionHeaders coinciden con las dimensiones presentes en las filas.
metricHeaders[]

object (MetricHeader)

Describe las columnas de métricas. La cantidad de MetricHeaders y el orden de MetricHeaders coinciden con las métricas presentes en las filas.
rows[]

object (Row)

Son las filas de combinaciones de valores de dimensiones y valores de métricas en el informe.
totals[]

object (Row)

Si se solicita, los valores totales de las métricas
maximums[]

object (Row)

Si se solicita, los valores máximos de las métricas
minimums[]

object (Row)

Si se solicita, los valores mínimos de las métricas
rowCount

integer

Es la cantidad total de filas en el resultado de la consulta. rowCount es independiente de la cantidad de filas que se muestran en la respuesta y del parámetro de solicitud limit. Por ejemplo, si una consulta muestra 175 filas y, además, incluye limit de 50 en la solicitud a la API, la respuesta contendrá rowCount de 175, pero solo 50 filas.
propertyQuota

object (PropertyQuota)

El estado de la cuota en tiempo real de esta propiedad de Google Analytics, incluida esta solicitud
kind

string

Identifica qué tipo de recurso es este mensaje. Este kind siempre es la cadena fija "analyticsData#runRealtimeReport". Es útil para distinguir entre los tipos de respuesta en JSON.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

MinuteRange

Es un conjunto contiguo de minutos: startMinutesAgo, startMinutesAgo + 1, ..., endMinutesAgo. Las solicitudes pueden tener un rango de hasta 2 minutos.

Representación JSON 
{
  "name": string,
  "startMinutesAgo": integer,
  "endMinutesAgo": integer
}
Campos
name

string

Asigna un nombre a este rango de minutos. La dimensión dateRange tiene este valor en una respuesta de informe. Si se establece, no puede comenzar con date_range_ ni RESERVED_. Si no se establecen, los intervalos de minutos se nombran por su índice basado en cero en la solicitud: date_range_0, date_range_1, etcétera.
startMinutesAgo

integer

El minuto de inicio inclusive de la consulta como una cantidad de minutos antes del momento actual. Por ejemplo, "startMinutesAgo": 29 especifica que el informe debe incluir datos de eventos desde hace 29 minutos y después. No puede ser posterior al endMinutesAgo.

Si no se especifica, el valor predeterminado de startMinutesAgo es 29. Las propiedades Analytics estándares pueden solicitar hasta los últimos 30 minutos de datos de eventos (startMinutesAgo <= 29), y las propiedades de Analytics 360 pueden solicitar hasta los últimos 60 minutos de datos de eventos (startMinutesAgo <= 59).
endMinutesAgo

integer

El minuto final inclusive de la consulta como una cantidad de minutos antes del momento actual. No puede ser anterior al startMinutesAgo. Por ejemplo, "endMinutesAgo": 15 especifica que el informe debe incluir datos de eventos anteriores a 15 minutos.

Si no se especifica, el valor predeterminado de endMinutesAgo es 0. Las propiedades estándares de Analytics pueden solicitar cualquier minuto de los últimos 30 minutos de datos de eventos (endMinutesAgo <= 29), y las propiedades de Analytics 360 pueden solicitar cualquier minuto de los últimos 60 minutos de datos de eventos (endMinutesAgo <= 59).