- Solicitud HTTP
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Alcances de la autorización
- MinuteRange
- Pruébala
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 de Google Analytics 360).
Para obtener una guía sobre cómo crear solicitudes y comprender las respuestas en tiempo real, 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 la URL y 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[] |
Son las dimensiones solicitadas y que se muestran. |
metrics[] |
Las métricas solicitadas y que se muestran. |
dimensionFilter |
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 de cláusula de SQL. No se pueden usar dimensiones en este filtro. |
limit |
Cantidad 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, sin importar cuántas tengas. 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 configuren como "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 los 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 eventos correspondientes a los minutos superpuestos se incluyen en las filas de respuesta de ambos intervalos 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 columnas de métricas. La cantidad de MetricHeaders y el orden de los 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 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 cuota en tiempo real de esta propiedad de Analytics, incluida esta solicitud. |
kind |
Identifica el tipo de recurso que representa este mensaje. Este |
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
. Las solicitudes se permiten en intervalos 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 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 |