Products
Product Event
Along with all standard Analytics Event properties, a Product Event includes the following additional properties:
Schema
interface ProductEvent extends Omit<
AnalyticsEvent,
'eventType'
> {
eventType:
| 'lsc:product:add-to-cart'
| 'lsc:product:add-to-wishlist'
| 'lsc:product:click'
| 'lsc:product:emoji'
| 'lsc:product:impresssion';
/**
* The product's brand name translated to the visitor's locale,
* if provided.
*/
productBrand?: string;
/**
* The currency code (ISO 4217, 3-letter format) of the product price.
*/
productCurrency?: string;
/**
* Universally unique, LiSA-assigned product identifier.
*/
productId: string;
/**
* The product's original price, if currently on sale.
*/
productOriginalPrice?: number;
/**
* The prouduct's current price.
*/
productPrice?: number;
/**
* The unique product identifier as assigned by the customer's
* ecommerce system.
*/
productReference?: string;
/**
* The product title, translated to the visitor's locale.
*/
productTitle: string;
/**
* Universally unique, LiSA-assigned product variant identifier.
*/
variantId?: string;
/**
* The unique product variant identifier as assigned by the
* customer's ecommerce system.
*/
variantReference?: string;
}
Alias Mapping Table
lsc.productBrand
Product brand
prop{PRODUCT_BRAND}
Brand
lsc.productCurrency
Regional segmentation
prop{VISITOR_NAME}
Currency
lsc.productId
Attribution to specific products
eVar{PRODUCT_ID}
LiSA Product ID
lsc.productOriginalPrice
Dynamic pricing analysis or revenue accuracy
prop{ORIGINAL_PRICE}
Original Price
lsc.productPrice
Dynamic pricing analysis or revenue accuracy
prop{PRICE}
Price
lsc.productReference
Attribution to specific products
eVar{PRODUCT_REFERENCE} or merchandising eVar
Product ID
lsc.productTitle
Product name
prop{PRODUCT_NAME}
Product Name
lsc.variantId
Attribution to specific products
eVar{VARIANT_ID}
LiSA Variant ID
lsc.variantReference
Attribution to specific products
eVar{VARIANT_REFERENCE} merchandising eVar
Variant ID
lsc:product:add-to-cart
lsc:product:add-to-cart
Visitor added a product to their cart.
Schema
export interface ProductAddToCartEvent extends Omit<
ProductEvent,
'eventType'
> {
eventType: 'lsc:product:add-to-cart';
}
lsc:product:add-to-wishlist
lsc:product:add-to-wishlist
Visitor added a product to their wishlist.
Schema
export interface ProductAddToWishlistEvent extends Omit<
ProductEvent,
'eventType'
> {
eventType: 'lsc:product:add-to-wishlist';
}
lsc:product:click
lsc:product:click
Visitor clicked a product to see the product details.
Schema
export interface ProductClickEvent extends Omit<
ProductEvent,
'eventType'
> {
eventType: 'lsc:product:click';
}
lsc:product:emoji
lsc:product:emoji
Visitor reacted to the product with an emoji.
Schema
export interface ProductEmojiEvent extends Omit<
ProductEvent,
'eventType'
> {
eventType: 'lsc:product:emoji';
}
lsc:product:impression
lsc:product:impression
Product card appeared in the visitor's viewport for the first time.
Schema
export interface ProductImpressionEvent extends Omit<
ProductEvent,
'eventType'
> {
eventType: 'lsc:product:impression';
// Event-specific fields
/**
* Indicates, whether this is the first impression of this product
* for the current media item.
*/
firstOccurrence: boolean;
}
Alias Mapping Table
lsc.firstOccurrence
Filtering
prop{FIRST_OCCURRENCE}
First Occurrence
Last updated