Method: properties.runReport

Muestra un informe personalizado de tus datos de eventos de Google Analytics. Los informes contienen estadísticas derivadas de los datos recopilados por el código de seguimiento de Google Analytics. Los datos que muestra la API aparecen en una tabla con columnas para las dimensiones y métricas solicitadas. Las métricas son mediciones individuales de la actividad de los usuarios en tu propiedad, como los usuarios activos o el recuento de eventos. Las dimensiones desglosan las métricas según algunos criterios comunes, como el país o el nombre del evento.

Para obtener una guía sobre cómo crear solicitudes y comprender las respuestas, consulta Cómo crear un informe.

Solicitud HTTP

POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:runReport

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
property

string

Un identificador de 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 el ID de tu propiedad. Dentro de una solicitud por lotes, esta propiedad no debe estar especificada o ser coherente con la propiedad a nivel de lote.

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)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean
}
Campos
dimensions[]

object (Dimension)

Son las dimensiones solicitadas y mostradas.
metrics[]

object (Metric)

Las métricas solicitadas y que se muestran.
dateRanges[]

object (DateRange)

Períodos de los datos que se leerán. Si se solicitan varios períodos, cada fila de respuesta contendrá un índice de período basado en cero. Si dos períodos se superponen, los datos de eventos de los días que se superponen se incluyen en las filas de respuesta de ambos períodos. En una solicitud de cohorte, este dateRanges no debe especificarse.
dimensionFilter

object (FilterExpression)

Los filtros de dimensiones te permiten solicitar solo valores de dimensión específicos en el informe. Si deseas obtener más información, consulta Conceptos básicos de los filtros de dimensión para ver ejemplos. No se pueden usar métricas en este filtro.
metricFilter

object (FilterExpression)

La cláusula de filtro de las métricas. Se aplica después de agregar las filas del informe, de manera similar a la cláusula de SQL. No se pueden usar las dimensiones en este filtro.
offset

string (int64 format)

El recuento de filas de la fila de inicio. La primera fila se cuenta como la fila 0.

Cuando realiza la paginación, la primera solicitud no especifica el desplazamiento o, de manera equivalente, establece el desplazamiento en 0; la primera solicitud muestra las primeras limit de filas. La segunda solicitud establece el desplazamiento en el limit de la primera solicitud; la segunda solicitud muestra el segundo limit de las filas.

Para obtener más información sobre este parámetro de paginación, consulta Paginación.
limit

string (int64 format)

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, independientemente de la cantidad que solicites. 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 la limit. Por ejemplo, hay menos de 300 valores posibles para la dimensión country, por lo que, si genera informes solo sobre country, no podrá obtener más de 300 filas, incluso si establece limit en un valor más alto.

Para obtener más información sobre este parámetro de paginación, consulta Paginación.
metricAggregations[]

enum (MetricAggregation)

Agregación de métricas. Los valores de métricas agregadas se mostrarán en las filas en las que dimensionValues se establezcan en "RESERVED_(MetricAggregate)".
orderBys[]

object (OrderBy)

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

string

Un código de moneda en formato ISO4217, como "AED", "USD" o "JPY". Si el campo está vacío, el informe usará la moneda predeterminada de la propiedad.
cohortSpec

object (CohortSpec)

Grupo de cohorte asociado con esta solicitud. Si hay un grupo de cohorte en la solicitud, la dimensión "cohorte" debe estar presente.
keepEmptyRows

boolean

Si es falso o no se especifica, no se mostrarán las filas con métricas iguales a 0. Si es verdadero, estas filas se mostrarán si no las quita un filtro por separado.

Independientemente del parámetro de configuración keepEmptyRows, solo se pueden mostrar en un informe los datos registrados por la propiedad de Google Analytics (GA4).

Por ejemplo, si una propiedad nunca registra un evento purchase, una consulta para la dimensión eventName y la métrica eventCount no tendrá una fila eventName: "purchase" y eventCount: 0.
returnPropertyQuota

boolean

Activa o desactiva si se muestra el estado actual de la cuota de esta propiedad de Analytics. La cuota se muestra en PropertyQuota.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de RunReportResponse.

Permisos 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