Analytics
LiSA Library

3min
The integration with your Analytics tool is done via events the LiSA Library exposes. 
LiSA Library Events
Player open —library.player.Event.OPEN
Show view — library.player.Event.SHOW_READY
View product — library.player.Event.PRODUCT_VIEW
Product like / add to wishlist — library.player.Event.PRODUCT_GRANT_REACTION
Product remove like / remove from wishlist — library.player.Event.PRODUCT_REVOKE_REACTION
Add to shopping cart — library.player.Event.PRODUCT_ADD_TO_CART
View shopping cart —library.player.Event.CART_VIEW
Libary on-ready hook
With the help of the on.ready hook in the library configuration you have the option to register callback functions for the respective events of the LiSA Player.
To be able to register callback functions for the events of the player, the on-ready hook of the library must be specified in the configuration. 
JS
window.LiSA.library.configs.push({
  on: {
    ready: (library) => {
      // register callbacks to the player's events
    }
  },
});
window.LiSA.library.configs.push({
  on: {
    ready: (library) => {
      // register callbacks to the player's events
    }
  },
});
﻿
The first argument of the callback function is an instance of the LiSA LIbrary — we call it library in the example above. The Library instance exposes the Player instance of the library via the player property.
You can register callback functions using the player's on() method:
JS
window.LiSA.library.configs.push({
  on: {
    ready: (library) => {
      /**
       * @see https://docs.hello-lisa.com/callback-functions#dyl_y
       */
      library.player.on(library.player.Event.OPEN, (showId) => {
        // todo: send event to analytics about a show being opened in the player
      });

      /**
       * @see https://docs.hello-lisa.com/callback-functions#e0vek
       */
      library.player.on(library.player.Event.SHOW_READY, (eventData) => {
        // todo: send event to analytics about a show impression
      });

      /**
       * @see https://docs.hello-lisa.com/callback-functions#9Phjh
       */
      library.player.on(
        library.player.Event.PRODUCT_VIEW,
        (eventData, first, productData) => {
          // todo: send event to analytics about a product view
        },
      );

      /**
       * @see https://docs.hello-lisa.com/callback-functions#YqR9J
       */
      library.player.on(
        library.player.Event.PRODUCT_GRANT_REACTION,
        (eventData, first, product) => {
          // todo: send event to analytics about a product being liked or added
          //  to wishlist
        },
      );

      /**
       * @see https://docs.hello-lisa.com/callback-functions#iKhsg
       */
      library.player.on(
        library.player.Event.PRODUCT_REVOKE_REACTION,
        (eventData, first, product) => {
          // todo: send event to analytics about a product being no longer liked
          //  or removed from wishlist
        },
      );

      /**
       * @see https://docs.hello-lisa.com/callback-functions#MqHdQ
       */
      library.player.on(
        library.player.Event.PRODUCT_ADD_TO_CART,
        (eventData, first, product) => {
          // todo: send event to analytics about a product being added to shopping
          //  cart
        },
      );

      /**
       * @see https://docs.hello-lisa.com/callback-functions#s-Coj
       */
      library.player.on(library.player.Event.CART_VIEW, (url) => {
        // todo: send event to analytics about shopping cart being viewed
      });
    }
  },
});
window.LiSA.library.configs.push({
  on: {
    ready: (library) => {
      /**
       * @see https://docs.hello-lisa.com/callback-functions#dyl_y
       */
      library.player.on(library.player.Event.OPEN, (showId) => {
        // todo: send event to analytics about a show being opened in the player
      });

      /**
       * @see https://docs.hello-lisa.com/callback-functions#e0vek
       */
      library.player.on(library.player.Event.SHOW_READY, (eventData) => {
        // todo: send event to analytics about a show impression
      });

      /**
       * @see https://docs.hello-lisa.com/callback-functions#9Phjh
       */
      library.player.on(
        library.player.Event.PRODUCT_VIEW,
        (eventData, first, productData) => {
          // todo: send event to analytics about a product view
        },
      );

      /**
       * @see https://docs.hello-lisa.com/callback-functions#YqR9J
       */
      library.player.on(
        library.player.Event.PRODUCT_GRANT_REACTION,
        (eventData, first, product) => {
          // todo: send event to analytics about a product being liked or added
          //  to wishlist
        },
      );

      /**
       * @see https://docs.hello-lisa.com/callback-functions#iKhsg
       */
      library.player.on(
        library.player.Event.PRODUCT_REVOKE_REACTION,
        (eventData, first, product) => {
          // todo: send event to analytics about a product being no longer liked
          //  or removed from wishlist
        },
      );

      /**
       * @see https://docs.hello-lisa.com/callback-functions#MqHdQ
       */
      library.player.on(
        library.player.Event.PRODUCT_ADD_TO_CART,
        (eventData, first, product) => {
          // todo: send event to analytics about a product being added to shopping
          //  cart
        },
      );

      /**
       * @see https://docs.hello-lisa.com/callback-functions#s-Coj
       */
      library.player.on(library.player.Event.CART_VIEW, (url) => {
        // todo: send event to analytics about shopping cart being viewed
      });
    }
  },
});
﻿
For a detailed description of the event callback function signatures and examples read Callback Functions﻿.
Updated 25 Mar 2024
Did this page help you?
Shopping Events
Callback Functions