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 correspondientes a períodos que van desde el momento actual hasta hace 30 minutos (hasta 60 minutos para las propiedades Google Analytics 360).

Guía para crear solicitudes en tiempo real y para 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 la propiedad GA4 de Google Analytics a cuyos eventos se hace un seguimiento. Se especifica en la ruta de URL, no en el cuerpo. Para obtener más información, consulta dónde encontrar tu ID de 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 que se muestran.
dimensionFilter

object (FilterExpression)

Es 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 posterior a la agregación, de manera similar a la cláusula que tiene SQL. No se pueden utilizar dimensiones en este filtro.
limit

string (int64 format)

Número de filas que se mostrarán. Si no se especifica, se muestran 10,000 filas. La API devuelve un máximo de 250,000 filas por solicitud, independientemente de cuántas solicites. El valor de 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 limit. Por ejemplo, hay menos de 300 valores posibles para la dimensión country, por lo que, cuando se informa solo sobre country, no puedes obtener más de 300 filas, incluso si estableces limit con un valor más alto.
metricAggregations[]

enum (MetricAggregation)

Agregación de métricas. Los valores agregados de las métricas se mostrarán en las filas donde los valores de dimensionValues se establezcan en "RESERVED_(MetricAggregation)".
orderBys[]

object (OrderBy)

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

boolean

Activa o desactiva la opción para que se muestre 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á un rango de minutos 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 dos intervalos de minutos se superponen, los datos de eventos de los minutos superpuestos se incluyen en las filas de respuesta de ambos intervalos de minutos.

Cuerpo de la respuesta

Es la tabla del informe en tiempo real de respuesta 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 coincide con las dimensiones presentes en las filas.
metricHeaders[]

object (MetricHeader)

Describe las 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 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

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)

Estado de la cuota en tiempo real de esta propiedad de Analytics, incluida esta solicitud.
kind

string

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

Alcances 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

Un conjunto contiguo de minutos: startMinutesAgo, startMinutesAgo + 1, ..., endMinutesAgo. Las solicitudes pueden tener rangos de hasta 2 minutos.

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

string

Asigna un nombre a este intervalo de minutos. La dimensión dateRange se valora con este nombre en la respuesta de un informe. Si está establecido, no puede comenzar con date_range_ ni RESERVED_. Si no se establece, los intervalos 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 el número de minutos antes de ahora. Por ejemplo, "startMinutesAgo": 29 especifica que el informe debe incluir datos de eventos de hace 29 minutos y después. 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 hasta los últimos 30 minutos de datos de eventos (startMinutesAgo <= 29), mientras que las propiedades de Analytics 360 pueden solicitar hasta los últimos 60 minutos de datos de eventos (startMinutesAgo <= 59).
endMinutesAgo

integer

El minuto final inclusivo para la consulta como un número de minutos antes de ahora. No puede ser anterior al startMinutesAgo. Por ejemplo, "endMinutesAgo": 15 especifica que el informe debe incluir datos de eventos de hace 15 minutos o más.

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