Cette page a été traduite par l'API Cloud Translation.

Method: properties.runReport

Requête HTTP
Paramètres de chemin d'accès
Corps de la requête
- Représentation JSON
Corps de la réponse
Champs d'application des autorisations
Essayer

Affiche un rapport personnalisé sur vos données d'événement Google Analytics. Les rapports contiennent des statistiques issues des données collectées par le code de suivi Google Analytics. Les données renvoyées par l'API se présentent sous la forme d'un tableau avec des colonnes pour les dimensions et métriques demandées. Les métriques sont des mesures individuelles de l'activité des utilisateurs sur votre propriété (utilisateurs actifs ou nombre d'événements, par exemple). Les dimensions permettent de répartir les métriques en fonction de certains critères courants, tels que le pays ou le nom d'un événement.

Pour savoir comment créer des requêtes comprendre les réponses, consultez l'article Créer un rapport.

Requête HTTP

POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:runReport

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres

Paramètres
`property`	`string` Un identifiant de propriété GA4 Google Analytics dont les événements sont suivis. Il est spécifié dans le chemin de l'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 soit non spécifiée, soit cohérente avec la propriété au niveau du lot. Exemple: Properties/1234

property

string

Un identifiant de propriété GA4 Google Analytics dont les événements sont suivis. Il est spécifié dans le chemin de l'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 soit non spécifiée, soit cohérente avec la propriété au niveau du lot.

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

Représentation JSON
{ "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`) } ] }

{
  "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
`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 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 des jours concernés sont incluses dans les lignes de réponse pour les deux plages de dates. Dans une demande de cohorte, ce `dateRanges` ne doit pas être 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 et voir des exemples, reportez-vous à la section 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 avoir agrégé les lignes du rapport, de la même manière que la clause SQL "Hunter". Impossible d'utiliser des dimensions dans ce filtre.
`offset`	`string (int64 format)` Nombre de lignes de la première ligne. La première ligne est comptabilisée comme la ligne 0. Lors de la pagination, la première requête ne spécifie pas de décalage ; ou une valeur é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 un décalage par rapport à la valeur `limit` de la première requête. la deuxième requête renvoie la deuxième valeur `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é. La valeur de `limit` doit être positive. L'API peut également renvoyer moins de lignes que la valeur `limit` demandée s'il n'y a pas autant de valeurs de dimension que `limit`. Par exemple, il existe moins de 300 valeurs possibles pour la dimension "`country`". Ainsi, lorsque vous créez un rapport ne portant que sur la `country`, vous ne pouvez pas obtenir plus de 300 lignes, même si vous définissez 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 des métriques Les valeurs des métriques agrégées seront affichées sur les lignes où les dimensionsValues 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 ISO4217, 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 cohortes associé à cette demande. Si la requête contient un groupe de cohortes, doit être présente.
`keepEmptyRows`	`boolean` Si la valeur est "false" ou si aucune valeur n'est spécifiée, les lignes dont toutes les métriques sont égales à 0 ne sont pas renvoyées. Si la valeur est "true", ces lignes sont renvoyées si elles ne sont pas supprimées séparément par un filtre. 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` ne comportera 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.
`comparisons[]`	`object (Comparison)` Facultatif. Configuration des comparaisons demandées et affichées. La requête ne nécessite qu'un champ de comparaisons pour recevoir une colonne de comparaison dans la réponse.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de RunReportResponse.

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