Method: properties.batchRunReports

Devuelve varios informes en un lote. Todos los informes deben corresponder a la misma propiedad de Google Analytics.

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

Parámetros
property

string

Es un identificador de propiedad de Google Analytics cuyos eventos se rastrean. Se especifica en la ruta de URL y no en el cuerpo. Para obtener más información, consulta dónde encontrar el ID de tu propiedad. Esta propiedad se debe especificar para el lote. La propiedad dentro de RunReportRequest puede no especificarse 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)

Son solicitudes individuales. Cada solicitud tiene una respuesta de informe independiente. Cada solicitud por lotes puede incluir hasta 5 solicitudes.

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

object (RunReportResponse)

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

string

Identifica qué tipo de recurso 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 permisos 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,
  "comparisons": [
    {
      object (Comparison)
    }
  ]
}
Campos
property

string

Es un identificador de propiedad de Google Analytics cuyos eventos se rastrean. Se especifica en la ruta de URL y no en el cuerpo. Para obtener más información, consulta dónde encontrar el ID de tu propiedad. En una solicitud por lotes, esta propiedad no debe especificarse o debe ser coherente con la propiedad a nivel del lote.

Ejemplo: properties/1234
dimensions[]

object (Dimension)

Son las dimensiones solicitadas y mostradas.
metrics[]

object (Metric)

Son las métricas solicitadas y que se muestran.
dateRanges[]

object (DateRange)

Son los períodos de los datos que se leerán. Si se solicitan varios períodos, cada fila de la respuesta contendrá un índice de período basado en cero. Si dos períodos se superponen, los datos del evento para los días superpuestos se incluyen en las filas de respuesta para ambos períodos. En una solicitud de cohorte, este dateRanges debe quedar sin especificar.
dimensionFilter

object (FilterExpression)

Los filtros de dimensión te permiten solicitar solo valores de dimensión específicos en el informe. Para obtener más información, consulta Conceptos básicos de los filtros de dimensiones y mira los ejemplos. Las métricas no se pueden usar en este filtro.
metricFilter

object (FilterExpression)

Es la cláusula de filtro de las métricas. Se aplica después de agregar las filas del informe, de forma similar a la cláusula having de SQL. No se pueden usar dimensiones en este filtro.
offset

string (int64 format)

Es el recuento de filas de la fila inicial. La primera fila se cuenta como la fila 0.

Cuando se realiza la paginación, la primera solicitud no especifica un desplazamiento o, de manera equivalente, establece el desplazamiento en 0. La primera solicitud devuelve el primer limit de filas. La segunda solicitud establece el desplazamiento en el limit de la primera solicitud, y devuelve el segundo limit de filas.

Para obtener más información sobre este parámetro de paginación, consulta Paginación.
limit

string (int64 format)

Es la cantidad de filas que se devolverán. Si no se especifica, se devuelven 10,000 filas. La API devuelve un máximo de 250,000 filas por solicitud, sin importar cuántas solicites. limit debe ser positivo.

La API también puede devolver menos filas que el limit solicitado si no hay tantos valores de dimensión como el limit. Por ejemplo, hay menos de 300 valores posibles para la dimensión country, por lo que, cuando generas informes solo sobre country, no puedes obtener más de 300 filas, incluso si estableces 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)

Es la agregación de métricas. Los valores de las métricas agregadas se mostrarán en las filas en las que dimensionValues esté establecido como "RESERVED_(MetricAggregation)". Los agregados que incluyen comparaciones y varios períodos se agregarán según los períodos.
orderBys[]

object (OrderBy)

Especifica cómo se ordenan las filas en la respuesta. Las solicitudes que incluyen comparaciones y varios períodos tendrán cláusulas order by aplicadas a las comparaciones.
currencyCode

string

Es un código de moneda en formato ISO4217, como "AED", "USD" o "JPY". Si el campo está vacío, el informe usa la moneda predeterminada de la propiedad.
cohortSpec

object (CohortSpec)

Es el grupo de cohortes asociado a esta solicitud. Si hay un grupo de cohortes en la solicitud, debe estar presente la dimensión "cohorte".
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, se devolverán estas filas si no se quitan por separado con un filtro.

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.

Por ejemplo, si una propiedad nunca registra un evento purchase, una búsqueda de la dimensión eventName y la métrica eventCount no tendrá una fila eventName: "purchase" y eventCount: 0.
returnPropertyQuota

boolean

Alterna si se debe devolver el estado actual de la cuota de esta propiedad de Google Analytics. La cuota se devuelve en PropertyQuota.
comparisons[]

object (Comparison)

Opcional. Es la configuración de las comparaciones solicitadas y mostradas. La solicitud solo requiere un campo de comparaciones para recibir una columna de comparación en la respuesta.