Ce document décrit les fonctionnalités avancées de l'API Google Analytics Reporting v4. Pour obtenir des informations détaillées sur l'API, consultez le Guide de référence.
Introduction
Après avoir créé un rapport simple, utilisez les fonctionnalités suivantes pour créer des rapports avancés:
Pivots
L'API Google Analytics Reporting v4 vous permet de générer des tableaux croisés dynamiques.
Pour créer une requête avec un tableau croisé dynamique, définissez le champ Pivot dans ReportRequest.
L'objet Pivot dispose de son propre ensemble de dimensions et de métriques, ainsi que de startGroup et maxGroupCount en option pour spécifier le nombre de dimensions à inclure dans le tableau croisé dynamique.
Demande
L'appel d'API suivant demande des sessions par pays et croise les résultats dans un navigateur:
POST https://analyticsreporting.googleapis.com/v4/reports:batchGet
{
"reportRequests":
[
{
"viewId": "XXXX",
"dateRanges":
[
{
"startDate": "2014-11-01",
"endDate": "2014-11-30"
}
],
"metrics":
[
{
"expression": "ga:sessions"
}
],
"dimensions":
[
{
"name": "ga:country"
}
],
"pivots":
[
{
"dimensions":
[
{
"name": "ga:browser"
}
],
"maxGroupCount": 3,
"startGroup": 3,
"metrics":
[
{
"expression": "ga:sessions"
}
]
}
]
}
]
}
En-tête de colonne de la réponse
Dans l'objet report renvoyé pour une requête de tableau croisé dynamique, metricHeader contient une liste d'objets pivotHeaders dont les champs pivotHeaderEntries définissent l'ordre des valeurs des dimensions de tableau croisé dynamique et les valeurs correspondantes de la métrique. Exemple:
"columnHeader": {
"dimensions": [
"ga:country"
],
"metricHeader": {
"metricHeaderEntries": [
{
"name": "ga:sessions",
"type": "INTEGER"
}
],
"pivotHeaders": [
{
"pivotHeaderEntries": [
{
"dimensionNames": [
"ga:browser"
],
"dimensionValues": [
"Internet Explorer"
],
"metric": {
"name": "ga:sessions",
"type": "INTEGER"
}
},
{
"dimensionNames": [
"ga:browser"
],
"dimensionValues": [
"Firefox"
],
"metric": {
"name": "ga:sessions",
"type": "INTEGER"
}
},
{
"dimensionNames": [
"ga:browser"
],
"dimensionValues": [
"Android Browser"
],
"metric": {
"name": "ga:sessions",
"type": "INTEGER"
}
}
],
"totalPivotGroupsCount": 7
}
]
}
},
Lignes de réponse
Chaque ligne de l'objet reportData définit un tableau d'objets dateRangeValue, chacun contenant un ensemble d'objets pivotValue. L'ordre des valeurs correspond à l'ordre des métriques répertoriées dans les en-têtes de tableau croisé dynamique de l'en-tête de la colonne de réponse.
"rows": [
...
{
"dimensions": [
"United States"
],
"metrics": [
{
"pivotValues": [
{
"values": [
"21",
"18",
"1"
]
}
],
"values": [
"192"
]
}
]
}
],
Notez que le rapport ne comporte que trois valeurs de tableau croisé dynamique, car maxGroupCount est égal à trois dans la requête d'origine. Il peut y avoir jusqu'à sept valeurs en raison de "totalPivotGroupsCount": 7.
Exemple de ligne de tableau croisé dynamique
Dans l'exemple de réponse ci-dessus, la ligne associée au pays États-Unis est représentée dans le tableau croisé dynamique suivant:
| Pays | sessions au total |
Sessions Internet Explorer |
FireFox sessions |
Sessions sur navigateur Android |
|---|---|---|---|---|
| Inde | 12 | 3 | 2 | 4 |
| États-Unis | 192 | 21 | 18 | 1 |
| Royaume-Uni | 35 | 12 | 2 | 0 |
Cohortes
Une cohorte est un groupe d'utilisateurs qui partagent une caractéristique commune. Par exemple, tous les utilisateurs ayant la même date d'acquisition forment une cohorte. Le rapport d'analyse vous permet d'identifier et d'analyser le comportement de ces cohortes. Pour obtenir la liste des dimensions et métriques spécifiques aux cohortes, consultez Dimensions et métriques sur la cohorte et la valeur vie.
Pour définir une requête de cohorte, vous devez définir un objet de cohorte avec name, type et dateRange:
POST https://analyticsreporting.googleapis.com/v4/reports:batchGet
{
"reportRequests":
[
{
"viewId": "XXXX",
"dimensions":
[
{
"name": "ga:cohort"
},
{
"name": "ga:cohortNthDay"
}
],
"metrics":
[
{
"expression": "ga:cohortActiveUsers"
},
{
"expression": "ga:cohortTotalUsers"
}
],
"cohortGroup":
{
"cohorts":
[
{
"name": "cohort 1",
"type": "FIRST_VISIT_DATE",
"dateRange":
{
"startDate": "2015-08-01",
"endDate": "2015-08-01"
}
},
{
"name": "cohort 2",
"type": "FIRST_VISIT_DATE",
"dateRange":
{
"startDate": "2015-07-01",
"endDate": "2015-07-01"
}
}
]
}
}
]
}
Consultez l'exemple ci-dessus dans APIs Explorer.
Restrictions concernant les cohortes
Une demande de cohorte valide doit remplir les conditions suivantes:
- La dimension
ga:cohortn'est incluse que si la requête comporte une ou plusieurs définitions de cohorte. - Le nom de la cohorte doit être unique.
- Le nombre maximal de cohortes par demande est de 12.
- Si
ga:cohortNthWeekest défini, la date de début doit être le dimanche et la date de fin doit être le samedi. Siga:cohortNthMonthest défini, la date de début doit être le premier jour du mois et la date de fin doit être le dernier jour du mois. Si la valeurga:cohortNthDayest définie, la plage de dates doit correspondre exactement à un jour. - Les demandes de cohorte d'aujourd'hui ne sont pas autorisées.
- Les demandes de cohorte et de non-cohorte ne doivent pas être dans la même requête
batchGet. - La plage de dates des cohortes doit être postérieure au 1er février 2015.
Valeur vie (LTV)
Le rapport sur la valeur vie indique comment la valeur utilisateur (revenus) et l'engagement (vues d'application, objectifs réalisés, sessions et durée de la session) augmentent au cours des 90 jours suivant l'acquisition d'un utilisateur. Consultez les dimensions et métriques spécifiques à la valeur vie.
Une requête de valeur vie (LTV) est définie comme une cohorte avec le champ lifetimeValue défini sur true, par exemple:
POST https://analyticsreporting.googleapis.com/v4/reports:batchGet
{
"reportRequests":
[
{
"viewId": "XXXX",
"dimensions":
[
{
"name": "ga:cohort"
},
{
"name": "ga:cohortNthWeek"
}
],
"metrics":
[
{
"expression": "ga:cohortTotalUsersWithLifetimeCriteria"
},
{
"expression": "ga:cohortRevenuePerUser"
}
],
"cohortGroup":
{
"cohorts":
[
{
"name": "cohort 1",
"type": "FIRST_VISIT_DATE",
"dateRange":
{
"startDate": "2015-08-01",
"endDate": "2015-09-01"
}
},
{
"name": "cohort 2",
"type": "FIRST_VISIT_DATE",
"dateRange":
{
"startDate": "2015-07-01",
"endDate": "2015-08-01"
}
}
],
"lifetimeValue": true
}
}
]
}
Consultez l'exemple ci-dessus dans APIs Explorer.
Dimensions et métriques sur la valeur vie (cohorte)
Dimensions
| Nom de la dimension | Définition |
|---|---|
ga:cohort |
Nom de la cohorte à laquelle appartient un utilisateur. Selon la façon dont les cohortes sont définies, un utilisateur peut appartenir à plusieurs cohortes, de la même manière qu'un utilisateur peut appartenir à plusieurs segments. |
ga:cohortNthDay |
Décalage de jour basé sur 0 par rapport à la date de définition de la cohorte. Par exemple, si une cohorte est définie comme ayant une date de première visite 2015-09-01, la valeur de ga:cohortNthDay pour la date 2015-09-04 sera 3. |
ga:cohortNthMonth |
Décalage mensuel basé sur 0 par rapport à la date de définition de la cohorte. |
ga:cohortNthWeek |
Décalage hebdomadaire basé sur 0 par rapport à la date de définition de la cohorte. |
ga:acquisitionTrafficChannel |
Canal de trafic via lequel l'utilisateur a été acquis. Elle est extraite de la première session de l'utilisateur. Le canal de trafic est calculé en fonction des règles de regroupement de canaux par défaut (au niveau de la vue, si disponible) au moment de l'acquisition d'utilisateurs. |
ga:acquisitionSource |
Source via laquelle l'utilisateur a été acquis. Basé sur la première session de l'utilisateur. |
ga:acquisitionMedium |
Support via lequel l'utilisateur a été acquis. Basé sur la première session de l'utilisateur. |
ga:acquisitionSourceMedium |
Valeur combinée de ga:userAcquisitionSource et ga:acquisitionMedium. |
ga:acquisitionCampaign |
Campagne via laquelle l'utilisateur a été acquis Basé sur la première session de l'utilisateur. |
Métriques
| Nom de la métrique | Définition |
|---|---|
ga:cohortActiveUsers |
Cette métrique est pertinente dans le contexte des dimensions de décalage basées sur 0 (ga:cohortNthDay, ga:cohortNthWeek ou ga:cohortNthMonth). Elle indique le nombre d'utilisateurs actifs de la cohorte qui sont actifs au cours de la période correspondant à la cohorte, jour/semaine/mois. Par exemple, pour ga:cohortNthWeek = 1, le nombre d'utilisateurs (de la cohorte) qui sont actifs au cours de la deuxième semaine. Si une requête n'est pas associée à ga:cohortNthDay, ga:cohortNthWeek ou ga:cohortNthMonth, cette métrique aura la même valeur que ga:cohortTotalUsers. |
ga:cohortTotalUsers |
Nombre d'utilisateurs appartenant à la cohorte, également appelé taille de la cohorte. |
ga:cohortAppviewsPerUser |
Nombre de vues de l'application par utilisateur pour une cohorte. |
ga:cohortGoalCompletionsPerUser |
Objectifs réalisés par utilisateur pour une cohorte. |
ga:cohortPageviewsPerUser |
Nombre de pages vues par utilisateur pour une cohorte. |
ga:cohortRetentionRate |
Taux de fidélisation des cohortes. |
ga:cohortRevenuePerUser |
Revenu par utilisateur pour une cohorte. |
ga:cohortVisitDurationPerUser |
Durée de la session par utilisateur pour une cohorte. |
ga:cohortSessionsPerUser |
Sessions par utilisateur pour une cohorte. |
Métriques sur la valeur vie (LTV)
| Nom de la métrique | Définition |
|---|---|
ga:cohortTotalUsersWithLifetimeCriteria |
Cela est pertinent dans le contexte d'une requête comportant les dimensions ga:acquisitionTrafficChannel, ga:acquisitionSource, ga:acquisitionMedium ou ga:acquisitionCampaign. Il représente le nombre d'utilisateurs dans les cohortes acquis via le canal, la source, le support ou la campagne actuels. Par exemple, pour ga:acquisitionTrafficChannel=Direct, il représente le nombre d'utilisateurs de la cohorte qui ont été acquis directement. Si aucune des dimensions mentionnées n'est présente, sa valeur est égale à ga:cohortTotalUsers (vues d'application uniquement). |
ga:cohortAppviewsPerUserWithLifetimeCriteria |
Vues d'application par utilisateur pour la dimension d'acquisition d'une cohorte (vues d'application uniquement). |
ga:cohortGoalCompletionsPerUserWithLifetimeCriteria |
Objectifs réalisés par utilisateur pour la dimension "Acquisition" d'une cohorte (vues d'application uniquement). |
ga:cohortPageviewsPerUserWithLifetimeCriteria |
Nombre de pages vues par utilisateur pour la dimension "Acquisition" d'une cohorte (vues d'application uniquement). |
ga:cohortRevenuePerUserWithLifetimeCriteria |
Revenu par utilisateur pour la dimension "Acquisition" d'une cohorte (vues d'application uniquement) |
ga:cohortSessionsPerUserWithLifetimeCriteria |
Durée de la session par utilisateur pour la dimension "Acquisition" d'une cohorte (vues d'application uniquement). |