- 印刷する
定義とリスト
- 印刷する
Shopliveが提供するプレーヤーのinit()
関数を実行する際、messageCallback
を定義することで、クーポンのダウンロードや商品クリックなどの事前定義されたアクションを定義することができ、顧客ごとにカスタムアクションを定義することもできます。
クーポン機能への接続方法については、 クーポンクリックイベントをご覧ください。
製品のクリックアクションを制御する方法の詳細については、「 製品のクリックイベント」を参照してください。
ログインが必要な機能にアクセスする際に、ログインしていないユーザーのアクションを定義する方法の詳細については、 ログイン必須イベントを参照してください。
メッセージコールバックの定義
<script type="text/javascript" src="https://static.shoplive.cloud/shoplive.js"></script>
<script>
var messageCallback = {
SHOPLIVE_MESSAGE_CALLBACK_ACTION: function(payload) { // SHOPLIVE_MESSAGE_CALLBACK_ACTIONを希望のアクションに変更
// payload処理ロジックを追加
// ここにpayloadを処理するコードを記述してください
}
};
cloud.shoplive.init({
accessKey: 'YOUR ACCESS KEY HERE',
messageCallback: messageCallback
});
</script>
メッセージコールバックリスト
アクション | ペイロード | 説明 |
---|---|---|
LOGIN_REQUIRED | campaignKey (string) | このイベントは、プレイヤーがゲストとして実行しているときに、プレイヤーがログイン情報を必要とする場合に呼び出されます。(例:ゲストとしてライブ視聴中にチャットボタンをクリックした場合) ログイン画面に移動するコードを挿入することで使用できます。 |
DOWNLOAD_COUPON | coupon (string) type(string) | ポップアップ(バナー、クーポン、お知らせ)がクリックされると、タイプと一緒に設定した値が渡されます。 タイプ - バナー、クーポン、お知らせ |
CLICK_PRODUCT | Goods | このイベントは、製品情報がクリックされたときに呼び出されます。追加処理が必要な場合は、商品詳細ページに移動するためのURLを受け取ることでご利用いただけます。 CLICK_PRODUCTを別途処理しなくても、商品をクリックすると該当URLにプレーヤーが移動します。 |
CLICK_PRODUCT_CART | Goods | このイベントは、商品リストのショッピングカートボタンがクリックされたときに呼び出されます。必要な追加処理に使用するために、ペイロードにはさまざまな製品情報が含まれています。 { "sku":文字列、 "name":文字列、 "ブランド":文字列、 "url":文字列 } |
リンク | JSON オブジェクト {"url":linkUrl} | このイベントは、ポップアップ(バナー、クーポン、お知らせ)のクリックイベントがリンクに設定されたとき、または商品リストの上部にあるリンクがリンクアドレスとともにクリックされたときに呼び出されます。 個別に実装されていない場合(オーバーライド)、ページ自体はWeb内で移動(現在のライブページを終了)し、アプリ(SDK)の場合はPIPモードになり、NAVIGATIONが呼び出されます。 |
LINK_NEW_WINDOW | JSON オブジェクト {"url":リンクUrl} | このイベントは、ポップアップ (バナー、クーポン、通知) のクリック イベントがリンク (新しいウィンドウを開く) に設定され、ユーザーがリンク アドレスと共にリンクをクリックしたときに呼び出されます。 別途実装(オーバーライド)しない場合、WebはlinkUrlを新しいウィンドウで開き、アプリ(SDK)の場合はPIPモードに入りNAVIGATIONが呼び出されます。 |
CLICK_SHARE_BTN | JSON オブジェクト {"url":リンクUrl} | このイベントは、共有ボタンがクリックされたときに呼び出されます。ペイロードには、次の json オブジェクトが含まれています。 { "campaignKey" : string、 "shareUrl" : string } |
NOW_ONAIR_CHECKED | PluginCampaign | オンエア中のライブ配信がある場合に呼び出されます。 |
ON_CLICK_CAMPAIGN_LIST_ITEM | PluginCampaign | Shopliveプラグインのブロードキャストリストの1つがクリックされたとき。 |
ON_PLAYER_MODAL_SHOWN | PluginCampaign | プレーヤーのモーダルUIが画面に表示されているとき。 |
ON_PLAYER_MODAL_HIDDEN | PluginCampaign | プレーヤーのモーダルUIが閉じられ、画面から消えたとき。 |
ON_CLICK_CLOSE_PLAYER_MODAL | PluginCampaign | ユーザーがプレーヤー モーダル UI の閉じるボタンをクリックしたとき。 |
ON_LIVE_MINI_PREVIEW_SHOWN | N/A | 生放送バナーが表示されたとき。 |
ON_LIVE_MINI_PREVIEW_HIDDEN | N/A | ライブ配信のバナーが画面から消えたとき。 |
ON_CLICK_CLOSE_LIVE_MINI_PREVIEW | N/A | ユーザーがライブ配信バナーの閉じるボタンをクリックしたとき。 |
ON_CLICK_BUY_BUTTON | Goods | 商品リストの「購入」ボタンがクリックされたとき。 |
ON_PRODUCT_LIST_SHOWN | Array | 商品一覧ポップアップが表示されたとき |