- Requête HTTP
- Corps de la requête
- Corps de la réponse
- Champs d'application des autorisations
- Utilisateur
- UserIdType
- ActivityType
- UserActivitySession
- Activité
- CustomDimension
- PageviewData
- ScreenviewData
- EcommerceData
- ECommerceAction
- TransactionData
- ProductData
- EcommerceType
- GoalSetData
- GoalData
- EventData
- Essayer
Renvoie les données sur l'activité de l'utilisateur.
Requête HTTP
POST https://analyticsreporting.googleapis.com/v4/userActivity:search
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 | |
---|---|
{ "dateRange": { object( |
Champs | |
---|---|
dateRange |
Plage de dates pour laquelle récupérer l'activité de l'utilisateur. Si aucune plage de dates n'est indiquée, la plage de dates par défaut est (startDate: date du jour - 7 jours, endDate: date du jour - 1 jour). |
viewId |
Obligatoire. ID de la vue Analytics à partir de laquelle récupérer les données. Chaque SearchUserActivityRequest doit contenir le |
user |
Obligatoire. Identifiant de l'utilisateur unique à interroger. Chaque SearchUserActivityRequest doit contenir ce champ. |
activityTypes[] |
Ensemble de tous les types d'activités demandés. Seules les activités correspondant à ces types sont renvoyées dans la réponse. Si ce champ est vide, toutes les activités sont renvoyées. |
pageSize |
La taille de la page est destinée à la pagination et spécifie le nombre maximal de lignes renvoyées. La taille de la page doit être supérieure à 0. Si la valeur est 0 ou si le champ n'est pas spécifié, la requête renvoie la valeur par défaut de 1 000 lignes par page. |
pageToken |
Un jeton de continuation pour obtenir la page de résultats suivante. Si vous l'ajoutez à la requête, les lignes situées après "pageToken" seront renvoyées. "pageToken" doit correspondre à la valeur renvoyée dans le paramètre "nextPageToken" dans la réponse à la requête SearchUserActivityRequest. |
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 :
Réponse de l'appel userActivity:get
.
Représentation JSON | |
---|---|
{
"sessions": [
{
object( |
Champs | |
---|---|
sessions[] |
Chaque enregistrement représente une session (informations sur l'appareil, durée, etc.). |
totalRows |
Nombre total de lignes renvoyées par cette requête (sur différentes pages). |
nextPageToken |
Ce jeton doit être transmis à SearchUserActivityRequest pour récupérer la page suivante. |
sampleRate |
Ce champ représente le taux d'échantillonnage de la requête donnée. Il s'agit d'un nombre compris entre 0,0 et 1,0. Pour en savoir plus, consultez le guide du développeur. |
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
Utilisateur
Contient des informations permettant d'identifier un utilisateur spécifique de manière unique.
Représentation JSON | |
---|---|
{
"type": enum( |
Champs | |
---|---|
type |
Type d'utilisateur dans la requête. Le champ |
userId |
Identifiant unique de l'utilisateur pour lequel les données sont demandées. |
UserIdType
Représente les différents types d'identification d'utilisateur disponibles.
Enums | |
---|---|
USER_ID_TYPE_UNSPECIFIED |
Si le type d'ID utilisateur n'est pas spécifié, le type par défaut utilisé est CLIENT_ID. |
USER_ID |
Un utilisateur unique (par exemple, une personne qui est connectée à son compte, et qui est susceptible d'interagir avec du contenu lors d'une ou de plusieurs instances d'appareil et/ou de navigateur) |
CLIENT_ID |
ClientId attribué par Analytics. |
ActivityType
Enums | |
---|---|
ACTIVITY_TYPE_UNSPECIFIED |
ActivityType n'aura jamais cette valeur dans la réponse. L'utilisation de ce type dans la requête entraînera une erreur. |
PAGEVIEW |
Utilisé lorsque l'activité résulte de la consultation d'une page par un visiteur. |
SCREENVIEW |
Utilisé lorsque l'activité résulte d'un visiteur qui utilise une application sur un appareil mobile. |
GOAL |
Indique qu'il s'agit d'une activité de type objectif. |
ECOMMERCE |
Une transaction en ligne a été effectuée par le visiteur sur la page. |
EVENT |
Utilisé lorsque l'activité est un événement. |
UserActivitySession
Il s'agit d'une session utilisateur effectuée sur un appareil spécifique à un moment donné au cours d'une période donnée.
Représentation JSON | |
---|---|
{
"sessionId": string,
"deviceCategory": string,
"platform": string,
"dataSource": string,
"activities": [
{
object( |
Champs | |
---|---|
sessionId |
Identifiant unique de la session. |
deviceCategory |
Type d'appareil utilisé: "mobile", "tablette", etc. |
platform |
Plate-forme sur laquelle l'activité s'est produite: "android", "ios", etc. |
dataSource |
Il s'agit de la source de données d'un appel. Par défaut, les appels envoyés à partir d'analytics.js sont associés au libellé "web" et ceux envoyés à partir des SDK pour mobile sont répertoriés comme "application". Ces valeurs peuvent être remplacées dans le protocole de mesure. |
activities[] |
Représente une vue détaillée de chacune des activités de cette session. |
sessionDate |
Date de la session au format ISO-8601. |
Activité
Une activité représente les données relatives à l'activité d'un utilisateur. Notez qu'une activité est différente d'un appel. Un appel peut entraîner plusieurs activités. Par exemple, si un appel inclut une transaction et la réalisation d'un objectif, il y aura deux prototypes d'activité pour cet appel, un pour ECOMMERCE et un pour GOAL. À l'inverse, plusieurs appels peuvent également générer une même activité. Dans l'e-commerce classique, les données d'une transaction peuvent être envoyées via plusieurs appels. Ces appels seront fusionnés en une seule activité de commerce électronique.
Représentation JSON | |
---|---|
{ "activityTime": string, "source": string, "medium": string, "channelGrouping": string, "campaign": string, "keyword": string, "hostname": string, "landingPagePath": string, "activityType": enum( |
Champs | ||
---|---|---|
activityTime |
Code temporel de l'activité. Horodatage au format RFC3339 UTC "Zulu", précis à la nanoseconde près. Exemple : |
|
source |
Source des sites référents. Pour le suivi manuel d'une campagne, elle correspond à la valeur du paramètre de suivi de campagne utm_source. Pour le taggage automatique AdWords, il s'agit de google. Si vous n'utilisez ni l'un ni l'autre, il s'agit du domaine de la source (par exemple, document.referrer) qui fait référence aux utilisateurs. Il peut également contenir une adresse de port. Si les utilisateurs sont arrivés sans URL de provenance, sa valeur est (direct). |
|
medium |
Type de sites référents. Pour le suivi manuel d'une campagne, elle correspond à la valeur du paramètre de suivi de campagne utm_medium. Pour le taggage automatique AdWords, il s'agit du CPC. Si les utilisateurs proviennent d'un moteur de recherche détecté par Google Analytics, il s'agit d'un moteur de recherche naturel. Si l'URL de provenance n'est pas un moteur de recherche, il s'agit d'un site référent. Si les utilisateurs ont accédé directement à la propriété et que document.referrer est vide, sa valeur est (none). |
|
channelGrouping |
Groupe de canaux associé à la session d'un utilisateur final pour cette vue (défini par les regroupements de canaux de la vue). |
|
campaign |
Pour le suivi manuel d'une campagne, elle correspond à la valeur du paramètre de suivi de campagne utm_campaign. Pour le taggage automatique AdWords, il s'agit du nom des campagnes publicitaires en ligne que vous utilisez pour la propriété. Si vous n'utilisez ni l'un ni l'autre, sa valeur est (not set). |
|
keyword |
Pour le suivi manuel d'une campagne, elle correspond à la valeur du paramètre de suivi de campagne utm_term. Pour le trafic AdWords, il contient les critères de ciblage qui correspondent le mieux. Pour le Réseau Display, où plusieurs critères de ciblage auraient pu entraîner la diffusion d'une annonce, il renvoie les meilleurs critères de ciblage sélectionnés par Google Ads. Il peut s'agir de "display_keyword", de l'emplacement sur le site, de "boomuserlist", de "user_interest", de "age" ou "gender". Sinon, sa valeur est (not set). |
|
hostname |
Nom d'hôte à partir duquel la demande de suivi a été effectuée. |
|
landingPagePath |
Première page des sessions des utilisateurs, ou page de destination. |
|
activityType |
Type d'activité. |
|
customDimension[] |
Liste de toutes les dimensions personnalisées associées à cette activité. |
|
Champ d'union activity_details . Selon le champ activity_type , un seul des champs suivants sera défini. La activity_details ne peut être qu'un des éléments suivants : |
||
pageview |
Cette valeur est définie si |
|
appview |
Cette valeur est définie si |
|
ecommerce |
Cette valeur est définie si |
|
goals |
Ce champ contient la liste de tous les objectifs atteints dans cette activité lorsque |
|
event |
Ce champ contient toutes les informations concernant un événement. Il est défini si |
CustomDimension
Dimension personnalisée.
Représentation JSON | |
---|---|
{ "index": number, "value": string } |
Champs | |
---|---|
index |
Nombre d'emplacements de la dimension personnalisée. |
value |
Valeur de la dimension personnalisée. La valeur par défaut (chaîne vide) indique la suppression de la valeur de la dimension personnalisée de portée visiteur/de session. |
PageviewData
Représente les informations recueillies lorsque le visiteur consulte une page.
Représentation JSON | |
---|---|
{ "pagePath": string, "pageTitle": string } |
Champs | |
---|---|
pagePath |
URL de la page consultée par le visiteur. |
pageTitle |
Titre de la page consultée par le visiteur. |
ScreenviewData
Représentation JSON | |
---|---|
{ "screenName": string, "mobileDeviceBranding": string, "mobileDeviceModel": string, "appName": string } |
Champs | |
---|---|
screenName |
Nom de l'écran. |
mobileDeviceBranding |
Nom du fabricant du mobile ou de la marque Exemples: "Google", "Apple", etc. |
mobileDeviceModel |
Modèle d'appareil mobile. Exemples: "Pixel", "iPhone", etc. |
appName |
Nom de l'application. |
EcommerceData
Informations d'e-commerce associées à l'activité de l'utilisateur
Représentation JSON | |
---|---|
{ "actionType": enum( |
Champs | |
---|---|
actionType |
Action associée à cette action d'e-commerce. |
transaction |
Détails de la transaction de cette action d'e-commerce. |
products[] |
Détails des produits concernés par cette transaction. |
ecommerceType |
Type d'activité d'e-commerce. |
ECommerceAction
Ensemble de toutes les actions associées à une action d'e-commerce.
Enums | |
---|---|
UNKNOWN |
Le type d'action est inconnu. |
CLICK |
Nombre de clics dans les listes de produits. |
DETAILS_VIEW |
Vues des détails d'un produit. |
ADD_TO_CART |
Ajoutez le(s) produit(s) au panier. |
REMOVE_FROM_CART |
Retirez le(s) produit(s) du panier. |
CHECKOUT |
Procédez au paiement. |
PAYMENT |
Achat terminé. |
REFUND |
Remboursement de l'achat. |
CHECKOUT_OPTION |
Options de paiement. |
TransactionData
Représente les informations recueillies lorsque le visiteur effectue une transaction sur la page.
Représentation JSON | |
---|---|
{ "transactionId": string, "transactionRevenue": number, "transactionTax": number, "transactionShipping": number } |
Champs | |
---|---|
transactionId |
ID de transaction, fourni par la méthode de suivi du commerce électronique, pour l'achat effectué dans le panier. |
transactionRevenue |
Montant total des revenus de la vente (hors taxes et frais de livraison) de la transaction. |
transactionTax |
Montant total des taxes pour la transaction. |
transactionShipping |
Frais de port totaux. |
ProductData
Détails des produits d'une transaction en ligne
Représentation JSON | |
---|---|
{ "productSku": string, "productName": string, "itemRevenue": number, "productQuantity": string } |
Champs | |
---|---|
productSku |
Code unique qui représente le produit. |
productName |
Nom du produit, fourni par l'application de suivi du commerce électronique, pour les articles achetés. |
itemRevenue |
Revenu total généré par les articles achetés. |
productQuantity |
Nombre total d'unités de ce produit dans la transaction. |
EcommerceType
Il s'agit du type de données de commerce électronique qui sont renvoyées.
Enums | |
---|---|
ECOMMERCE_TYPE_UNSPECIFIED |
Utilisé lorsque le type d'activité d'e-commerce n'est pas spécifié. |
CLASSIC |
Utilisé lorsque l'activité comporte des informations d'e-commerce classiques (non améliorées). |
ENHANCED |
Utilisé lorsque l'activité est associée à des informations d'e-commerce améliorées. |
GoalSetData
Représente un ensemble d'objectifs atteints dans une activité.
Représentation JSON | |
---|---|
{
"goals": [
{
object( |
Champs | |
---|---|
goals[] |
Tous les objectifs atteints dans l'activité en cours. |
GoalData
Représente tous les détails relatifs à un objectif.
Représentation JSON | |
---|---|
{ "goalIndex": number, "goalCompletions": string, "goalValue": number, "goalCompletionLocation": string, "goalPreviousStep1": string, "goalPreviousStep2": string, "goalPreviousStep3": string, "goalName": string } |
Champs | |
---|---|
goalIndex |
Ce champ identifie l'objectif tel que configuré pour le profil. |
goalCompletions |
Nombre total d'objectifs réalisés dans cette activité. |
goalValue |
Valeur de cet objectif. |
goalCompletionLocation |
URL de la page sur laquelle cet objectif a été réalisé. |
goalPreviousStep1 |
URL de l'étape précédant la réalisation de l'objectif. |
goalPreviousStep2 |
URL de la page des deux étapes qui précèdent la réalisation de l'objectif. |
goalPreviousStep3 |
URL de la page des trois étapes qui précèdent la réalisation de l'objectif. |
goalName |
Nom de l'objectif. |
EventData
Représente tous les détails d'un événement.
Représentation JSON | |
---|---|
{ "eventCategory": string, "eventAction": string, "eventLabel": string, "eventValue": string, "eventCount": string } |
Champs | |
---|---|
eventCategory |
Objet de la page qui a fait l'objet d'une interaction. Par exemple: "Vidéo". |
eventAction |
Type d'interaction avec l'objet. Exemple: "lire". |
eventLabel |
Libellé associé à l'événement. |
eventValue |
Valeur numérique associée à l'événement. |
eventCount |
Nombre d'événements de ce type dans cette activité. |