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 apparaissent dans les rapports en temps réel quelques secondes après avoir été envoyés à Google Analytics. Les rapports en temps réel affichent les événements et les données d'utilisation pour les périodes allant du moment présent à 30 minutes auparavant (jusqu'à 60 minutes pour les propriétés Google Analytics 360).

Pour obtenir un guide sur la création de requêtes en temps réel et la compréhension des 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 de propriété Google Analytics dont les événements sont suivis. Spécifié dans le chemin de l'URL et non dans le corps. Pour en savoir plus, consultez Où trouver l'ID de votre 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. Les métriques ne peuvent pas être utilisées dans ce filtre.
metricFilter

object (FilterExpression)

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

string (int64 format)

Nombre de lignes à renvoyer. 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é. limit doit être positif.

L'API peut également renvoyer moins de lignes que le limit demandé, s'il n'y a pas autant de valeurs de dimension que le limit. Par exemple, la dimension country ne peut pas prendre plus de 300 valeurs. Par conséquent, si vous générez des rapports uniquement sur country, 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 agrégées des métriques s'affichent dans les lignes où dimensionValues est défini sur "RESERVED_(MetricAggregation)".
orderBys[]

object (OrderBy)

Spécifie l'ordre des lignes dans la réponse.
returnPropertyQuota

boolean

Indique s'il faut renvoyer l'état actuel du quota en temps réel de cette propriété Google Analytics. 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 pour les 30 dernières minutes sera utilisée. 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 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

Table du rapport en temps réel sur les 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 et l'ordre des 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 demandé, les valeurs totales des métriques.
maximums[]

object (Row)

Valeurs maximales des métriques, le cas échéant.
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 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 cette demande.
kind

string

Identifie le type de ressource de ce message. Cette kind est 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 contigu de minutes : startMinutesAgo, startMinutesAgo + 1, ..., endMinutesAgo. Les requêtes sont autorisées pour des plages de deux minutes maximum.

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

string

Attribue un nom à cette plage de minutes. La dimension dateRange est associée à ce nom dans une réponse de rapport. Si elle est définie, elle ne peut pas commencer par date_range_ ni RESERVED_. Si elles ne sont pas définies, les plages de minutes sont nommées par 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 minutes avant l'heure actuelle. Par exemple, "startMinutesAgo": 29 indique que le rapport doit inclure les données d'événement datant d'au moins 29 minutes. Elle ne peut pas être postérieure au endMinutesAgo.

Si aucune valeur n'est spécifiée, startMinutesAgo est défini par défaut sur 29. Les propriétés Analytics standards peuvent demander jusqu'à 30 minutes de données d'événement (startMinutesAgo <= 29), et 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 pour la requête, en nombre de minutes avant maintenant. Ne peut pas être antérieure au startMinutesAgo. Par exemple, "endMinutesAgo": 15 indique que le rapport doit inclure les données d'événement antérieures à 15 minutes.

Si aucune valeur n'est 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), et 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).