- Solicitud HTTP
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
- MinuteRange
- Pruébala
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).
Si deseas obtener una guía para 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 |
Un identificador de la 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. Si deseas 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 ( |
Campos | |
---|---|
dimensions[] |
Son las dimensiones solicitadas y que se muestran. |
metrics[] |
Las métricas solicitadas y que se muestran. |
dimensionFilter |
La cláusula de filtro de dimensiones. No se pueden usar métricas en este filtro. |
metricFilter |
La cláusula de filtro de las métricas. Se aplica en la fase posterior de agregación, de manera similar a la cláusula SQL. No se pueden usar las dimensiones en este filtro. |
limit |
Es la 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, sin importar cuántas pidas. El valor de La API también puede mostrar menos filas que la |
metricAggregations[] |
Agregación de métricas. Los valores de métricas agregados se mostrarán en las filas en las que dimensionValues se establezcan en "RESERVED_(MetricAggregation)". |
orderBys[] |
Especifica cómo se ordenan las filas en la respuesta. |
returnPropertyQuota |
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[] |
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 intervalos de minutos se superponen, los datos de los eventos de los minutos que se superponen se incluyen en las filas de respuesta de ambos rangos de minutos. |
Cuerpo de la respuesta
La tabla del informe en tiempo real de respuestas correspondiente a una solicitud.
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
Representación JSON |
---|
{ "dimensionHeaders": [ { object ( |
Campos | |
---|---|
dimensionHeaders[] |
Describe las columnas de dimensiones. La cantidad de DimensionHeaders y el orden de DimensionHeaders coinciden con las dimensiones presentes en las filas. |
metricHeaders[] |
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[] |
Filas de combinaciones de valores de dimensiones y valores de métricas del informe. |
totals[] |
Si se solicitan, los valores totales de las métricas. |
maximums[] |
Si se solicitan, los valores máximos de las métricas. |
minimums[] |
Si se solicitan, los valores mínimos de las métricas. |
rowCount |
Cantidad total de filas en el resultado de la consulta. |
propertyQuota |
El estado de cuota en tiempo real de esta propiedad de Analytics, incluida esta solicitud. |
kind |
Identifica el tipo de recurso de este mensaje. Este mensaje |
Permisos de autorización
Se necesita uno de los siguientes alcances 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
. Se permiten solicitudes de hasta 2 minutos.
Representación JSON |
---|
{ "name": string, "startMinutesAgo": integer, "endMinutesAgo": integer } |
Campos | |
---|---|
name |
Asigna un nombre a este intervalo de minutos. En una respuesta del informe, se asigna este nombre a la dimensión |
startMinutesAgo |
El minuto de inicio inclusivo para la consulta como un número de minutos antes de ahora. Por ejemplo, Si no se especifica, el valor predeterminado de |
endMinutesAgo |
El minuto final inclusivo de la consulta como un número de minutos antes de ahora. No puede ser anterior a Si no se especifica, el valor predeterminado de |