- Requête HTTP
- Paramètres de chemin d'accès
- Corps de la requête
- 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 comportant 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é (par exemple, les utilisateurs actifs ou le nombre d'événements). Les dimensions permettent de répartir les métriques en fonction de critères courants, comme le pays ou le nom de l'événement.
Pour savoir comment créer des requêtes et comprendre les réponses, consultez 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 | |
---|---|
property |
Identifiant de propriété Google Analytics GA4 dont les événements font l'objet d'un suivi. Les valeurs sont spécifiées 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 doit correspondre à la propriété au niveau du lot. 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 |
---|
{ "dimensions": [ { object ( |
Champs | |
---|---|
dimensions[] |
Dimensions demandées et affichées. |
metrics[] |
Métriques demandées et affichées. |
dateRanges[] |
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 |
dimensionFilter |
Les filtres de dimensions vous permettent de ne demander que des valeurs de dimensions spécifiques dans le rapport. Pour en savoir plus et voir des exemples, consultez l'article Principes de base des filtres de dimensions. Impossible d'utiliser des métriques avec ce filtre. |
metricFilter |
Clause de filtre des métriques. Appliqué après l'agrégation des lignes du rapport, semblable à la clause SQL ayant une clause. Impossible d'utiliser des dimensions avec ce filtre. |
offset |
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 le décalage sur 0. La première requête renvoie les Pour en savoir plus sur ce paramètre de pagination, consultez la section Pagination. |
limit |
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é. L'API peut également renvoyer moins de lignes que le Pour en savoir plus sur ce paramètre de pagination, consultez la section Pagination. |
metricAggregations[] |
Agrégation de métriques. Les valeurs de métriques agrégées s'affichent dans les lignes où les valeurs de dimensionValue sont définies sur "RESERVED_(MetricAggregation)". |
orderBys[] |
Spécifie l'ordre des lignes dans la réponse. |
currencyCode |
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 |
Groupe de cohorte associé à cette demande. Si la demande comporte un groupe de cohorte, la dimension "cohorte" doit être présente. |
keepEmptyRows |
Si la valeur est "false" ou n'est pas 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 sont renvoyées si elles ne sont pas supprimées séparément par un filtre. Quel que soit le paramètre Par exemple, si une propriété ne consigne jamais d'événement |
returnPropertyQuota |
Détermine si l'état actuel du quota de cette propriété Analytics doit être renvoyé. Le quota est renvoyé dans PropertyQuota. |
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