Method: properties.batchRunPivotReports

Muestra varios informes dinámicos en un lote. Todos los informes deben ser para 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 propiedad GA4 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 tu ID de propiedad. Esta propiedad se debe especificar 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 independiente para el informe dinámico. Cada solicitud por lotes admite hasta 5 solicitudes.

Cuerpo de la respuesta

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

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

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 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 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 propiedad GA4 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 tu ID de propiedad. Dentro de una solicitud por lotes, esta propiedad no debe especificarse o ser coherente con la propiedad a nivel del lote.

Ejemplo: properties/1234
dimensions[]

object (Dimension)

Las dimensiones solicitadas. Todas las dimensiones definidas deben ser utilizadas por una de las siguientes opciones: dimensionExpression, dimensionFilter, pivots y targetSdkVersions.
metrics[]

object (Metric)

Se deben especificar las métricas solicitadas. Para usar todas las métricas definidas, use uno de los siguientes parámetros: metric_expression, metricFilter, targetSdkVersions.
dateRanges[]

object (DateRange)

Es el período que se utiliza para recuperar los datos del evento del informe. Si se especifican varios períodos, los datos de eventos de cada uno se usan en el informe. 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 compara entre 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 dimensiones) en todos los pivotes debe ser un subconjunto de nombres de dimensiones definidos en Dimensiones. No hay dos elementos dinámicos que puedan compartir 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. Es necesario solicitar el uso de las dimensiones de este filtro. No se pueden usar las 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, similar a la cláusula de SQL. Se deben solicitar métricas para que se las use en este filtro. No se pueden usar las 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 usa 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, se mostrarán estas filas si un filtro no las quita por separado.

Independientemente de esta configuración de keepEmptyRows, solo se pueden mostrar los datos registrados en 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

Alterna si se muestra el estado actual de la cuota de esta propiedad de Analytics. La cuota se muestra en PropertyQuota.