Method: properties.batchRunPivotReports

Devuelve varios informes de datos cruzados 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/*}:batchRunPivotReports

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 RunPivotReportRequest 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 (RunPivotReportRequest)
    }
  ]
}
Campos
requests[]

object (RunPivotReportRequest)

Solicitudes individuales. Cada solicitud tiene una respuesta de informe de pivote independiente. Cada solicitud por lotes puede tener hasta 5 solicitudes.

Cuerpo de la respuesta

La respuesta por lotes que contiene varios informes de pivote

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

Representación JSON 
{
  "pivotReports": [
    {
      object (RunPivotReportResponse)
    }
  ],
  "kind": string
}
Campos
pivotReports[]

object (RunPivotReportResponse)

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

string

Identifica qué tipo de recurso es este mensaje. Este kind siempre es la cadena fija "analyticsData#batchRunPivotReports". 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

RunPivotReportRequest

Es la solicitud para generar un informe dinámico.

Representación JSON 
{
  "property": string,
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "pivots": [
    {
      object (Pivot)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "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 Todas las dimensiones definidas deben usarse con una de las siguientes opciones: dimensionExpression, dimensionFilter, pivots, orderBys.
metrics[]

object (Metric)

Las métricas solicitadas, se debe especificar al menos una métrica. Todas las métricas definidas deben usarse con una de las siguientes opciones: metric_expression, metricFilter, orderBys.
dateRanges[]

object (DateRange)

Es el período para recuperar los datos de eventos del informe. Si se especifican varios períodos, en el informe se usarán los datos de eventos de cada uno de ellos. Se puede incluir una dimensión especial con el nombre de campo "dateRange" en los nombres de campo de un pivote. Si se incluye, el informe realiza una comparación entre los períodos. En una solicitud de cohorte, este dateRanges no se debe especificar.
pivots[]

object (Pivot)

Describe el formato visual de las dimensiones del informe en columnas o filas. La unión de los fieldNames (nombres de las dimensiones) en todos los ejes debe ser un subconjunto de los nombres de las dimensiones definidos en Dimensiones. No se pueden compartir dimensiones entre dos tablas dinámicas. Una dimensión solo es visible si aparece en un pivote.
dimensionFilter

object (FilterExpression)

La cláusula de filtro de las dimensiones. Se deben solicitar las dimensiones para usarlas en este filtro. No se pueden usar métricas en este filtro.
metricFilter

object (FilterExpression)

Es 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 having de SQL. Se deben solicitar las métricas para usarlas en este filtro. No se pueden usar dimensiones en este filtro.
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 requiere un campo de comparaciones y una dimensión de comparaciones para recibir una columna de comparación en la respuesta.