- Solicitud HTTP
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Alcances de la autorización
- RunReportRequest
- Pruébala
Muestra varios informes en un lote. Todos los informes deben ser para la misma entidad.
Solicitud HTTP
POST https://analyticsdata.googleapis.com/v1alpha:batchRunReports
La URL usa la sintaxis de la transcodificación gRPC.
Cuerpo de la solicitud
El cuerpo de la solicitud contiene datos con la siguiente estructura:
Representación JSON | |
---|---|
{ "entity": { object ( |
Campos | |
---|---|
entity |
Una propiedad de cuyos eventos se hace un seguimiento. Esta entidad se debe especificar para el lote. Es posible que la entidad en RunReportRequest no esté especificada o sea coherente con ella. |
requests[] |
Solicitudes individuales. Cada solicitud tiene una respuesta de informe distinta. Se permiten hasta 5 solicitudes por lotes. |
Cuerpo de la respuesta
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
Es la respuesta por lotes que contiene varios informes.
Representación JSON | |
---|---|
{
"reports": [
{
object ( |
Campos | |
---|---|
reports[] |
Respuestas individuales. Cada respuesta tiene una solicitud de informe diferente. |
Alcances 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
RunReportRequest
Es la solicitud para generar un informe.
Representación JSON | |
---|---|
{ "entity": { object ( |
Campos | |
---|---|
entity |
Una propiedad de cuyos eventos se hace un seguimiento. Dentro de una solicitud por lotes, esta entidad no debe estar especificada o ser coherente con la entidad a nivel del lote. |
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 |
offset |
El recuento de filas de la fila de inicio. La primera fila se cuenta como la fila 0. |
limit |
Es la cantidad de filas que se mostrarán. Si no se especifica el parámetro |
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)". |
dimensionFilter |
La cláusula de filtro de dimensiones. Las dimensiones deben solicitarse para usarse en este filtro. No se pueden usar métricas en este filtro. |
metricFilter |
La cláusula de filtro de las métricas. Se aplica en la fase posterior de agregación, de manera similar a la cláusula SQL. Se deben solicitar las métricas para usarlas en este filtro. No se pueden usar las dimensiones en este filtro. |
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 entidad. |
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. |
returnPropertyQuota |
Activa o desactiva si se muestra el estado actual de la cuota de esta propiedad de Analytics. La cuota se muestra en PropertyQuota. |