- Solicitud HTTP
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Alcances 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 |
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 ( |
Campos | |
---|---|
requests[] |
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 ( |
Campos | |
---|---|
reports[] |
Respuestas individuales. Cada respuesta tiene una solicitud de informe independiente. |
kind |
Identifica el tipo de recurso que es este mensaje. Este |
Alcances 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 |
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[] |
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 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 |
dimensionFilter |
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 |
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 |
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 Para obtener más información sobre este parámetro de paginación, consulta Paginación. |
limit |
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. 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 configuren como "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 utilizará 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. Independientemente de este parámetro de configuración de 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. |
comparisons[] |
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. |