- Solicitud HTTP
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
- MinuteRange
- Pruébalo
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 |
Es un identificador de la propiedad GA4 de Google Analytics de 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 ( |
Campos | |
---|---|
dimensions[] |
Las dimensiones solicitadas y mostradas. |
metrics[] |
Las métricas solicitadas y que se muestran. |
dimensionFilter |
Es la cláusula de filtro de las 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 a la agregación, de manera similar a la cláusula que tiene SQL. No se pueden utilizar dimensiones en este filtro. |
limit |
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 La API también puede mostrar menos filas que la |
metricAggregations[] |
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[] |
Especifica cómo se ordenan las filas en la respuesta. |
returnPropertyQuota |
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[] |
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 ( |
Campos | |
---|---|
dimensionHeaders[] |
Describe las columnas de dimensiones. La cantidad de DimensionHeaders y el orden de DimensionHeaders coincide con las dimensiones presentes en las filas. |
metricHeaders[] |
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[] |
Filas de combinaciones de valores de dimensiones y valores de métricas del informe. |
totals[] |
Si se solicita, los valores totales de las métricas. |
maximums[] |
Si se solicita, los valores máximos de las métricas. |
minimums[] |
Si se solicita, los valores mínimos de las métricas. |
rowCount |
La cantidad total de filas en el resultado de la consulta. |
propertyQuota |
Estado de la cuota en tiempo real de esta propiedad de Analytics, incluida esta solicitud. |
kind |
Identifica a qué tipo de recurso es este mensaje. Este |
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 |
Asigna un nombre a este intervalo de minutos. La dimensión |
startMinutesAgo |
El minuto de inicio inclusivo de la consulta como el número de minutos antes de ahora. Por ejemplo, Si no se especifica, el valor predeterminado de |
endMinutesAgo |
El minuto final inclusivo para la consulta como un número de minutos antes de ahora. No puede ser anterior al Si no se especifica, el valor predeterminado de |