Aller au contenu principal

trackUserActivity

Enregistrer un événement d'activité d'un utilisateur ou d'un invité.

Description

Cette méthode enregistre un événement d'activité unique pour l'utilisateur autorisé actuel ou l'invité (par exemple, une vue de produit, une recherche ou une action sur le panier). Elle renvoie une promesse qui se résout en true si l'événement a été enregistré, ou un objet IError s'il y a eu un problème.

UserActivity.trackUserActivity(

body*, body.type*, body.productId, body.pageId, body.categoryId, body.query, body.meta

);

Paramètres du schéma

Schéma

body(obligatoire): ITrackActivity
Corps de l'événement d'activité. Exemple : { type: "product_view", productId: 12345 }

body.type(obligatoire): TUserActivityType
Type de l'événement d'activité. Un des suivants : "product_view", "page_view", "category_view", "search", "product_add_to_cart", "product_remove_from_cart", "product_add_to_wishlist", "product_remove_from_wishlist", "product_purchase", "product_rating".
exemple : "product_view"

body.productId: number
Identifiant du produit.
exemple : 12345

body.pageId: number
Identifiant de la page (pour page_view, category_view).
exemple : 7

body.categoryId: number
Identifiant de catégorie hérité.
exemple : 67

body.query: string
Requête de recherche (pour type=search).
exemple : "iphone case"

body.meta: Record<string, unknown>
Informations méta arbitraires (bloc source, variante A/B, profondeur de défilement).

Exemples

Exemple minimal

const response = await UserActivity.trackUserActivity({
type: 'product_view',
productId: 12345,
});

Exemple avec des attributs

const response = await UserActivity.trackUserActivity({
type: 'search',
query: 'iphone case',
meta: { sourceBlock: 'header_search', variant: 'b' },
});

Exemple de réponse

true

Schéma de réponse

Schéma : boolean

boolean: boolean
Renvoie true si l'événement a été enregistré.
exemple : true