- Solicitud HTTP
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
- RunReportRequest
- Pruébala
Muestra varios informes en un lote. Todos los informes deben corresponder a la misma propiedad GA4.
Solicitud HTTP
POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:batchRunReports
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
Parámetros | |
---|---|
property |
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. Si deseas obtener más información, consulta dónde encontrar tu ID de propiedad. Esta propiedad se debe especificar para el lote. Es posible que la propiedad dentro de RunReportRequest no esté especificada o sea coherente con esta propiedad. Ejemplo: properties/1234 |
Cuerpo de la solicitud
El cuerpo de la solicitud contiene datos con la siguiente estructura:
Representación JSON |
---|
{
"requests": [
{
object ( |
Campos | |
---|---|
requests[] |
Solicitudes individuales. Cada solicitud tiene una respuesta de informe distinta. Se permiten hasta 5 solicitudes por lotes. |
Cuerpo de la respuesta
Es la respuesta por lotes que contiene varios informes.
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
Representación JSON |
---|
{
"reports": [
{
object ( |
Campos | |
---|---|
reports[] |
Respuestas individuales. Cada respuesta tiene una solicitud de informe diferente. |
kind |
Identifica qué tipo de recurso es 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
RunReportRequest
Es la solicitud para generar un informe.
Representación JSON |
---|
{ "property": string, "dimensions": [ { object ( |
Campos | |
---|---|
property |
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. Si deseas obtener más información, consulta dónde encontrar tu ID de propiedad. Dentro de una solicitud por lotes, esta propiedad no debe estar especificada o ser coherente con la propiedad a nivel del lote. Ejemplo: properties/1234 |
dimensions[] |
Son las dimensiones solicitadas y que se muestran. |
metrics[] |
Las métricas solicitadas y que se muestran. |
dateRanges[] |
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 los eventos de esos días se incluirán en las filas de respuesta de ambos períodos. En una solicitud de cohorte, este |
dimensionFilter |
Los filtros de dimensión 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 |
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 SQL. No se pueden usar las dimensiones en este filtro. |
offset |
El recuento de filas de la fila de inicio. La primera fila se cuenta como la fila 0. Cuando se 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 Para obtener más información sobre este parámetro de paginación, consulta Paginación. |
limit |
Es la 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, sin importar cuántas pidas. El valor de La API también puede mostrar menos filas que la Para obtener más información sobre este parámetro de paginación, consulta Paginación. |
metricAggregations[] |
Agregación de métricas. Los valores de métricas agregados se mostrarán en las filas en las que dimensionValues se establezcan en "RESERVED_(MetricAggregation)". |
orderBys[] |
Especifica cómo se ordenan las filas en la respuesta. |
currencyCode |
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 |
Grupo de cohorte asociado con esta solicitud. Si hay un grupo de cohorte en la solicitud, la dimensión "cohorte" debe estar presente. |
keepEmptyRows |
Si es falso o no se especifica, no se mostrará cada fila con todas las métricas iguales a 0. Si es verdadero, estas filas se mostrarán si un filtro no las quita por separado. A pesar del parámetro de configuración Por ejemplo, si una propiedad nunca registra un evento |
returnPropertyQuota |
Activa o desactiva si se muestra el estado actual de la cuota de esta propiedad de Analytics. La cuota se muestra en PropertyQuota. |