Method: properties.runRealtimeReport

Affiche 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 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 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

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

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 (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 filtrage des dimensions. Impossible d'utiliser des métriques avec ce filtre.

metricFilter

object (FilterExpression)

Clause de filtre des métriques. Appliquée à la phase post-agrégation, semblable à la clause SQL existante. Impossible d'utiliser des dimensions avec 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é. 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, il y a moins de 300 valeurs possibles pour la dimension "country". Par conséquent, lorsque vous générez un rapport ne portant que sur "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 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[]

object (OrderBy)

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

returnPropertyQuota

boolean

Détermine 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 minutes de 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 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 pour les deux plages de minutes.

Corps de la réponse

Tableau du rapport en temps réel des 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 de DimensionHeaders et leur ordre correspondent aux dimensions présentes dans les lignes.

metricHeaders[]

object (MetricHeader)

Décrit les colonnes de métriques. Le nombre de "MetricHeaders" et leur ordre correspondent aux métriques présentes dans les lignes.

rows[]

object (Row)

Lignes de combinaisons de valeurs de dimension et de valeurs de métriques dans le rapport.

totals[]

object (Row)

Si nécessaire, il s'agit des valeurs totales des métriques.

maximums[]

object (Row)

Si nécessaire, il s'agit des valeurs maximales des métriques.

minimums[]

object (Row)

Si nécessaire, il s'agit des 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é Analytics, y compris cette demande.

kind

string

Identifie le type de ressource de ce message. L'élément 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 contigus: 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

string

Attribue un nom à cette plage de minutes. La dimension dateRange est associée à ce nom dans une réponse de rapport. Si cette valeur est définie, elle ne peut pas commencer par date_range_ ni RESERVED_. Si ce champ n'est pas spécifié, les plages de minutes sont nommées en fonction de leur index basé sur zéro dans la requête: date_range_0, date_range_1, etc.

startMinutesAgo

integer

Minutes de début (incluses) de la requête exprimées en nombre de minutes avant l'instant. Par exemple, "startMinutesAgo": 29 indique que le rapport doit inclure les données d'événements datant de 29 minutes avant ou après. 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), et les propriétés Analytics 360 peuvent demander jusqu'à 60 minutes de données d'événement (startMinutesAgo <= 59).

endMinutesAgo

integer

Minutes de fin inclusives de la requête exprimées en nombre de minutes avant l'instant. Ne peut pas être antérieur au startMinutesAgo. Par exemple, "endMinutesAgo": 15 indique que le rapport doit inclure les données d'événements antérieures aux 15 dernières 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 au cours 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 au cours des 60 dernières minutes de données d'événement (endMinutesAgo <= 59).