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 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é 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 reçoit 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 demande de rapport distincte.
kind

string

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

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 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)

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

object (Metric)

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

object (DateRange)

Plages de dates des données à lire. Si plusieurs plages de dates sont demandées, chaque ligne de réponse contiendra un index de plage de dates basé sur zéro. Si deux plages de dates se chevauchent, les données d'événement pour les jours concernés sont incluses dans les lignes de réponse pour les deux plages de dates. Dans une requête de cohorte, ce dateRanges doit être non spécifié.
dimensionFilter

object (FilterExpression)

Les filtres de dimensions vous permettent de demander uniquement des valeurs de dimensions spécifiques dans le rapport. Pour en savoir plus, consultez Principes de base des filtres de dimension pour obtenir des exemples. Les métriques ne peuvent pas être utilisées 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 considérée comme la ligne 0.

Lors de la pagination, la première requête ne spécifie pas de décalage ou, de manière équivalente, définit le décalage sur 0. La première requête renvoie les limit premières 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 Pagination.
limit

string (int64 format)

Nombre de lignes à renvoyer. Si aucune valeur n'est spécifiée, 10 000 lignes sont renvoyées. L'API renvoie un maximum de 250 000 lignes par requête, quel que soit le nombre demandé. limit doit être positif.

L'API peut également renvoyer moins de lignes que le limit demandé, s'il n'y a pas autant de valeurs de dimension que le limit. Par exemple, la dimension country ne peut pas prendre plus de 300 valeurs. Par conséquent, si vous générez des rapports uniquement sur country, 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 Pagination.
metricAggregations[]

enum (MetricAggregation)

Agrégation des métriques. Les valeurs agrégées des métriques s'affichent dans les lignes où dimensionValues est défini sur "RESERVED_(MetricAggregation)". Les agrégats incluant à la fois des comparaisons et plusieurs plages de dates seront agrégés en fonction des plages de dates.
orderBys[]

object (OrderBy)

Spécifie l'ordre des lignes dans la réponse. Les demandes incluant à la fois des comparaisons et plusieurs plages de dates auront des clauses "order by" appliquées aux comparaisons.
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 ne nécessite qu'un champ de comparaison pour recevoir une colonne de comparaison dans la réponse.