messageCallback

    messageCallback


    記事の要約

    Shoplive ショートフォームには、ショートフォーム内で発生するイベントを処理できる messageCallback 関数が用意されています。

    messageCallback のインストール例

    以下のコードをページの共通レイアウトにインストールします

    <script type="text/javascript" src="https://static.shoplive.cloud/shoplive-shortform.js"></script>
    <script>
      const messageCallback: { 
        LOGIN_REQUIRED: function(payload) {
          alert("LOGIN_REQUIRED");
          location.href = "YOUR_LOGIN_PAGE_URL";
        },
        ON_CLICK_PRODUCT_ITEM: function(payload) {
          alert("ON_CLICK_PRODUCT_ITEM");
          location.href = payload.product.url;      
        }
      };
      
      cloud.shoplive.initShortform({ 
        accessKey: 'YOUR ACCESS KEY HERE', 
        messageCallback: messageCallback 
      });
    </script>


    メッセージ & ペイロード

    以下は、messageCallback 設定で直接処理できるイベントの一覧です。


    LOGIN_REQUIRED

    ユーザーがコメントを投稿しようとしたときなど、ログインが必要な場所をクリックしたとき。

    payload

    type

    type

    string


    ON_CLICK_PRODUCT_ITEM

    商品リスト内の商品をクリックしたとき

    payload

    type

    product

    Product

    shorts

    Shorts


    ON_CLICK_SHARE_BUTTON

    共有ボタンをクリックしたとき

    payload

    type

    shorts

    Shorts

    url

    string

    PLAY_SHORTFORM_DETAIL

    ショートフォームの詳細(ショートフォームフィード内の各ビデオ)を個別に再生する場合

    Payload

    Type

    shorts

    Shorts

    DETAIL_ACTIVE

    ショートフォームの詳細(ショートフォームフィード内の各ビデオ)が表示される場合

    Payload

    Type

    shorts

    Shorts

    DETAIL_ON_PLAYER_DISMISS

    ショートフォームの詳細(ショートフォームフィード内の各ビデオ)を閉じた場合

    Payload

    Type

    N/A

    N/A

    DETAIL_VIEWING_SECONDS

    Payload

    Type

    shorts

    Shorts

    videoCurrentTime

    number