Method: properties.batchRunReports

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

string

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. Se debe especificar esta propiedad para el lote. La propiedad dentro de RunReportRequest puede no estar especificada o ser 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 (RunReportRequest)
    }
  ]
}
Campos
requests[]

object (RunReportRequest)

Solicitudes individuales. Cada solicitud tiene una respuesta de informe independiente. Cada solicitud por lotes se permite hasta 5 solicitudes.

Cuerpo de la respuesta

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 (RunReportResponse)
    }
  ],
  "kind": string
}
Campos
reports[]

object (RunReportResponse)

Respuestas individuales. Cada respuesta tiene una solicitud de informe independiente.
kind

string

Identifica el tipo de recurso que es este mensaje. Este kind siempre es la cadena fija “analyticsData#batchRunReports”. Es útil para distinguir entre los tipos de respuesta en JSON.

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 (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
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 la URL y no en el cuerpo. Para obtener más información, consulta dónde encontrar tu ID de propiedad. Dentro de una solicitud por lotes, esta propiedad debe no estar especificada o ser coherente con la propiedad a nivel de lote.

Ejemplo: properties/1234
dimensions[]

object (Dimension)

Son las dimensiones solicitadas y que se muestran.
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 superpuestos se incluyen en las filas de respuesta de ambos períodos. En una solicitud de cohorte, no se debe especificar este dateRanges.
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 ejemplos del artículo Aspectos básicos de los filtros de dimensión. 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 cláusula de SQL. No se pueden usar 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 se realiza la paginación, la primera solicitud no especifica el desplazamiento o, de manera equivalente, lo establece 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 la segunda solicitud limit de 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 devuelve un máximo de 250,000 filas por solicitud, sin importar cuántas tengas. 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 tanto, si genera informes solo de 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 agregados se mostrarán en las filas en las que dimensionValues se configuren como "RESERVED_(MetricAggregation)".
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 utilizará 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á 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.

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 sobre 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.