Method: runReport

Affiche un rapport personnalisé sur vos données d'événement Google Analytics. Les rapports contiennent des statistiques issues 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 métriques demandées. Les métriques sont des mesures individuelles de l'activité des utilisateurs sur votre propriété (utilisateurs actifs ou nombre d'événements, par exemple). Les dimensions permettent de répartir les métriques en fonction de certains critères courants, tels que le pays ou le nom d'un événement.

Requête HTTP

POST https://analyticsdata.googleapis.com/v1alpha:runReport

L'URL utilise la syntaxe de transcodage gRPC.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "entity": {
    object (Entity)
  },
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean
}
Champs
entity

object (Entity)

Une propriété dont les événements sont suivis. Dans une requête par lot, cette entité doit être soit non spécifiée, soit cohérente avec l'entité au niveau du lot.
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 contiendra un index de plage de dates basé sur zéro. Si deux plages de dates se chevauchent, les données d'événement des jours concernés sont incluses dans les lignes de réponse pour les deux plages de dates. Dans une demande de cohorte, ce dateRanges ne doit pas être spécifié.
offset

string (int64 format)

Nombre de lignes de la première ligne. La première ligne est comptabilisée comme la ligne 0.
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é.
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)".
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.
orderBys[]

object (OrderBy)

Spécifie l'ordre des lignes dans la réponse.
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 l'entité.
cohortSpec

object (CohortSpec)

Groupe de cohortes associé à cette demande. Si la requête contient un groupe de cohortes, doit être présente.
keepEmptyRows

boolean

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

boolean

Indique si l'état actuel du quota 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 une instance de RunReportResponse.

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