LiSA Social Commerce
Developers
Developers
  • Developers
  • Guides
    • Integration Guide
      • Web Integration
      • App Integration
        • Android
          • Communication
          • Storage
          • File Downloads
          • Theming
        • iOS
          • Communication
          • Storage
          • File Downloads
          • Theming
        • React Native
          • Communication
          • Storage
          • File Downloads
          • Theming
        • Picture in Picture
      • Entrypoints
        • Query Parameter (v1)
    • Player Communication
      • Message API Reference
        • App
          • App — Heartbeat
          • App — Message Acknowledge
          • App — Message Error
          • App — Listen
        • CTA
          • CTA — Link in Comments
          • CTA — Sponsor Badge
        • Cart — View Cart
        • Comments — Join
        • Media
          • Media — Complete
          • Media — Pause
          • Media — Progress
          • Media — Resume
        • Media Item
          • Media Item — Emoji
          • Media Item — Impression
        • Player
          • Player — Dismiss
          • Player — Native Picture-in-Picture (PiP)
          • Player — Pass Visual Viewport
          • Player — Request Visual Viewport
          • Player — UI Transition
        • Products
          • Products — Add to Cart
          • Products — Add to Wishlist
          • Products — Click
          • Products — Close Product List
          • Products — Emoji
          • Products — Emoji State Update
          • Products — Impression
          • Products — Open Product List
        • Stickers
          • Stickers — Activate
          • Stickers — Click
          • Stickers — Expire
          • Stickers — Impression
          • Stickers — Publish
          • Stickers — Unlock
          • Stickers — Unpublish
          • Stickers — Update
          • Stickers — Voucher Claim
        • Visitor — Pass User Context
        • Shared Legacy Message Properties
    • Products
      • Product Update Notification API
  • Widgets
    • Content Hub
    • Quick Start Guide
    • Appearance
      • Markup
      • Responsive design
    • Configuration options
      • Autoplay
      • Channel
      • Client
      • Data
      • Debug
      • Host node
      • Layout
      • Language
      • On
      • Player
      • Query string
      • Quick view
      • Sections
      • Store
      • Template
    • API reference
      • Library API reference
      • Player API reference
      • Quick View API reference
    • Customisations
      • Template
      • Bring your own template
      • Type definitions
    • Examples
    • Type definitions
      • Asset
      • Product
      • Other
    • Promo Widget
      • Quick Start Guide
      • Configuration options
        • Autoplay
        • Channel
        • Countdown (deprecated)
        • Enabled
        • Image modifier
        • Lead time
        • Live (deprecated)
        • Position
        • Replay (deprecated)
        • Show ID
        • URL
  • Media Player Introduction
    • Picture-in-Picture Mode
  • Analytics
  • REST API
    • Authentication
    • Rate limits
    • Response status and error codes
    • API Documentation
Powered by GitBook
On this page
  • Properties
  • Type Definition
  • Examples
  1. Guides
  2. Player Communication
  3. Message API Reference
  4. Products

Products — Impression

PreviousProducts — Emoji State UpdateNextProducts — Open Product List

Last updated 1 month ago

The LiSA Player dispatches a message when a product card or sticker becomes visible in the user's viewport.

Note: The Impression message is only sent once per product, media item and user session.

This message is sent by the LiSA Player to the host app / environment.

Properties

Along with all standard , an Impression message includes the following additional properties:

Name
Type
Description

firstOccurrence

Required.

The firstOccurrence property specifies whether this is the user's first instance of a product impression event. A product impression is only regarded as the first occurrence if it has not been triggered repeatedly within a 15-minute window.

messageType

Required.

lsc:product:impression

Legacy Properties

If your integration uses LiSA Player Version 1, none of the properties described above will be available.

For LiSA Player Version 2, legacy properties can be ignored.

Name
Type
Description

action

Required.

target

Required.


Type Definition

interface ProductImpressionMessage extends Omit<
  ProductMessage,
  'messageType'
> {
  firstOccurrence: boolean;
  messageType: 'lsc:product:impression';
}

Examples

{
  "clockDriftInMs": 0,
  "firstOccurrence": true,
  "mediaItemId": "9f333331-45cb-4289-8bcd-9023c1871111",
  "mediaItemType": "live",
  "messageType": "lsc:product:impression",
  "product": {
    "hasStock": true,
    "reference": "f20312c0-40a2-4b20-986c-5b81ceca6eae",
    "storeOverrides": [],
    "mainImage": {
      "width": 1330,
      "sizeInBytes": 349018,
      "hash": "UMPGjZ%N?G?a?Gj?M|j]~ot6IVWCE5ai-oax",
      "url": "https://image.lisa-cdn.net/demo/product/ab016523/324c09bd-8206-46ae-8123-dade826bce81.jpg",
      "height": 1920
    },
    "price": {
      "currencyCode": "EUR",
      "currencySymbol": "€",
      "price": 89.95
    },
    "name": "RAVE UNISEX - Ski goggles - matt black/white",
    "id": "ab016523-250c-49a3-b2b4-86487d9df813",
    "variants": [],
    "title": {
      "*": "RAVE UNISEX - Ski goggles - matt black/white"
    },
    "url": "https://my-storefront.com/rave-unisex-ski-goggles-matt-black-white.html"
  },
  "productBrand": "BLIZ",
  "productCurrency": "EUR",
  "productId": "ab016523-250c-49a3-b2b4-86487d9df813",
  "productPrice": 89.95,
  "productReference": "f20312c0-40a2-4b20-986c-5b81ceca6eae",
  "productTitle": "RAVE UNISEX - Ski goggles - matt black/white",
  "progress": {
    "bufferedTimeInMs": 648036,
    "currentTimeInMs": 628008,
    "durationInMs": 4616000,
    "elapsedTimeInMs": 28784,
    "skipTimeInMs": 600000,
    "isLive": true,
    "visitorDwellTimeInMs": 29135,
    "isPlaying": true
  },
  "sender": "LiSA",

  "action": "impression",
  "additional": {
    "action": "https://my-storefront.com/rave-unisex-ski-goggles-matt-black-white.html",
    "showDate": "2025-01-15T18:00:00.000Z",
    "showId": "9f333331-45cb-4289-8bcd-9023c1871111",
    "showName": "Shred the Slopes: The Ultimate Ski Gear Guide 🎿❄️",
    "showState": "live",
    "showTitle": "Shred the Slopes: The Ultimate Ski Gear Guide 🎿❄️",
    "playing": true,
    "time": 620,
    "id": "f20312c0-40a2-4b20-986c-5b81ceca6eae"
  },
  "first": true,
  "item": {
    "data": {
      "origin": {
        "id": "f20312c0-40a2-4b20-986c-5b81ceca6eae"
      }
    },
    "id": "ab016523-250c-49a3-b2b4-86487d9df813",
    "type": "product"
  },
  "target": "carousel.item"
}

impression Please use messageType instead.

carousel.item Please use messageType instead.

Boolean
Literal
String
Literal
⚠️
⚠️
Product message properties