Method: properties.runRealtimeReport

L'API Google Analytics Realtime renvoie un rapport personnalisé sur les données d'événements en temps réel pour votre propriété. Ces rapports indiquent les événements et l'utilisation des 30 dernières minutes.

Requête HTTP

POST https://analyticsdata.googleapis.com/v1alpha/{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)
    }
  ],
  "limit": string,
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "returnPropertyQuota": boolean
}
Champs
dimensions[]

object (Dimension)

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

object (Metric)

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

string (int64 format)

Nombre de lignes à afficher. Si le paramètre limit n'est pas spécifié, 10 000 lignes sont renvoyées. L'API renvoie un maximum de 100 000 lignes par requête, quel que soit le nombre demandé.
dimensionFilter

object (FilterExpression)

Clause de filtre des dimensions. Vous devez demander des dimensions pour pouvoir les utiliser dans ce filtre. 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. Les métriques doivent faire l'objet d'une demande pour être utilisées dans ce filtre. Impossible d'utiliser les dimensions dans ce filtre.
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.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

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

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)
  }
}
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, quel que soit le nombre de lignes renvoyées dans la réponse. Par exemple, si une requête renvoie 175 lignes et inclut la valeur "limit = 50" dans la requête API, la réponse contiendra "rowCount = 175", mais seulement 50 lignes.
propertyQuota

object (PropertyQuota)

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

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