Method: properties.batchRunPivotReports

Renvoie plusieurs rapports croisés 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 de propriété Google Analytics dont les événements sont suivis. Spécifié dans le chemin de l'URL et non dans le corps. Pour en savoir plus, consultez Où trouver l'ID de votre propriété. Cette propriété doit être spécifiée pour le lot. La propriété de 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 reçoit une réponse de rapport croisé 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.

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é distincte.
kind

string

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

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 de propriété Google Analytics dont les événements sont suivis. Spécifié dans le chemin de l'URL et non dans le corps. Pour en savoir plus, consultez Où trouver l'ID de votre propriété. Dans une requête par lot, cette propriété ne doit pas être spécifiée ou doit être 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)

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 ou orderBys.
dateRanges[]

object (DateRange)

Plage de dates pour récupérer les données d'événements pour le rapport. Si plusieurs plages de dates sont spécifiées, les données d'événement de chaque plage de dates 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 plages de dates. Dans une requête de cohorte, ce dateRanges doit être non spécifié.
pivots[]

object (Pivot)

Décrit le format visuel des dimensions du rapport dans les colonnes ou les lignes. L'union des fieldNames (noms de dimensions) dans tous les tableaux croisés dynamiques doit être un sous-ensemble des noms de dimensions définis dans "Dimensions". Deux tableaux croisés dynamiques ne peuvent pas partager 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 à utiliser des dimensions dans ce filtre. Les métriques ne peuvent pas être utilisées dans ce filtre.
metricFilter

object (FilterExpression)

Clause de filtre des métriques. Appliqué lors de la phase de post-agrégation, semblable à la clause HAVING de SQL. Pour pouvoir utiliser des métriques dans ce filtre, vous devez les demander. Vous ne pouvez pas utiliser de dimensions dans ce filtre.
currencyCode

string

Code de devise au format ISO4217, 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 cohortes associé à cette demande. Si la requête contient un groupe de cohortes, la dimension "cohort" (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 la valeur est "true", ces lignes seront 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é n'enregistre 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 s'il faut renvoyer l'état actuel du quota de cette propriété Google Analytics. 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 et une dimension de comparaison pour recevoir une colonne de comparaison dans la réponse.