Method: properties.batchRunPivotReports

Muestra varios informes dinámicos 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

Un identificador de 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 el ID de tu propiedad. Se debe especificar esta propiedad para el lote. Es posible que la propiedad dentro de RunPivotReportRequest no esté especificada o sea 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 dinámico independiente. Se permiten hasta 5 solicitudes por lotes.

Cuerpo de la respuesta

La respuesta por lotes que contiene varios informes dinámicos.

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 dinámico independiente.
kind

string

Identifica el tipo de recurso que es este mensaje. Este kind siempre es la string fija "analyticsData#batchRunPivotReports". Es útil para distinguir entre tipos de respuesta en JSON.

Permisos 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

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

Un identificador de 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 el ID de tu propiedad. Dentro de una solicitud por lotes, esta propiedad no debe 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 en una de las siguientes opciones: 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 deben usarse en uno de los siguientes objetos: metric_expression, metricFilter o orderBys.
dateRanges[]

object (DateRange)

Es el período durante el cual se recuperan 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 Pivot; si se incluye, el informe hace una comparación entre períodos. En una solicitud de cohorte, este dateRanges no debe especificarse.
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 hay dos elementos dinámicos 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. Se deben solicitar las dimensiones para usarlas 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 de agregación posterior, de manera similar a la cláusula de tener de SQL. Se deben solicitar las métricas para usarlas en este filtro. No se pueden usar las 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 usará 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án las filas con métricas iguales a 0. Si es verdadero, estas filas se mostrarán si no las quita un filtro por separado.

Independientemente del parámetro de configuración 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 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 muestra el estado actual de la cuota de esta propiedad de Analytics. La cuota se muestra en PropertyQuota.