Method: properties.runRealtimeReport

L'API Google Analytics Realtime renvoie un rapport personnalisé des 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é Google Analytics GA4 dont les événements sont suivis. Spécifié 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)
    }
  ],
  "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 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, de la même manière que la clause SQL existante. Des métriques doivent être demandées pour être utilisées dans ce filtre. Impossible d'utiliser des dimensions avec ce filtre.
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 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é 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 de réponse correspondant à une requête.

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

object (PropertyQuota)

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