Method: properties.batchRunPivotReports

Renvoie plusieurs rapports croisés dynamiques dans un lot. Tous les rapports doivent concerner la même propriété Google Analytics.

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

Identifiant d'une propriété Google Analytics dont les événements sont suivis. Spécifié dans le chemin d'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 être non spécifiée ou 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)

Demandes individuelles Chaque requête est associée à une réponse de rapport croisé dynamique distincte. Chaque requête par lot est limitée à cinq requêtes.

Corps de la réponse

Réponse par lot contenant plusieurs rapports 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 requête de rapport croisé distincte.
kind

string

Identifie le type de ressource de ce message. Cet 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

Requête 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

Identifiant d'une propriété Google Analytics dont les événements sont suivis. Spécifié dans le chemin d'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 non spécifiée ou 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 ou orderBys.
metrics[]

object (Metric)

Vous devez spécifier au moins une métrique parmi celles demandées. Toutes les métriques définies doivent être utilisées par l'un des éléments suivants: metric_expression, metricFilter ou orderBys.
dateRanges[]

object (DateRange)

Plage de dates pour récupérer les données d'événement pour le rapport. Si vous spécifiez plusieurs périodes, les données d'événement de chaque période sont utilisées dans le rapport. Une dimension spéciale avec le nom de champ "dateRange" peut être incluse dans les noms de champ d'un tableau croisé dynamique. Si elle est incluse, le rapport compare les périodes. Dans une requête de cohorte, ce 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 fieldNames (noms de dimension) de tous les pivots doit être un sous-ensemble des noms de dimension 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 à utiliser des dimensions dans ce filtre. Vous ne pouvez pas utiliser de métriques dans ce filtre.
metricFilter

object (FilterExpression)

Clause de filtre des métriques. Appliqué à la phase post-agrégation, semblable à la clause "having" en SQL. Les métriques doivent être demandées pour être utilisées dans ce filtre. Vous ne pouvez pas utiliser de dimensions dans ce filtre.
currencyCode

string

Code de devise au format ISO 4217, par exemple "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 requête. Si un groupe de cohortes est présent dans la requête, la dimension "cohorte" doit être présente.
keepEmptyRows

boolean

Si la valeur est "false" ou non spécifiée, chaque ligne dont toutes les métriques sont égales à 0 ne sera pas renvoyée. Si cette valeur est définie sur "true", ces lignes sont renvoyées si elles ne sont pas supprimées séparément par un filtre.

Quel que soit ce paramètre keepEmptyRows, seules les données enregistrées par la propriété Google Analytics 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é Google Analytics doit être renvoyé. 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 comparaison et une dimension de comparaison pour recevoir une colonne de comparaison dans la réponse.