Method: properties.runReport

Renvoie un rapport personnalisé de 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 dont les colonnes correspondent aux dimensions et aux métriques demandées. Les métriques sont des mesures individuelles de l'activité des utilisateurs sur votre propriété, comme le nombre d'utilisateurs actifs ou le nombre d'événements. Les dimensions répartissent les métriques selon des critères courants, comme le pays ou le nom de l'événement.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
property

string

Obligatoire. 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 l'ID de votre propriété. Dans une requête par lot, cette propriété ne doit pas être spécifiée ou doit être 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)
    }
  ],
  "conversionSpec": {
    object (ConversionSpec)
  }
}
Champs
dimensions[]

object (Dimension)

Facultatif. Les dimensions demandées et affichées.
metrics[]

object (Metric)

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

object (DateRange)

Facultatif. 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 pour les jours concernés 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)

Facultatif. Les filtres de dimensions vous permettent de demander uniquement des valeurs de dimensions 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)

Facultatif. Clause de filtre des métriques. Appliqué après l'agrégation des lignes du rapport, comme la clause "having" de SQL. Vous ne pouvez pas utiliser de dimensions dans ce filtre.
offset

string (int64 format)

Facultatif. Nombre de lignes de la ligne de début. La première ligne est considéré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 les limit premières lignes. La deuxième requête définit le décalage sur le limit de la première requête. La deuxième requête renvoie le deuxième limit de lignes.

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

string (int64 format)

Facultatif. Nombre maximal de lignes à renvoyer. 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, la dimension country ne peut pas prendre plus de 300 valeurs. Par conséquent, si vous générez des rapports 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)

Facultatif. Agrégation des métriques. Les valeurs agrégées des métriques s'affichent dans les lignes où dimensionValues est défini sur "RESERVED_(MetricAggregation)". Les agrégats incluant à la fois des comparaisons et plusieurs plages de dates seront agrégés en fonction des plages de dates.
orderBys[]

object (OrderBy)

Facultatif. Spécifie l'ordre des lignes dans la réponse. Les demandes incluant à la fois des comparaisons et plusieurs plages de dates auront des clauses "order by" appliquées aux comparaisons.
currencyCode

string

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

object (CohortSpec)

Facultatif. Groupe de cohortes associé à cette demande. Si la requête contient un groupe de cohortes, la dimension "cohort" (cohorte) doit être présente.
keepEmptyRows

boolean

Facultatif. Si la valeur est "false" ou non spécifiée, chaque ligne dont toutes les métriques sont égales à 0 ne sera pas renvoyée. Si la valeur est "true", ces lignes seront 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

Facultatif. 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 comparaison pour recevoir une colonne de comparaison dans la réponse.
conversionSpec

object (ConversionSpec)

Facultatif. Contrôle les rapports sur les conversions. Ce champ est facultatif. Si ce champ est défini ou si des métriques de conversion sont demandées, le rapport sera un rapport sur les conversions.

Corps de la réponse

Table du rapport de réponse 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,
  "metadata": {
    object (ResponseMetaData)
  },
  "propertyQuota": {
    object (PropertyQuota)
  },
  "kind": string,
  "nextPageToken": string
}
Champs
dimensionHeaders[]

object (DimensionHeader)

Décrit les colonnes de dimensions. Le nombre et l'ordre des DimensionHeaders correspondent aux dimensions présentes dans les lignes.
metricHeaders[]

object (MetricHeader)

Décrit les colonnes de métriques. Le nombre et l'ordre des MetricHeaders correspondent aux métriques présentes dans les lignes.
rows[]

object (Row)

Lignes de combinaisons de valeurs de dimension et de valeurs de métrique dans le rapport.
totals[]

object (Row)

Si demandé, les valeurs totales des métriques.
maximums[]

object (Row)

Valeurs maximales des métriques, le cas échéant.
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 "limit = 50" dans la requête API, la réponse contiendra "rowCount = 175", mais seulement 50 lignes.

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

object (ResponseMetaData)

Métadonnées du rapport.
propertyQuota

object (PropertyQuota)

État du quota de cette propriété Analytics, y compris cette requête.
kind

string

Identifie le type de ressource de ce message. Cette kind est toujours la chaîne fixe "analyticsData#runReport". Utile pour distinguer les types de réponses au format JSON.
nextPageToken

string

Jeton pouvant être envoyé en tant que pageToken pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.

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

Comparaison

Définit une comparaison individuelle. La plupart des demandes incluent plusieurs comparaisons afin que le rapport compare les comparaisons entre elles.

Représentation JSON 
{
  "name": string,

  // Union field one_comparison can be only one of the following:
  "dimensionFilter": {
    object (FilterExpression)
  },
  "comparison": string
  // End of list of possible types for union field one_comparison.
}
Champs
name

string

Chaque comparaison génère des lignes distinctes dans la réponse. Dans la réponse, cette comparaison est identifiée par ce nom. Si le nom n'est pas spécifié, nous utiliserons le nom à afficher des comparaisons enregistrées.

Champ d'union one_comparison.

one_comparison ne peut être qu'un des éléments suivants :
dimensionFilter

object (FilterExpression)

Comparaison de base.
comparison

string

Comparaison enregistrée identifiée par le nom de ressource de la comparaison. Par exemple, "comparisons/1234".

ConversionSpec

Contrôle les rapports sur les conversions.

Représentation JSON 
{
  "conversionActions": [
    string
  ],
  "attributionModel": enum (AttributionModel)
}
Champs
conversionActions[]

string

ID des actions de conversion à inclure dans le rapport. Si ce champ est vide, toutes les conversions sont incluses. Les ID d'action de conversion valides peuvent être récupérés à partir du champ conversionAction dans la liste conversions de la réponse de la méthode properties.getMetadata. Par exemple, "conversionActions/1234".
attributionModel

enum (AttributionModel)

Modèle d'attribution à utiliser dans le rapport sur les conversions. Si aucune valeur n'est spécifiée, DATA_DRIVEN est utilisé.

AttributionModel

Modèle d'attribution à utiliser dans le rapport sur les conversions

Enums
ATTRIBUTION_MODEL_UNSPECIFIED Modèle d'attribution non spécifié.
DATA_DRIVEN L'attribution était basée sur le modèle basé sur les données pour les canaux payants et naturels.
LAST_CLICK L'attribution était basée sur le modèle "Dernier clic sur les canaux payants et naturels".