Method: properties.batchRunReports

Devuelve varios informes en un lote. Todos los informes deben ser de 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 de acceso

Parámetros
property

string

Es un identificador de propiedad de Google Analytics cuyos eventos se registran. 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 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 puede tener 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 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 registran. 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. Dentro de 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)

Las dimensiones solicitadas y mostradas
metrics[]

object (Metric)

Las métricas solicitadas y mostradas
dateRanges[]

object (DateRange)

Son los períodos de los datos que se deben leer. 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 de eventos de los días superpuestos se incluyen en las filas de respuesta de ambos períodos. En una solicitud de cohorte, este dateRanges no se debe 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 obtén ejemplos. No se pueden usar métricas 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 manera 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 fila 0.

Cuando se pagina, la primera solicitud no especifica el desplazamiento, o lo que es equivalente, lo establece en 0. La primera solicitud muestra la primera limit de filas. La segunda solicitud establece el desplazamiento en el limit de la primera solicitud. La segunda solicitud muestra 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 mostrarán. Si no se especifica, se devuelven 10,000 filas. La API muestra un máximo de 250,000 filas por solicitud, independientemente de cuántas solicites. limit debe ser positivo.

La API también puede mostrar 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 se informa solo sobre country, no se pueden obtener más de 300 filas, incluso si se 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 las métricas agregadas se mostrarán en las filas en las que los dimensionValues estén configurados como "RESERVED_(MetricAggregation)". Los agregados que incluyan comparaciones y varios períodos se agregarán en función de los períodos.
orderBys[]

object (OrderBy)

Especifica cómo se ordenan las filas en la respuesta. Las solicitudes que incluyan comparaciones y varios períodos tendrán órdenes aplicados en las comparaciones.
currencyCode

string

Un código de moneda en formato ISO 4217, como "AED", "USD" o "JPY". Si el campo está vacío, el informe usará la moneda predeterminada de la propiedad.
cohortSpec

object (CohortSpec)

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

Independientemente de este parámetro de configuración 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 consulta para 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 debe mostrar el estado actual de la cuota de esta propiedad de Google Analytics. La cuota se muestra en PropertyQuota.
comparisons[]

object (Comparison)

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