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

Es un identificador de la propiedad GA4 de Google Analytics de cuyos eventos se hace un seguimiento. Se especifica en la ruta de URL, 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. 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 puede tener hasta 5 solicitudes.

Cuerpo de la respuesta

La respuesta por lotes que contiene varios informes de elementos 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 de tabla dinámica independiente.
kind

string

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

Alcances 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

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,
  "comparisons": [
    {
      object (Comparison)
    }
  ]
}
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 URL, no en el cuerpo. Para obtener más información, consulta dónde encontrar tu ID de propiedad. En una solicitud por lotes, esta propiedad debe no estar especificada o ser coherente con la propiedad de nivel de lote.

Ejemplo: properties/1234
dimensions[]

object (Dimension)

Las dimensiones solicitadas. Una de las siguientes personas debe utilizar todas las dimensiones definidas: dimensionExpression, dimensionFilter, pivots, orderBys.
metrics[]

object (Metric)

Las métricas solicitadas; se debe especificar al menos una métrica. Uno de los siguientes elementos debe usar todas las métricas definidas: metric_expression, metricFilter, orderBys.
dateRanges[]

object (DateRange)

Es el período en el que se recuperan los datos de eventos para el informe. Si se especifican varios períodos, en el informe se utilizan los datos de eventos de cada uno de ellos. Una dimensión especial con el nombre de campo "dateRange" puede incluirse en los nombres de campo de una tabla dinámica; si se incluye, el informe se compara entre los 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 los fieldNames (nombres de las dimensiones) en todas las tablas dinámicas debe ser un subconjunto de los nombres de las dimensiones definidas 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)

Es la cláusula de filtro de las dimensiones. Se debe solicitar el uso de las dimensiones 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 que tiene SQL. Se debe solicitar el uso de métricas en este filtro. No se pueden utilizar dimensiones en este filtro.
currencyCode

string

Es 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 "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 el valor es verdadero, se mostrarán estas filas 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 para la dimensión eventName y la métrica eventCount no tendrá una fila eventName: "purchase". y eventCount: 0.
returnPropertyQuota

boolean

Activa o desactiva la opción para que se muestre el estado actual de la cuota de esta propiedad de Analytics. La cuota se muestra en PropertyQuota.
comparisons[]

object (Comparison)

Opcional. La configuración de las comparaciones solicitadas y que se muestran. La solicitud requiere un campo de comparaciones y una dimensión de comparaciones para recibir una columna de comparación en la respuesta.