- Requête HTTP
- Corps de la requête
- Corps de la réponse
- Champs d'application des autorisations
- Utilisateur
- UserIdType (Type d'ID utilisateur)
- ActivityType (Type d'activité)
- UserActivitySession
- Activité
- CustomDimension
- PageviewData
- ScreenviewData
- EcommerceData
- E-commerce
- TransactionData
- ProductData
- EcommerceType
- GoalSetData
- GoalData
- EventData
- Essayer
Affiche les données d'activité des utilisateurs.
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 |
Période pour laquelle récupérer l'activité de l'utilisateur. Si aucune plage de dates n'est spécifiée, la plage de dates par défaut est (startDate: current date - 7 days, endDate: current date - 1 day). |
viewId |
Obligatoire. ID de la vue Analytics à partir de laquelle récupérer des données. Chaque SearchUserActivityRequest doit contenir le |
user |
Obligatoire. ID utilisateur unique à interroger. Chaque SearchUserActivityRequest doit contenir ce champ. |
activityTypes[] |
Ensemble de tous les types d'activités demandés. Seules les installations correspondant à ces types seront renvoyées dans la réponse. Si ce champ est vide, toutes les activités seront 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 > 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 |
Jeton de continuité pour obtenir la page de résultats suivante. Si vous l'ajoutez à la requête, les lignes sont renvoyées après "pageToken". "pageToken" doit correspondre à la valeur renvoyée dans le paramètre "nextPageToken" en 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 (détails 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 et est 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 particulier.
Représentation JSON | |
---|---|
{
"type": enum( |
Champs | |
---|---|
type |
Type de l'utilisateur dans la requête. Le champ |
userId |
Identifiant unique de l'utilisateur pour lequel les données sont demandées. |
Type d'ID utilisateur
Représente les différents types d'identifiants utilisateur disponibles.
Enums | |
---|---|
USER_ID_TYPE_UNSPECIFIED |
Si aucun type d'ID utilisateur n'est spécifié, le type par défaut 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é à Analytics. |
Type d'activité
Enums | |
---|---|
ACTIVITY_TYPE_UNSPECIFIED |
"ActivityType" n'aura jamais cette valeur dans la réponse. L'utilisation de ce type dans la requête entraîne une erreur. |
PAGEVIEW |
Utilisé lorsque l'activité est générée par un visiteur consultant une page. |
SCREENVIEW |
Utilisé lorsque l'activité provient d'un visiteur qui utilise une application sur un appareil mobile. |
GOAL |
Utilisé pour indiquer une activité de type d'objectif. |
ECOMMERCE |
Une transaction d'e-commerce a été effectuée par le visiteur sur la page. |
EVENT |
Utilisé lorsque l'activité est un événement. |
SessionActivitéUtilisateur
Il s'agit d'une session d'un utilisateur effectuée sur un appareil à un moment précis au cours d'une période donnée.
Représentation JSON | |
---|---|
{
"sessionId": string,
"deviceCategory": string,
"platform": string,
"dataSource": string,
"activities": [
{
object( |
Champs | |
---|---|
sessionId |
ID unique de la session. |
deviceCategory |
Type d'appareil utilisé : "mobile", "tablette", etc. |
platform |
Plate-forme sur laquelle l'activité a eu lieu : "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 cette session au format ISO-8601. |
Activité
Une activité représente les données d'une 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 un objectif réalisé, il y aura deux protos d'activité pour cet appel, un pour l'ECOMMERCE et un pour l'objectif GOAL. À l'inverse, plusieurs appels peuvent également constituer une 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é ECOMMERCE.
Représentation JSON | |
---|---|
{ "activityTime": string, "source": string, "medium": string, "channelGrouping": string, "campaign": string, "keyword": string, "hostname": string, "landingPagePath": string, "activityType": enum( |
Champs | ||
---|---|---|
activityTime |
Horodatage 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 des campagnes, il s'agit de la valeur du paramètre 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 référence les utilisateurs. Il peut également contenir une adresse de port. Si les utilisateurs sont arrivés sans URL de provenance, la valeur est (direct). |
|
medium |
Type de sites référents. Pour le suivi manuel des campagnes, il s'agit de la valeur du paramètre 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 est 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 sont venus directement sur la propriété et que l'élément document.referrer est vide, sa valeur est (aucun). |
|
channelGrouping |
Groupe de canaux associé à une session d'utilisateur final pour cette vue (défini par les groupes de canaux de la vue). |
|
campaign |
Pour le suivi manuel des campagnes, il s'agit de la valeur du paramètre utm_campaign. Le taggage automatique AdWords correspond au 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 des campagnes, il s'agit de la valeur du paramètre utm_term. Pour le trafic AdWords, il contient les critères de ciblage les plus pertinents. Pour le Réseau Display, où plusieurs critères de ciblage auraient pu déclencher la diffusion de l'annonce, elle renvoie les critères de ciblage les plus pertinents sélectionnés par Ads. (par exemple, display_keyword, placement de site, boomuserlist, user_interest, age ou sexe). 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 ou de la page de destination. |
|
activityType |
Type de cette activité. |
|
customDimension[] |
Liste de toutes les dimensions personnalisées associées à cette activité. |
|
Champ d'union activity_details . Selon la activity_type , exactement l'un des champs suivants sera défini. La activity_details ne peut être qu'un des éléments suivants : |
||
pageview |
Ce paramètre sera défini si |
|
appview |
Ce paramètre sera défini si |
|
ecommerce |
Ce paramètre sera défini si |
|
goals |
Ce champ contient la liste de tous les objectifs atteints dans cette activité lorsque |
|
event |
Ce champ contient tous les détails concernant un événement et sera défini si |
Dimension personnalisée
Dimension personnalisée.
Représentation JSON | |
---|---|
{ "index": number, "value": string } |
Champs | |
---|---|
index |
Numéro de l'emplacement de la dimension personnalisée. |
value |
Valeur de la dimension personnalisée. Une valeur par défaut (c'est-à-dire une chaîne vide) indique l'effacement de la valeur de la dimension personnalisée associée à la portée de la session/du visiteur. |
Données sur les pages vues
Représente les détails collectés 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. |
Données de l'écran
Représentation JSON | |
---|---|
{ "screenName": string, "mobileDeviceBranding": string, "mobileDeviceModel": string, "appName": string } |
Champs | |
---|---|
screenName |
Nom de l'écran. |
mobileDeviceBranding |
Nom du fabricant ou de la marque pour mobile. Exemple : "Google", "Apple", etc. |
mobileDeviceModel |
Modèle de l'appareil mobile. (par exemple, "Pixel", "iPhone", etc.). |
appName |
Nom de l'application. |
Données d'e-commerce
Informations sur l'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 des transactions associées à cette action d'e-commerce. |
products[] |
Détails des produits de cette transaction. |
ecommerceType |
Type d'activité d'e-commerce. |
Action d'e-commerce
Ensemble de toutes les actions associées à une action d'e-commerce.
Enums | |
---|---|
UNKNOWN |
Le type d'action est inconnu. |
CLICK |
Parcourez les listes de produits. |
DETAILS_VIEW |
Vues des détails du produit. |
ADD_TO_CART |
Ajoutez des produits au panier. |
REMOVE_FROM_CART |
Supprimez le ou les produits du panier. |
CHECKOUT |
Procédez au paiement. |
PAYMENT |
Achat terminé. |
REFUND |
Remboursement de l'achat. |
CHECKOUT_OPTION |
Options de paiement |
Données de transaction
Représente les détails collectés lorsque le visiteur effectue une transaction sur la page.
Représentation JSON | |
---|---|
{ "transactionId": string, "transactionRevenue": number, "transactionTax": number, "transactionShipping": number } |
Champs | |
---|---|
transactionId |
Identifiant de la transaction, fourni par la méthode de suivi de l'e-commerce, pour l'achat dans le panier. |
transactionRevenue |
Montant total des revenus de la transaction (hors taxes et frais de livraison) |
transactionTax |
Montant total des taxes pour la transaction. |
transactionShipping |
Frais de port totaux. |
Données produit
Détails des produits dans une transaction e-commerce
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 de l'e-commerce, pour les articles achetés. |
itemRevenue |
Total des revenus générés par les articles achetés. |
productQuantity |
Nombre total d'unités de produit dans la transaction. |
Type d'e-commerce
Il s'agit du type de données d'e-commerce 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é inclut des informations classiques (non améliorées) sur l'e-commerce. |
ENHANCED |
Utilisé lorsque l'activité comporte des informations améliorées sur l'e-commerce. |
Objectif de données
Représente un ensemble d'objectifs atteints dans une activité.
Représentation JSON | |
---|---|
{
"goals": [
{
object( |
Champs | |
---|---|
goals[] |
Tous les objectifs de l'activité actuelle. |
Données de l'objectif
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 |
Cela permet d'identifier l'objectif 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 la page une étape avant la réalisation de l'objectif. |
goalPreviousStep2 |
URL de la page deux étapes avant la réalisation de l'objectif. |
goalPreviousStep3 |
URL de la page en trois étapes avant d'atteindre l'objectif. |
goalName |
Nom de l'objectif. |
Données d'événement
Représente tous les détails concernant un événement.
Représentation JSON | |
---|---|
{ "eventCategory": string, "eventAction": string, "eventLabel": string, "eventValue": string, "eventCount": string } |
Champs | |
---|---|
eventCategory |
Objet sur la page avec lequel vous avez interagi. Exemple : "Vidéo" |
eventAction |
Type d'interaction avec l'objet. Exemple: &play |
eventLabel |
Libellé associé à l'événement. |
eventValue |
Valeur numérique associée à l'événement. |
eventCount |
Nombre de tels événements dans cette activité. |