Pular para o conteúdo principal

trackUserActivity

Registra um evento de atividade de usuário ou convidado.

Descrição​

Este método registra um único evento de atividade para o usuário autorizado atual ou convidado (por exemplo, uma visualização de produto, uma busca ou uma ação no carrinho). Ele retorna uma Promise que resolve para true se o evento foi registrado, ou um objeto IError se houve um problema.

UserActivity.trackUserActivity(

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

);

Esquema de parâmetros​

Esquema

body(obrigatório): ITrackActivity
Corpo do evento de atividade. Exemplo: { type: "product_view", productId: 12345 }

body.type(obrigatório): TUserActivityType
Tipo do evento de atividade. Um dos: "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".
exemplo: "product_view"

body.productId: número
Identificador do produto.
exemplo: 12345

body.pageId: número
Identificador da página (para page_view, category_view).
exemplo: 7

body.categoryId: número
Identificador de categoria legado.
exemplo: 67

body.query: string
Consulta de busca (para type=search).
exemplo: "case de iphone"

body.meta: Record<string, unknown>
Informações meta arbitrárias (bloco de origem, variante A/B, profundidade de rolagem).

Exemplos​

Exemplo mínimo​

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

Exemplo com atributos​

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

Exemplo de resposta​

true

Esquema de resposta​

Esquema: boolean

boolean: boolean
Retorna true se o evento foi registrado.
exemplo: true