Method: properties.batchRunReports

Affiche plusieurs rapports à la fois. Tous les rapports doivent concerner la même propriété GA4.

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

Un identifiant de propriété Google Analytics GA4 dont les événements sont suivis. Spécifié dans le chemin de l'URL et non dans le corps. Pour en savoir plus, découvrez où trouver votre ID de propriété. Cette propriété doit être spécifiée pour le lot. La propriété dans RunReportRequest peut ne pas être spécifiée ou correspondre à cette propriété.

Exemple: propriétés/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)

Requêtes individuelles Chaque demande est associée à une réponse de rapport distincte. Chaque requête par lot est autorisée jusqu'à 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. Cet élément kind est 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
}
Champs
property

string

Un identifiant de propriété Google Analytics GA4 dont les événements sont suivis. Spécifié dans le chemin de l'URL et non dans le corps. Pour en savoir plus, découvrez où trouver votre ID de propriété. Dans une requête par lot, cette propriété ne doit pas être spécifiée ou correspondre à la propriété au niveau du lot.

Exemple: propriétés/1234
dimensions[]

object (Dimension)

Dimensions demandées et affichées.
metrics[]

object (Metric)

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

object (DateRange)

Plages de dates correspondant aux 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 des jours concernés sont incluses dans les lignes de réponse pour les deux plages de dates. Dans une demande de cohorte, cet élément dateRanges ne doit pas être spécifié.
dimensionFilter

object (FilterExpression)

Les filtres de dimensions vous permettent de ne demander que des valeurs de dimensions spécifiques dans le rapport. Pour en savoir plus et obtenir des exemples, consultez l'article Principes de base des filtres de dimensions. Impossible d'utiliser des métriques dans ce filtre.
metricFilter

object (FilterExpression)

Clause de filtre des métriques. Appliqué après l'agrégation des lignes du rapport, semblable à la clause SQL existante. Impossible d'utiliser des dimensions avec ce filtre.
offset

string (int64 format)

Nombre de lignes de la première ligne. La première ligne correspond à 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 un décalage sur 0. La première requête renvoie les limit premières lignes. La deuxième requête définit un décalage sur le limit de la première requête, tandis que la deuxième 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 à afficher. 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, il existe moins de 300 valeurs possibles pour la dimension "country". Par conséquent, lorsque vous créez un rapport ne portant que sur "country", vous ne pouvez pas obtenir plus de 300 lignes, même si vous avez défini une valeur supérieure pour "limit".

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

enum (MetricAggregation)

Agrégation de métriques. Les valeurs de métriques agrégées s'affichent dans les lignes où les valeurs de dimension sont définies sur "RESERVED_(MetricAggregation)".
orderBys[]

object (OrderBy)

Spécifie l'ordre des lignes dans la réponse.
currencyCode

string

Code de devise au format ISO 4217, 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 cohorte associé à cette demande. Si la requête comporte un groupe de cohorte, la dimension "cohorte" doit être présente.
keepEmptyRows

boolean

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

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 n'aura 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.