Method: userActivity.search

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(DateRange)
  },
  "viewId": string,
  "user": {
    object(User)
  },
  "activityTypes": [
    enum(ActivityType)
  ],
  "pageSize": number,
  "pageToken": string
}
Champs
dateRange

object(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

string

Obligatoire. ID de la vue Analytics à partir de laquelle récupérer les données. Chaque SearchUserActivityRequest doit contenir le viewId.

user

object(User)

Obligatoire. Identifiant de l'utilisateur unique à interroger. Chaque SearchUserActivityRequest doit contenir ce champ.

activityTypes[]

enum(ActivityType)

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

number

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

string

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(UserActivitySession)
    }
  ],
  "totalRows": number,
  "nextPageToken": string,
  "sampleRate": number
}
Champs
sessions[]

object(UserActivitySession)

Chaque enregistrement représente une session (informations sur l'appareil, durée, etc.).

totalRows

number

Nombre total de lignes renvoyées par cette requête (sur différentes pages).

nextPageToken

string

Ce jeton doit être transmis à SearchUserActivityRequest pour récupérer la page suivante.

sampleRate

number

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(UserIdType),
  "userId": string
}
Champs
type

enum(UserIdType)

Type d'utilisateur dans la requête. Le champ userId est associé à ce type.

userId

string

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(Activity)
    }
  ],
  "sessionDate": string
}
Champs
sessionId

string

Identifiant unique de la session.

deviceCategory

string

Type d'appareil utilisé: "mobile", "tablette", etc.

platform

string

Plate-forme sur laquelle l'activité s'est produite: "android", "ios", etc.

dataSource

string

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[]

object(Activity)

Représente une vue détaillée de chacune des activités de cette session.

sessionDate

string

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(ActivityType),
  "customDimension": [
    {
      object(CustomDimension)
    }
  ],

  // Union field activity_details can be only one of the following:
  "pageview": {
    object(PageviewData)
  },
  "appview": {
    object(ScreenviewData)
  },
  "ecommerce": {
    object(EcommerceData)
  },
  "goals": {
    object(GoalSetData)
  },
  "event": {
    object(EventData)
  }
  // End of list of possible types for union field activity_details.
}
Champs
activityTime

string (Timestamp format)

Code temporel de l'activité.

Horodatage au format RFC3339 UTC "Zulu", précis à la nanoseconde près. Exemple : "2014-10-02T15:01:23.045123456Z"

source

string

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

string

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

string

Groupe de canaux associé à la session d'un utilisateur final pour cette vue (défini par les regroupements de canaux de la vue).

campaign

string

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

string

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

string

Nom d'hôte à partir duquel la demande de suivi a été effectuée.

landingPagePath

string

Première page des sessions des utilisateurs, ou page de destination.

activityType

enum(ActivityType)

Type d'activité.

customDimension[]

object(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

object(PageviewData)

Cette valeur est définie si activityType est égal à PAGEVIEW. Ce champ contient toutes les informations sur le visiteur et la page consultée.

appview

object(ScreenviewData)

Cette valeur est définie si activityType est égal à SCREEN_VIEW.

ecommerce

object(EcommerceData)

Cette valeur est définie si activityType est égal à ECOMMERCE.

goals

object(GoalSetData)

Ce champ contient la liste de tous les objectifs atteints dans cette activité lorsque activityType est égal à GOAL.

event

object(EventData)

Ce champ contient toutes les informations concernant un événement. Il est défini si activityType correspond à EVENT.

CustomDimension

Dimension personnalisée.

Représentation JSON
{
  "index": number,
  "value": string
}
Champs
index

number

Nombre d'emplacements de la dimension personnalisée.

value

string

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

string

URL de la page consultée par le visiteur.

pageTitle

string

Titre de la page consultée par le visiteur.

ScreenviewData

Représentation JSON
{
  "screenName": string,
  "mobileDeviceBranding": string,
  "mobileDeviceModel": string,
  "appName": string
}
Champs
screenName

string

Nom de l'écran.

mobileDeviceBranding

string

Nom du fabricant du mobile ou de la marque Exemples: "Google", "Apple", etc.

mobileDeviceModel

string

Modèle d'appareil mobile. Exemples: "Pixel", "iPhone", etc.

appName

string

Nom de l'application.

EcommerceData

Informations d'e-commerce associées à l'activité de l'utilisateur

Représentation JSON
{
  "actionType": enum(ECommerceAction),
  "transaction": {
    object(TransactionData)
  },
  "products": [
    {
      object(ProductData)
    }
  ],
  "ecommerceType": enum(EcommerceType)
}
Champs
actionType

enum(ECommerceAction)

Action associée à cette action d'e-commerce.

transaction

object(TransactionData)

Détails de la transaction de cette action d'e-commerce.

products[]

object(ProductData)

Détails des produits concernés par cette transaction.

ecommerceType

enum(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

string

ID de transaction, fourni par la méthode de suivi du commerce électronique, pour l'achat effectué dans le panier.

transactionRevenue

number

Montant total des revenus de la vente (hors taxes et frais de livraison) de la transaction.

transactionTax

number

Montant total des taxes pour la transaction.

transactionShipping

number

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

string

Code unique qui représente le produit.

productName

string

Nom du produit, fourni par l'application de suivi du commerce électronique, pour les articles achetés.

itemRevenue

number

Revenu total généré par les articles achetés.

productQuantity

string (int64 format)

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(GoalData)
    }
  ]
}
Champs
goals[]

object(GoalData)

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

number

Ce champ identifie l'objectif tel que configuré pour le profil.

goalCompletions

string (int64 format)

Nombre total d'objectifs réalisés dans cette activité.

goalValue

number

Valeur de cet objectif.

goalCompletionLocation

string

URL de la page sur laquelle cet objectif a été réalisé.

goalPreviousStep1

string

URL de l'étape précédant la réalisation de l'objectif.

goalPreviousStep2

string

URL de la page des deux étapes qui précèdent la réalisation de l'objectif.

goalPreviousStep3

string

URL de la page des trois étapes qui précèdent la réalisation de l'objectif.

goalName

string

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

string

Objet de la page qui a fait l'objet d'une interaction. Par exemple: "Vidéo".

eventAction

string

Type d'interaction avec l'objet. Exemple: "lire".

eventLabel

string

Libellé associé à l'événement.

eventValue

string (int64 format)

Valeur numérique associée à l'événement.

eventCount

string (int64 format)

Nombre d'événements de ce type dans cette activité.

Essayer