Method: properties.batchRunPivotReports

Muestra varios informes de tabla dinámica en un lote. Todos los informes deben corresponder a la misma propiedad GA4.

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 la propiedad GA4 de Google Analytics de cuyos eventos se hace un seguimiento. Se especifica en la ruta de la URL y no en el cuerpo. Para obtener más información, consulta dónde encontrar tu ID de propiedad. Se debe especificar esta propiedad 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 independiente del informe de tabla dinámica. Cada solicitud por lotes se permite hasta 5 solicitudes.

Cuerpo de la respuesta

La respuesta por lotes que contiene varios informes de tabla dinámica.

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 tabla dinámica 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 alcances de OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

RunPivotReportRequest

Es la solicitud para generar un informe de tabla dinámica.

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
}
Campos
property

string

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

Ejemplo: properties/1234
dimensions[]

object (Dimension)

Son las dimensiones solicitadas. Todas las dimensiones definidas deben usarse con uno de los siguientes elementos: dimensionExpression, dimensionFilter, pivots y orderBys.
metrics[]

object (Metric)

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

object (DateRange)

Es el período para recuperar datos de eventos del informe. Si se especifican varios períodos, se utilizarán en el informe 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 los campos de Pivot; si se incluye, el informe realiza una comparación entre períodos. En una solicitud de cohorte, no se debe especificar este dateRanges.
pivots[]

object (Pivot)

Describe el formato visual de las dimensiones del informe en columnas o filas. La unión de fieldNames (nombres de dimensiones) en todas las tablas dinámicas debe ser un subconjunto de nombres de dimensiones definidos en Dimensions. No puede haber dos tablas dinámicas que compartan una dimensión. Una dimensión solo es visible si aparece en una tabla dinámica.
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.
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 propiedad.
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.

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 (GA4).

Por ejemplo, si una propiedad nunca registra un evento purchase, una consulta sobre 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 muestra el estado actual de la cuota de esta propiedad de Analytics. La cuota se muestra en PropertyQuota.