Method: properties.runRealtimeReport

La API en tiempo real de Google Analytics muestra un informe personalizado de datos de eventos en tiempo real de tu propiedad. Estos informes muestran eventos y uso de los últimos 30 minutos.

Solicitud HTTP

POST https://analyticsdata.googleapis.com/v1alpha/{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 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 (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "limit": string,
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "returnPropertyQuota": boolean
}
Campos
dimensions[]

object (Dimension)

Las dimensiones solicitadas y mostradas.
metrics[]

object (Metric)

Las métricas solicitadas y que se muestran.
limit

string (int64 format)

Número de filas que se mostrarán. Si no se especifica el parámetro limit, se muestran 10,000 filas. La API devuelve un máximo de 100,000 filas por solicitud, independientemente de cuántas solicites.
dimensionFilter

object (FilterExpression)

Es la cláusula de filtro de las dimensiones. Se debe solicitar el uso de las dimensiones en este filtro. 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. Se debe solicitar el uso de métricas en este filtro. No se pueden utilizar dimensiones en este filtro.
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.

Cuerpo de la respuesta

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Es la tabla del informe en tiempo real de respuesta que corresponde a una solicitud.

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)
  }
}
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

El número total de filas en el resultado de la consulta, sin importar el número de filas devueltas en la respuesta. Por ejemplo, si una consulta muestra 175 filas e incluye un límite = 50 en la solicitud a la API, la respuesta contendrá la cantidad de filas = 175, pero solo 50 filas.
propertyQuota

object (PropertyQuota)

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

Alcances 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