Method: batchRunReports

Muestra varios informes en un lote. Todos los informes deben ser de 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 (Entity)
  },
  "requests": [
    {
      object (RunReportRequest)
    }
  ]
}
Campos
entity

object (Entity)

Una propiedad de cuyos eventos se hace un seguimiento. Esta entidad se debe especificar para el lote. La entidad dentro de RunReportRequest puede no estar especificada o ser coherente con esta entidad.
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

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

La respuesta por lotes que contiene varios informes.

Representación JSON 
{
  "reports": [
    {
      object (RunReportResponse)
    }
  ]
}
Campos
reports[]

object (RunReportResponse)

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

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 (Entity)
  },
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean
}
Campos
entity

object (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 de lote.
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.
offset

string (int64 format)

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

string (int64 format)

Cantidad de filas que se mostrarán. Si no se especifica el parámetro limit, se muestran 10,000 filas. La API devuelve un máximo de 100,000 filas por solicitud, sin importar cuántas tengas.
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)".
dimensionFilter

object (FilterExpression)

La cláusula de filtro de las dimensiones. Las dimensiones deben solicitarse para utilizarse en este filtro. No se pueden usar métricas en este filtro.
metricFilter

object (FilterExpression)

La cláusula de filtro de las métricas. Se aplica en la fase posterior a la agregación, de manera similar a la cláusula de cláusula de SQL. Se deben solicitar las métricas para que se usen en este filtro. No se pueden usar dimensiones en este filtro.
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 entidad.
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.
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.