Method: properties.batchRunReports

Renvoie plusieurs rapports 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/*}:batchRunReports

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 RunReportRequest 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 (RunReportRequest)
    }
  ]
}
Champs
requests[]

object (RunReportRequest)

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

Corps de la réponse

Réponse par lot contenant plusieurs rapports.

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

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

object (RunReportResponse)

Réponses individuelles. Chaque réponse est associée à une requête de rapport distincte.
kind

string

Identifie le type de ressource de ce message. Cet kind correspond toujours à la chaîne fixe "analyticsData#batchRunReports". 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

RunReportRequest

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

Représentation JSON 
{
  "property": string,
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "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)

Les dimensions demandées et affichées.
metrics[]

object (Metric)

Métriques demandées et affichées
dateRanges[]

object (DateRange)

Plage de dates des données à lire. Si plusieurs périodes sont demandées, chaque ligne de réponse contient un indice de période basé sur zéro. Si deux plages de dates se chevauchent, les données d'événement pour les jours qui se chevauchent sont incluses dans les lignes de réponse pour les deux plages de dates. Dans une requête de cohorte, ce dateRanges ne doit pas être spécifié.
dimensionFilter

object (FilterExpression)

Les filtres de dimension vous permettent de n'interroger que des valeurs de dimension spécifiques dans le rapport. Pour en savoir plus, consultez Principes de base des filtres de dimension pour obtenir des exemples. Vous ne pouvez pas utiliser de métriques dans ce filtre.
metricFilter

object (FilterExpression)

Clause de filtre des métriques. Appliqué après l'agrégation des lignes du rapport, comme la clause "having" de SQL. Vous ne pouvez pas utiliser de dimensions dans ce filtre.
offset

string (int64 format)

Nombre de lignes de la ligne de début. La première ligne est comptée comme la ligne 0.

Lors de la pagination, la première requête ne spécifie pas de décalage, ou équivaut à définir le décalage sur 0. La première requête renvoie les premières limit de lignes. La deuxième requête définit le décalage sur le limit de la première requête. La deuxième requête renvoie le deuxième limit de lignes.

Pour en savoir plus sur ce paramètre de pagination, consultez la section Pagination.
limit

string (int64 format)

Nombre de lignes à renvoyer. Si ce paramètre n'est pas spécifié, 10 000 lignes sont renvoyées. L'API renvoie un maximum de 250 000 lignes par requête, quel que soit le nombre de lignes que vous demandez. limit doit être positif.

L'API peut également renvoyer moins de lignes que l'limit demandée, si le nombre de valeurs de dimension est inférieur à celui de l'limit. Par exemple, il existe moins de 300 valeurs possibles pour la dimension country. Par conséquent, si vous n'utilisez que country dans vos rapports, vous ne pouvez pas obtenir plus de 300 lignes, même si vous définissez limit sur une valeur plus élevée.

Pour en savoir plus sur ce paramètre de pagination, consultez la section Pagination.
metricAggregations[]

enum (MetricAggregation)

Agrégation des métriques. Les valeurs de métrique agrégées s'affichent dans les lignes où les valeurs de dimension sont définies sur "RESERVED_(MetricAggregation)". Les agrégations incluant à la fois des comparaisons et plusieurs périodes seront agrégées en fonction des périodes.
orderBys[]

object (OrderBy)

Spécifie l'ordre des lignes dans la réponse. Les requêtes incluant à la fois des comparaisons et plusieurs plages de dates seront triées par ordre.
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 ne nécessite qu'un champ de comparaison pour recevoir une colonne de comparaison dans la réponse.