ペイロードオブジェクト

    ペイロードオブジェクト


    記事の要約

    このガイドでは、ShopLive が提供するmessageCallback 関数のパラメーター オブジェクト「payload」を紹介します。

    ON_CLICK_CAMPAIGN_LIST_ITEM

    リストの中から1つの配信がクリックされた時

    ペイロード

    campaign

    PluginCampaign


    ON_PLAYER_MODAL_SHOWN

    プレイヤーのモーダルUIが表示された時

    ペイロード

    campaign

    PluginCampaign


    ON_PLAYER_MODAL_HIDDEN

    プレイヤーのモーダルが閉じられた、もしくは非表示にされた時

    ペイロード

    campaign

    PluginCampaign


    ON_CLICK_CLOSE_PLAYER_MODAL

    プレイヤーのモーダルUIの閉じるボタンがクリックされた時

    ペイロード

    campaign

    PluginCampaign


    ON_LIVE_MINI_PREVIEW_SHOWN / ON_LIVE_MINI_PREVIEW_HIDDEN

    ライブミニプレイヤーが閉じられた時 / ライブミニプレイヤーが非表示になった時


    ON_CLICK_CLOSE_LIVE_MINI_PREVIEW

    ライブミニプレイヤーの閉じるボタンがクリックされた時


    CLICK_PRODUCT

    商品リストの中から1つの商品がクリックされた時

    ペイロード

    payload

    Goods


    LINK_NEW_WINDOW

    商品バナーがクリックされた時

    (ポップアップの設定: クリックイベント - ‘リンク(新規ウィンドウ)')

    ペイロード

    url

    string


    CLICK_SHARE_BTN

    シェアボタンがクリックされた時

    ペイロード

    campaignKey

    string

    shareUrl

    string


    NOW_ONAIR_CHECKED

    オンエア中のライブがあるかどうかを確認する時

    ペイロード

    campaign

    PluginCampaign


    ON_CLICK_BUY_BUTTON

    商品リストの購入ボタンがクリックされた時

    ペイロード

    payload

    Goods


    CLICK_PRODUCT_CART

    商品リストのカートに入れるボタンがクリックされた時

    ペイロード

    payload

    Goods


    ON_PRODUCT_LIST_SHOWN

    プロダクト一覧のポップアップが表示された時

    ペイロード

    productList

    Array<Goods>


    LINK

    ポップアップがクリックされた時 (ポップアップ - クリックイベントが ‘リンク’ となっている必要があります)

    • もし上書きしない場合は、

      • WEBの場合: 現在のページを離れ、ウィンドウにリンク先URLのページが表示されます。

      • APP(SDK)の場合: PIP再生モードになり、NAVIGATIONがコールされます。

    ペイロード

    詳細説明

    campaignKey

    string

    ユニークなキャンペーンキー

    popupResourceId

    string

    ユニークなポップアップキー

    type

    string

    ポップアップの種類

    url

    string

    リンク先URL


    LINK_NEW_WINDOW

    ポップアップがクリックされた時 (ポップアップ - クリックイベントが ‘リンク(新規ウィンドウ)’ となっている必要があります)

    • もし上書きしない場合は、

      • WEBの場合: 現在のページを離れ、新しいウィンドウにリンク先URLのページが表示されます。

      • APP(SDK)の場合: PIP再生モードになり、NAVIGATIONがコールされます。

    ペイロード

    詳細説明

    campaignKey

    string

    ユニークなキャンペーンキー

    popupResourceId

    string

    ユニークなポップアップキー

    type

    string

    ポップアップの種類

    url

    string

    リンク先URL


    DOWNLOAD_COUPON

    ポップアップがクリックされた時 (ポップアップ - クリックイベントがクーポンダウンロードとなっている必要があります)

    ペイロード

    詳細説明

    campaignKey

    string

    ユニークなキャンペーンキー

    popupResourceId

    string

    ユニークなポップアップキー

    type

    string

    ポップアップの種類

    coupon

    string

    クーポンコード


    CUSTOM_ACTION

    ポップアップがクリックされた時 (ポップアップ - クリックイベントがユーザー定義となっている必要があります)

    ペイロード

    詳細説明

    campaignKey

    string

    ユニークなキャンペーンキー

    id

    string

    ユニークなポップアップキー

    type

    string

    ポップアップの種類

    payload

    object

    ユーザー定義のペイロードオブジェクト


    Payload types

    PluginCampaign

    ペイロード

    詳細説明

    campaignKey

    string

    ユニークなキャンペーンキー

    campaignStatus

    "READY" | "ONAIR" | "CLOSED"

    キャンペーンステータス

    title

    string

    キャンペーンタイトル

    scheduledAt

    number (Timestamp in milliseconds)

    キャンペーンの予定開始時間

    memo

    string?

    キャンペーン説明

    backgroundUrl

    string?

    背景画像URL

    rehearsal

    boolean?

    キャンペーンがリハーサル中かどうか

    Goods

    ペイロード

    サンプル

    詳細説明

    sku

    string

    "SKU"

    商品コード

    name

    string

    "PRODUCT_NAME"

    商品名

    brand

    string

    "BRAND"

    ブランド名

    url

    string

    "https://shoplive.cloud"

    リンク先URL

    showingNow

    boolean

    true / false

    ‘NOW’アイコンを表示するかどうか

    salesStatus

    string

    "ON_SALE" | "SOLDOUT" | "ALMOST_SOLDOUT"

    販売中 / 売り切れ / もうすぐ売り切れ

    originalPrice

    LosslessNumber

    {"value": "10000"}

    通常価格

    discountedPrice

    LosslessNumber

    {"value": "9000"}

    割引価格

    discountPercentage

    LosslessNumber

    {"value": "10.0"}

    割引率

    currency

    string

    "KRW"

    通貨

    goodsId

    LosslessNumber

    {"value": "1"}

    商品のユニークキー

    description

    string

    "Description"

    説明

    campaignId

    LosslessNumber

    {"value": "1"}

    ユニークなキャンペーンキー

    isCartOn

    boolean?

    true / false

    カートに追加 / カートから削除