Method: properties.runRealtimeReport

Muestra un informe personalizado de datos de eventos en tiempo real para 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 períodos que van desde el momento actual hasta hace 30 minutos (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

Un identificador de propiedad GA4 de Google Analytics de cuyos eventos se hace un seguimiento. Se especifica en la ruta de la 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)

Son las dimensiones solicitadas y mostradas.
metrics[]

object (Metric)

Las métricas solicitadas y que se muestran.
dimensionFilter

object (FilterExpression)

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

object (FilterExpression)

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

string (int64 format)

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

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

enum (MetricAggregation)

Agregación de métricas. Los valores de métricas agregadas se mostrarán en las filas en las que dimensionValues se establezcan en "RESERVED_(MetricAggregate)".
orderBys[]

object (OrderBy)

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

boolean

Activa o desactiva si se muestra el estado actual de la cuota en tiempo real de esta propiedad de Analytics. La cuota se muestra en PropertyQuota.
minuteRanges[]

object (MinuteRange)

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

Cuerpo de la respuesta

Tabla del informe en tiempo real de respuestas que corresponde 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 columnas de métricas. La cantidad de MetricHeaders y el orden de los MetricHeaders coinciden con las métricas presentes en las filas.
rows[]

object (Row)

Filas de combinaciones de valores de dimensiones y valores de métricas del informe.
totals[]

object (Row)

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

object (Row)

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

object (Row)

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

integer

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 el parámetro de solicitud limit. Por ejemplo, si una consulta muestra 175 filas e 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 Analytics, incluida esta solicitud.
kind

string

Identifica el tipo de recurso que es este mensaje. Este kind es siempre la string fija "analyticsData#runRealtimeReport". Es útil para distinguir entre tipos de respuesta en JSON.

Permisos de la autorización

Se necesita uno de los siguientes alcances de OAuth:

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

Intervalo de minutos

Un conjunto contiguo de minutos: startMinutesAgo, startMinutesAgo + 1, ..., endMinutesAgo. Se permiten solicitudes 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 se asigna a este nombre en una respuesta de informe. Si se configura, no puede comenzar con date_range_ ni RESERVED_. Si no se establece, los rangos de minutos se nombran según su índice basado en cero en la solicitud: date_range_0, date_range_1, etcétera.
startMinutesAgo

integer

El minuto de inicio inclusivo de la consulta como un número de minutos antes de este momento. Por ejemplo, "startMinutesAgo": 29 especifica que el informe debe incluir datos de eventos desde hace 29 minutos en adelante. No puede ser posterior a endMinutesAgo.

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

integer

El minuto final inclusivo de la consulta como un número de minutos antes de la fecha actual. No puede ser anterior a startMinutesAgo. Por ejemplo, "endMinutesAgo": 15 especifica que el informe debe incluir datos de eventos anteriores a 15 minutos atrás.

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