정의 및 목록

    정의 및 목록


    기사 요약

    샵라이브에서 제공하는 플레이어의 init() 수행시 messageCallback 정의를 통해 쿠폰 다운로드, 상품 클릭과 같이 미리 정해진 action에 대한 정의를 할 수 있고 고객사 별로 커스텀 액션을 정의할 수도 있습니다.


    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 대신 원하는 action으로 변경
          // payload 처리 로직 추가
          // 여기에 payload를 처리하는 코드를 작성하세요
        }
      };
    
      cloud.shoplive.init({
        accessKey: 'YOUR ACCESS KEY HERE', 
        messageCallback: messageCallback
      });
    </script>


    messageCallback 목록

    Action

    Payload

    Description

    LOGIN_REQUIRED

    campaignKey

    (string)

    Guest로 플레이어를 실행한 상태에서 플레이어에서 로그인 정보가 필요한 경우 호출됩니다. (예, Guest로 라이브 시청 중 채팅 버튼을 클릭할 경우) 로그인 화면으로 이동하는 코드를 삽입하여 사용할 수 있습니다.

    DOWNLOAD_COUPON

    coupon

    (string)

    type

    (string)

    팝업(배너, 쿠폰, 공지)을 클릭할 때 타입과 함께 설정해놓은 값을 전달합니다.

    type (발생 타입): BANNER, COUPON, NOTICE

    CLICK_PRODUCT

    Goods

    상품 정보가 클릭되었을 경우 호출됩니다. 상품 상세 페이지 이동을 위한 URL을 받아서 별도의 처리가 필요한 경우 활용할 수 있습니다.

    * CLICK_PRODUCT을 별도로 처리하지 않아도 플레이어에서 상품을 클릭하면 해당 URL로 이동하도록 되어 있습니다. (새창으로 이동. 만약 현재 창에서 이동하고자 할 경우 샘플 코드를 참고하시기 바랍니다)

    CLICK_PRODUCT_CART

    Goods

    상품 리스트 내 장바구니 버튼을 클릭했을 경우 호출됩니다. 별도의 처리가 필요한 경우 활용할 수 있도록, 상품의 여러가지 정보가 payload 에 포함됩니다.

    {
       "sku": string,
       "name": string,
       "brand": string,
       "url": string
    }

    LINK

    json object

    {"url": linkUrl}

    팝업(배너, 쿠폰, 공지)에서 클릭 이벤트를 링크로 설정했거나 상품 목록 상단 링크를 클릭할 때 링크 주소와 함께 호출됩니다. 별도로 구현(override)하지 않는 경우 웹에서는 페이지 자체가 이동되며 (현재 라이브 페이지 이탈) 앱(SDK)의 경우 PIP 모드로 진입하고 NAVIGATION이 호출됩니다.

    LINK_NEW_WINDOW

    json object

    {"url": linkUrl}

    팝업(배너, 쿠폰, 공지)에서 클릭 이벤트를 링크(새창 열기)로 설정했을 때 사용자가 링크를 클릭하면 링크 주소와 함께 호출됩니다. 별도로 구현(override)하지 않는 경우 웹에서는 새창에 linkUrl을 띄우며 앱(SDK)의 경우 PIP 모드로 진입하고 NAVIGATION이 호출됩니다.

    CLICK_SHARE_BTN

    json object

    공유 버튼이 클릭되었을 경우 호출됩니다. 아래와 같은 json object가 payload에 포함됩니다.

    {
       "campaignKey": string,
       "shareUrl": string
    }

    NOW_ONAIR_CHECKED

    PluginCampaign

    라이브 방송의 진행 여부 확인 필요 시 호출됩니다.

    ON_CLICK_CAMPAIGN_LIST_ITEM

    PluginCampaign

    모아보기 방송 목록 중 하나를 클릭했을 때

    ON_PLAYER_MODAL_SHOWN

    PluginCampaign

    플레이어 모달 UI 가 화면에 표시 되었을 때

    ON_PLAYER_MODAL_HIDDEN

    PluginCampaign

    플레이어 모달 UI 가 닫히고 화면에서 사라졌을 때

    ON_CLICK_CLOSE_PLAYER_MODAL

    PluginCampaign

    사용자가 플레이어 모달 UI 의 닫기버튼을 클릭 했을 때

    ON_LIVE_MINI_PREVIEW_SHOWN

    없음

    라이브 방송 배너가 표시 될 때

    ON_LIVE_MINI_PREVIEW_HIDDEN

    없음

    라이브 방송 배너가 화면에서 사라질 때

    ON_CLICK_CLOSE_LIVE_MINI_PREVIEW

    없음

    사용자가 라이브 방송 배너의 닫기 버튼을 클릭했을 때.

    ON_CLICK_BUY_BUTTON

    Goods

    상품 목록의 Buy 버튼을 클릭했을 때

    ON_PRODUCT_LIST_SHOWN

    Array

    상품 목록 팝업이 표시될 때