Method: properties.batchRunPivotReports

Renvoie plusieurs rapports de tableaux croisés dynamiques dans un lot. 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é GA4 Google Analytics dont les événements sont suivis. Il est spécifié dans le chemin de l'URL et non dans le corps. Pour en savoir plus, consultez 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 être cohérente avec cette propriété.

Exemple: Properties/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 de tableau croisé dynamique distincte. Chaque requête par lot peut comporter 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é.
kind

string

Identifie le type de ressource de ce message. Ce kind est toujours la chaîne fixe "analyticsData#batchRunPivotReports". Utile pour distinguer les types de réponses au format 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,
  "comparisons": [
    {
      object (Comparison)
    }
  ]
}
Champs
property

string

Un identifiant de propriété GA4 Google Analytics dont les événements sont suivis. Il est spécifié dans le chemin de l'URL et non dans le corps. Pour en savoir plus, consultez Où trouver votre ID de propriété. Dans une requête par lot, cette propriété doit être soit non spécifiée, soit cohérente avec la propriété au niveau du lot.

Exemple: Properties/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'un des éléments suivants: metric_expression, metricFilter et orderBys.
dateRanges[]

object (DateRange)

Plage de dates à partir de laquelle récupérer les données d'événement du 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. Une dimension spéciale dont le nom de champ est "dateRange" peuvent être inclus dans les noms de champs d'un tableau croisé dynamique ; s'ils sont inclus, le rapport effectue une comparaison entre les plages de dates. Dans une demande de cohorte, ce dateRanges ne doit pas être spécifié.
pivots[]

object (Pivot)

Décrit le format visuel des dimensions du rapport, sous forme de colonnes ou de lignes. L'union des noms de champs (noms des dimensions) dans tous les tableaux croisés dynamiques doit constituer un sous-ensemble de noms de dimensions définis dans "Dimensions". Deux tableaux croisés dynamiques ne peuvent pas partager une 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 pouvoir les utiliser dans 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, semblable à la clause SQL HAVING. Les métriques doivent faire l'objet d'une demande pour être utilisées dans ce filtre. Impossible d'utiliser les dimensions dans ce filtre.
currencyCode

string

Code de devise au format ISO4217, 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 cohortes associé à cette demande. Si la requête contient un groupe de cohortes, doit être présente.
keepEmptyRows

boolean

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

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 ne comportera 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.
comparisons[]

object (Comparison)

Facultatif. Configuration des comparaisons demandées et affichées. La requête nécessite à la fois un champ de comparaisons et une dimension de comparaisons pour recevoir une colonne de comparaison dans la réponse.