Method: properties.runRealtimeReport

Renvoie un rapport personnalisé sur les données d'événements en temps réel pour votre propriété. Les événements s'affichent dans les rapports en temps réel quelques secondes après leur envoi à Google Analytics. Les rapports "Temps réel" présentent les événements et les données d'utilisation sur des périodes comprises entre le moment présent et les 30 dernières minutes (jusqu'à 60 minutes pour les propriétés Google Analytics 360).

Pour savoir comment créer des requêtes en temps réel comprendre les réponses, reportez-vous à la section 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

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é.

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 
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "returnPropertyQuota": boolean,
  "minuteRanges": [
    {
      object (MinuteRange)
    }
  ]
}
Champs
dimensions[]

object (Dimension)

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

object (Metric)

Métriques demandées et affichées.
dimensionFilter

object (FilterExpression)

Clause de filtre des dimensions. Impossible d'utiliser des métriques dans ce filtre.
metricFilter

object (FilterExpression)

Clause de filtre des métriques. Appliquée lors de la phase post-agrégation, semblable à la clause SQL HAVING. Impossible d'utiliser les dimensions dans ce filtre.
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". Par conséquent, 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.
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.
returnPropertyQuota

boolean

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[]

object (MinuteRange)

Plages de minutes des 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 contient un index de plage de minutes basé sur zéro. Si deux plages de minutes se chevauchent, les données d'événement pour ces minutes sont incluses dans les lignes de réponse pour les deux plages de minutes.

Corps de la réponse

Tableau du rapport en temps réel des réponses correspondant à une demande.

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 (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "propertyQuota": {
    object (PropertyQuota)
  },
  "kind": string
}
Champs
dimensionHeaders[]

object (DimensionHeader)

Décrit les colonnes de dimensions. Le nombre de DimensionHeaders et l'ordre de ces DimensionHeaders correspondent aux dimensions présentes dans les lignes.
metricHeaders[]

object (MetricHeader)

Décrit les colonnes de métriques. Le nombre d'en-têtes de métriques et leur ordre correspondent aux métriques présentes dans les lignes.
rows[]

object (Row)

Lignes des combinaisons de valeurs des dimensions et des valeurs des métriques dans le rapport
totals[]

object (Row)

Si demandé, les valeurs totales des métriques.
maximums[]

object (Row)

Valeurs maximales des métriques (si demandé).
minimums[]

object (Row)

Si demandé, les valeurs minimales des métriques.
rowCount

integer

Nombre total de lignes dans le résultat de la requête. rowCount est indépendant du nombre de lignes renvoyées dans la réponse et du paramètre de requête limit. Par exemple, si une requête renvoie 175 lignes et inclut un limit de 50 dans la requête API, la réponse contiendra rowCount sur 175, mais seulement 50 lignes.
propertyQuota

object (PropertyQuota)

État du quota en temps réel de cette propriété Analytics, avec cette demande.
kind

string

Identifie le type de ressource de ce message. Cet kind correspond toujours à la chaîne fixe "analyticsData#runRealtimeReport". 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

MinuteRange

Ensemble de minutes contiguës: startMinutesAgo, startMinutesAgo + 1, ..., endMinutesAgo. Les requêtes sont autorisées pour des plages d'une durée maximale de deux minutes.

Représentation JSON 
{
  "name": string,
  "startMinutesAgo": integer,
  "endMinutesAgo": integer
}
Champs
name

string

Attribue un nom à cette plage de minutes. La dimension "dateRange" prend ce nom sous ce nom dans une réponse de rapport. S'il est défini, il ne peut pas commencer par date_range_ ni par RESERVED_. Si elle n'est pas définie, les plages de minutes sont nommées d'après leur index basé sur zéro dans la requête: date_range_0, date_range_1, etc.
startMinutesAgo

integer

Minute de début (incluse) de la requête exprimée en nombre de minutes avant le début de la requête. Par exemple, "startMinutesAgo": 29 indique que le rapport doit inclure les données d'événements datant de 29 minutes ou plus. Ne peut pas être postérieure à endMinutesAgo.

Si aucune valeur n'est spécifiée, la valeur par défaut de startMinutesAgo est 29. Les propriétés Analytics standards peuvent demander jusqu'à 30 minutes de données d'événement (startMinutesAgo <= 29), tandis que les propriétés Analytics 360 peuvent demander jusqu'à 60 minutes de données d'événement (startMinutesAgo <= 59).
endMinutesAgo

integer

Minute de fin (incluse) de la requête exprimée en nombre de minutes avant l'heure actuelle. Ne peut pas être antérieure au startMinutesAgo. Par exemple, "endMinutesAgo": 15 indique que le rapport doit inclure les données d'événements remontant à 15 minutes au maximum.

Si aucune valeur n'est spécifiée, la valeur par défaut de endMinutesAgo est 0. Les propriétés Analytics standards peuvent demander n'importe quelle minute de données d'événement au cours des 30 dernières minutes (endMinutesAgo <= 29), tandis que les propriétés Analytics 360 peuvent demander n'importe quelle minute au cours des 60 dernières minutes (endMinutesAgo <= 59).