Method: properties.runReport

Renvoie un rapport personnalisé sur vos données d'événements Google Analytics. Les rapports contiennent des statistiques dérivées des données collectées par le code de suivi Google Analytics. Les données renvoyées par l'API se présentent sous la forme d'un tableau avec des colonnes pour les dimensions et les métriques demandées. Les métriques sont des mesures individuelles de l'activité des utilisateurs sur votre propriété, telles que les utilisateurs actifs ou le nombre d'événements. Les dimensions répartissent les métriques selon des critères courants, tels que le pays ou le nom de l'événement.

Pour obtenir un guide sur la création de requêtes et la compréhension des réponses, consultez Créer un rapport.

Requête HTTP

POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:runReport

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 votre ID de propriété. Dans une requête par lot, cette propriété doit être non spécifiée ou cohérente avec la propriété au niveau du lot.

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)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean,
  "comparisons": [
    {
      object (Comparison)
    }
  ]
}
Champs
dimensions[]

object (Dimension)

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

object (Metric)

Métriques demandées et affichées.
dateRanges[]

object (DateRange)

Plages de dates des données à lire. Si plusieurs plages de dates sont demandées, chaque ligne de réponse contient un index de plage de dates basé sur zéro. Si deux plages de dates se chevauchent, les données d'événements pour les jours qui se chevauchent sont incluses dans les lignes de réponse pour les deux plages de dates. Dans une requête de cohorte, ce dateRanges doit être non spécifié.
dimensionFilter

object (FilterExpression)

Les filtres de dimension vous permettent de demander uniquement des valeurs de dimension spécifiques dans le rapport. Pour en savoir plus, consultez Principes de base des filtres de dimension pour obtenir des exemples. Les métriques ne peuvent pas être utilisées dans ce filtre.
metricFilter

object (FilterExpression)

Clause de filtre des métriques. Appliquée après l'agrégation des lignes du rapport, comme la clause SQL "having". Les dimensions ne peuvent pas être utilisées dans ce filtre.
offset

string (int64 format)

Nombre de lignes de la ligne de début. La première ligne est comptée comme la ligne 0.

Lors de la pagination, la première requête ne spécifie pas de décalage ou, de manière équivalente, définit le décalage sur 0. La première requête renvoie la première limit de lignes. La deuxième requête définit le décalage sur la limit de la première requête. La deuxième requête renvoie la deuxième limit de lignes.

Pour en savoir plus sur ce paramètre de pagination, consultez Pagination.
limit

string (int64 format)

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

L'API peut également renvoyer moins de lignes que la limit demandée, s'il n'y a pas autant de valeurs de dimension que la limit. Par exemple, il existe moins de 300 valeurs possibles pour la dimension country. Par conséquent, lorsque vous générez un rapport 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.

Pour en savoir plus sur ce paramètre de pagination, consultez Pagination.
metricAggregations[]

enum (MetricAggregation)

Agrégation des 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)". Les agrégats incluant à la fois des comparaisons et plusieurs plages de dates sont agrégés en fonction des plages de dates.
orderBys[]

object (OrderBy)

Spécifie l'ordre des lignes dans la réponse. Les requêtes incluant à la fois des comparaisons et plusieurs plages de dates sont triées par ordre de comparaison.
currencyCode

string

Code de devise au format ISO4217, tel que "AED", "USD" ou "JPY". Si le champ est vide, le rapport utilise la devise par défaut de la propriété.
cohortSpec

object (CohortSpec)

Groupe de cohortes associé à cette requête. S'il existe un groupe de cohortes dans la requête, la dimension "cohorte" doit être présente.
keepEmptyRows

boolean

Si la valeur est "false" ou non spécifiée, chaque ligne dont toutes les métriques sont égales à 0 n'est pas renvoyée. Si la valeur est "true", ces lignes sont renvoyées si elles ne sont pas supprimées séparément par un filtre.

Quel que soit ce paramètre keepEmptyRows, seules les données enregistrées par la propriété Google Analytics peuvent être affichées dans un rapport.

Par exemple, si une propriété n'enregistre jamais d'événement purchase, une requête pour la dimension eventName et la métrique eventCount ne comportera pas de ligne eventName: "purchase" et eventCount: 0.
returnPropertyQuota

boolean

Indique s'il faut renvoyer l'état actuel du quota de cette propriété Google Analytics. Le quota est renvoyé dans PropertyQuota.
comparisons[]

object (Comparison)

Facultatif. Configuration des comparaisons demandées et affichées. La requête ne nécessite qu'un champ de comparaisons pour recevoir une colonne de comparaison dans la réponse.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de RunReportResponse.

Niveaux d'accès 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