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 son 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 en función de algunos criterios comunes, como el país o el nombre del evento.

Una guía para crear solicitudes y para comprender las respuestas, consulte 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

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. En una solicitud por lotes, esta propiedad debe no estar especificada o ser coherente con la propiedad de 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,
  "comparisons": [
    {
      object (Comparison)
    }
  ]
}
Campos
dimensions[]

object (Dimension)

Las dimensiones solicitadas y mostradas.
metrics[]

object (Metric)

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

object (DateRange)

Períodos de datos para leer. 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 esos días se incluirán 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 dimensión te permiten solicitar solo valores de dimensión específicos en el informe. Para obtener más información, consulta Fundamentos 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 “Tening” de SQL. No se pueden utilizar dimensiones en este filtro.
offset

string (int64 format)

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

Durante la paginación, la primera solicitud no especifica el desplazamiento. o, de forma equivalente, establece el desplazamiento en 0; la primera solicitud muestra el primer limit de las filas. La segunda solicitud establece el desplazamiento al limit de la primera. 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)

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 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 limit. Por ejemplo, hay menos de 300 valores posibles para la dimensión country, por lo que, cuando se informa solo sobre country, no puedes obtener más de 300 filas, incluso si estableces limit con 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 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.
currencyCode

string

Es 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 "cohorte" debe estar presente.
keepEmptyRows

boolean

Si es falso o no se especifica, no se mostrará cada fila con todas las métricas iguales a 0. Si el valor es "true", estas filas se mostrarán si un filtro no las quita por separado.

Independientemente de este parámetro de configuración de 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 la opción para que se muestre el estado actual de la cuota de esta propiedad de Analytics. La cuota se muestra en PropertyQuota.
comparisons[]

object (Comparison)

Opcional. La configuración de las comparaciones solicitadas y que se muestran. La solicitud solo requiere un campo de comparaciones para recibir una columna de comparación en la respuesta.

Cuerpo de la respuesta

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

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