Method: properties.runRealtimeReport

Renvoie un rapport personnalisé sur les données d'événements en temps réel de votre propriété. Les événements apparaissent dans les rapports "Temps réel" quelques secondes après avoir été envoyés à Google Analytics. Les rapports "Temps réel" affichent les événements et les données d'utilisation pour les périodes allant du moment présent à 30 minutes en arrière (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 Créer un rapport en 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

Identifiant d'une propriété Google Analytics dont les événements sont suivis. Spécifié dans le chemin d'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)

Les dimensions demandées et affichées.
metrics[]

object (Metric)

Métriques demandées et affichées
dimensionFilter

object (FilterExpression)

Clause de filtre des dimensions. Vous ne pouvez pas utiliser de métriques dans ce filtre.
metricFilter

object (FilterExpression)

Clause de filtre des métriques. Appliqué à la phase post-agrégation, semblable à la clause "having" en SQL. Vous ne pouvez pas utiliser de dimensions dans ce filtre.
limit

string (int64 format)

Nombre de lignes à renvoyer. Si ce paramètre n'est pas spécifié, 10 000 lignes sont renvoyées. L'API renvoie un maximum de 250 000 lignes par requête, quel que soit le nombre de lignes que vous demandez. limit doit être positif.

L'API peut également renvoyer moins de lignes que l'limit demandée, si le nombre de valeurs de dimension est inférieur à celui de l'limit. Par exemple, il existe moins de 300 valeurs possibles pour la dimension country. Par conséquent, si vous n'utilisez que country dans vos rapports, vous ne pouvez pas obtenir plus de 300 lignes, même si vous définissez limit sur une valeur plus élevée.
metricAggregations[]

enum (MetricAggregation)

Agrégation des métriques. Les valeurs de métrique 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.
returnPropertyQuota

boolean

Indique si l'état actuel du quota en temps réel de cette propriété Google Analytics doit être renvoyé. Le quota est renvoyé dans PropertyQuota.
minuteRanges[]

object (MinuteRange)

Intervalles de minutes des données d'événement à lire. Si aucune valeur n'est spécifiée, une plage d'une minute pour les 30 dernières minutes est utilisée. Si plusieurs plages de minutes sont demandées, chaque ligne de réponse contient un indice de plage de minutes basé sur zéro. Si deux plages de minutes se chevauchent, les données d'événement pour les minutes qui se chevauchent 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 sur les réponses 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 (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 dimension. Le nombre et l'ordre des éléments "DimensionHeaders" correspondent aux dimensions présentes dans les lignes.
metricHeaders[]

object (MetricHeader)

Décrit les colonnes de métriques. Le nombre et l'ordre des MetricHeaders correspondent aux métriques présentes dans les lignes.
rows[]

object (Row)

Lignes de combinaisons de valeurs de dimension et de valeurs de métrique dans le rapport.
totals[]

object (Row)

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

object (Row)

Si demandé, les valeurs maximales des métriques.
minimums[]

object (Row)

Si nécessaire, 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 limit de 50 dans la requête API, la réponse contiendra rowCount de 175, mais seulement 50 lignes.
propertyQuota

object (PropertyQuota)

État du quota en temps réel de cette propriété Google Analytics, y compris pour cette requête.
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 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

MinuteRange

Ensemble contigu de minutes: startMinutesAgo, startMinutesAgo + 1, ..., endMinutesAgo. Les requêtes sont autorisées dans des intervalles de deux minutes maximum.

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

string

Attribue un nom à cette plage de minutes. La valeur de la dimension dateRange est définie sur ce nom dans une réponse de rapport. Si défini, ne peut pas commencer par date_range_ ou RESERVED_. Si cet élément n'est pas défini, les plages de minutes sont nommées en fonction de leur index à partir de zéro dans la requête: date_range_0, date_range_1, etc.
startMinutesAgo

integer

Minute de début inclusive de la requête, exprimée en nombre de minutes avant l'heure actuelle. Par exemple, "startMinutesAgo": 29 spécifie que le rapport doit inclure les données d'événements datant d'il y a 29 minutes et plus. ne peut pas être postérieure au endMinutesAgo ;

Si cette valeur n'est pas spécifiée, startMinutesAgo est défini par défaut sur 29. Les propriétés Analytics standards peuvent demander jusqu'aux 30 dernières minutes de données d'événement (startMinutesAgo <= 29), tandis que les propriétés Analytics 360 peuvent demander jusqu'aux 60 dernières minutes de données d'événement (startMinutesAgo <= 59).
endMinutesAgo

integer

Minute de fin inclusive 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 spécifie que le rapport doit inclure les données d'événement datant d'il y a 15 minutes.

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