Method: properties.batchRunPivotReports

Renvoie plusieurs rapports croisés dynamiques à la fois. Tous les rapports doivent concerner la même propriété GA4.

Requête HTTP

POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:batchRunPivotReports

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
property

string

Un identifiant de propriété Google Analytics GA4 dont les événements sont suivis. Spécifié dans le chemin de l'URL et non dans le corps. Pour en savoir plus, découvrez où trouver votre ID de propriété. Cette propriété doit être spécifiée pour le lot. La propriété dans RunPivotReportRequest peut ne pas être spécifiée ou correspondre à cette propriété.

Exemple: propriétés/1234

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "requests": [
    {
      object (RunPivotReportRequest)
    }
  ]
}
Champs
requests[]

object (RunPivotReportRequest)

Requêtes individuelles Chaque demande est associée à une réponse de rapport croisé dynamique. Chaque requête par lot est autorisée jusqu'à cinq requêtes.

Corps de la réponse

Réponse par lot contenant plusieurs rapports de tableaux croisés dynamiques.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "pivotReports": [
    {
      object (RunPivotReportResponse)
    }
  ],
  "kind": string
}
Champs
pivotReports[]

object (RunPivotReportResponse)

Réponses individuelles. Chaque réponse est associée à une demande de rapport croisé dynamique.
kind

string

Identifie le type de ressource de ce message. Cet élément kind est toujours la chaîne fixe "analyticsData#batchRunPivotReports". Utile pour distinguer les types de réponses en JSON.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

RunPivotReportRequest

Demande de génération d'un rapport croisé dynamique.

Représentation 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
}
Champs
property

string

Un identifiant de propriété Google Analytics GA4 dont les événements sont suivis. Spécifié dans le chemin de l'URL et non dans le corps. Pour en savoir plus, découvrez où trouver votre ID de propriété. Dans une requête par lot, cette propriété ne doit pas être spécifiée ou correspondre à la propriété au niveau du lot.

Exemple: propriétés/1234
dimensions[]

object (Dimension)

Dimensions demandées. Toutes les dimensions définies doivent être utilisées par l'un des éléments suivants: dimensionExpression, dimensionFilter, pivots, orderBys.
metrics[]

object (Metric)

Métriques demandées. Vous devez en spécifier au moins une. Toutes les métriques définies doivent être utilisées par l'une des options suivantes: metric_expression, metricFilter ou orderBys.
dateRanges[]

object (DateRange)

Plage de dates pour laquelle récupérer les données d'événement pour le rapport. Si plusieurs plages de dates sont spécifiées, les données d'événement de chacune d'elles sont utilisées dans le rapport. Vous pouvez inclure une dimension spéciale portant le nom de champ "dateRange" dans les noms des champs d'un tableau croisé dynamique. Le cas échéant, le rapport compare les données entre les plages de dates. Dans une demande de cohorte, cet élément dateRanges ne doit pas être spécifié.
pivots[]

object (Pivot)

Décrit le format visuel des dimensions du rapport en colonnes ou en lignes. L'union des noms de champ (fieldNames) dans tous les tableaux croisés dynamiques doit être un sous-ensemble de noms de dimensions définis dans "Dimensions". Deux tableaux croisés dynamiques ne peuvent pas avoir la même dimension. Une dimension n'est visible que si elle apparaît dans un tableau croisé dynamique.
dimensionFilter

object (FilterExpression)

Clause de filtre des dimensions. Vous devez demander des dimensions pour ce filtre. Impossible d'utiliser des métriques dans ce filtre.
metricFilter

object (FilterExpression)

Clause de filtre des métriques. Appliquée lors de la phase post-agrégation, de la même manière que la clause SQL existante. Des métriques doivent être demandées pour être utilisées dans ce filtre. Impossible d'utiliser des dimensions avec ce filtre.
currencyCode

string

Code de devise au format ISO 4217, tel que "AED", "USD" ou "JPY". Si le champ est vide, le rapport utilise la devise par défaut de la propriété.
cohortSpec

object (CohortSpec)

Groupe de cohorte associé à cette demande. Si la requête comporte un groupe de cohorte, la dimension "cohorte" doit être présente.
keepEmptyRows

boolean

Si la valeur est "false" ou n'est pas spécifiée, aucune ligne dont toutes les métriques sont égales à 0 ne sera pas renvoyée. Si la valeur est "true", ces lignes sont renvoyées si un filtre ne les a pas supprimées séparément.

Quel que soit le paramètre keepEmptyRows, seules les données enregistrées par la propriété Google Analytics (GA4) peuvent être affichées dans un rapport.

Par exemple, si une propriété ne consigne jamais d'événement purchase, une requête pour la dimension eventName et la métrique eventCount n'aura pas de ligne eventName: "purchase" et eventCount: 0.
returnPropertyQuota

boolean

Indique si l'état actuel du quota de cette propriété Analytics doit être affiché. Le quota est renvoyé dans PropertyQuota.