- 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
- MinuteRange
- Essayer
Affiche un rapport personnalisé des données d'événements en temps réel pour votre propriété. Les événements apparaissent dans les rapports en temps réel quelques secondes après leur envoi à Google Analytics. Les rapports "Temps réel" présentent des événements et des données d'utilisation sur des périodes allant de l'instant présent à 30 minutes auparavant (jusqu'à 60 minutes pour les propriétés Google Analytics 360).
Pour savoir comment créer des requêtes en temps réel et comprendre les réponses, consultez l'article Créer un rapport "Temps réel".
Requête HTTP
POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:runRealtimeReport
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
Paramètres | |
---|---|
property |
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é. 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. |
dimensionFilter |
Clause de filtre des dimensions. Impossible d'utiliser des métriques dans ce filtre. |
metricFilter |
Clause de filtre des métriques. Appliquée lors de la phase post-agrégation, de la même manière que la clause SQL existante. Impossible d'utiliser des dimensions avec ce filtre. |
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 |
metricAggregations[] |
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[] |
Spécifie l'ordre des lignes dans la réponse. |
returnPropertyQuota |
Indique si l'état actuel du quota en temps réel de cette propriété Analytics doit être affiché. Le quota est renvoyé dans PropertyQuota. |
minuteRanges[] |
Plages de minutes de données d'événement à lire. Si aucune valeur n'est spécifiée, une plage d'une minute sera utilisée pour les 30 dernières minutes. Si plusieurs plages de minutes sont demandées, chaque ligne de réponse contiendra un index de plage de minutes basé sur zéro. Si les plages de deux minutes se chevauchent, les données d'événement des minutes qui se chevauchent sont incluses dans les lignes de réponse des deux plages de minutes. |
Corps de la réponse
Tableau du rapport en temps réel de réponse correspondant à une requête.
Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :
Représentation JSON |
---|
{ "dimensionHeaders": [ { object ( |
Champs | |
---|---|
dimensionHeaders[] |
Décrit les colonnes de dimension. Le nombre de "DimensionHeaders" et leur ordre correspondent aux dimensions présentes dans les lignes. |
metricHeaders[] |
Décrit les colonnes de métriques. Le nombre de "MetricHeaders" et leur ordre correspondent aux métriques présentes dans les lignes. |
rows[] |
Lignes de combinaisons de valeurs de dimension et de valeurs de métriques dans le rapport. |
totals[] |
Si nécessaire, il s'agit des valeurs totales des métriques. |
maximums[] |
Si nécessaire, il s'agit des valeurs maximales des métriques. |
minimums[] |
Si nécessaire, il s'agit des valeurs minimales des métriques. |
rowCount |
Nombre total de lignes dans le résultat de la requête. |
propertyQuota |
État du quota en temps réel de cette propriété Analytics, y compris cette demande. |
kind |
Identifie le type de ressource de ce message. Cet élément |
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
MinuteRange
Un ensemble de minutes contiguës: startMinutesAgo
, startMinutesAgo + 1
, ..., endMinutesAgo
. Les requêtes sont autorisées pour des plages allant jusqu'à deux minutes.
Représentation JSON |
---|
{ "name": string, "startMinutesAgo": integer, "endMinutesAgo": integer } |
Champs | |
---|---|
name |
Attribue un nom à cette plage de minutes. La dimension |
startMinutesAgo |
Minutes (incluses) de début de la requête exprimées en nombre de minutes à l'avance. Par exemple, Si aucune valeur n'est spécifiée, la valeur par défaut de |
endMinutesAgo |
Minutes (incluses) de fin de la requête exprimées en nombre de minutes à l'avance. Ne peut pas être antérieur au Si aucune valeur n'est spécifiée, |