messageCallback - Payload 객체

ON_CLICK_CAMPAIGN_LIST_ITEM

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

Payloadtype
campaignPluginCampaign

ON_PLAYER_MODAL_SHOWN

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

PayloadPayload
campaignPluginCampaign

ON_PLAYER_MODAL_HIDDEN

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

PayloadPayload
campaignPluginCampaign

ON_CLICK_CLOSE_PLAYER_MODAL

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

PayloadPayload
campaignPluginCampaign

ON_LIVE_MINI_PREVIEW_SHOWN

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


ON_LIVE_MINI_PREVIEW_HIDDEN

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


ON_CLICK_CLOSE_LIVE_MINI_PREVIEW

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


CLICK_PRODUCT

상품 목록 중 상품 하나를 클릭했을 때

Payloadtype
payloadGoods

LINK_NEW_WINDOW

상품 배너 클릭했을 때

(팝업설정 - 클릭이벤트 '새창으로 열기')

Payloadtype
urlstring

CLICK_SHARE_BTN

공유 버튼을 클릭했을 때

Payloadtype
campaignKeystring
shareUrlstring

ON_CLICK_BUY_BUTTON

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

Payloadtype
payloadGoods

CLICK_PRODUCT_CART

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

Payloadtype
payloadGoods

ON_PRODUCT_LIST_SHOWN

상품목록 팝업이 표시될 때


LINK

팝업설정 - 클릭이벤트 '링크'로 설정 후 팝업을 클릭했을 때

  • 별도로 구현(override)하지 않는 경우, 아래와 같이 동작합니다.
    • 웹(WEB): 현재 라이브 페이지 이탈하며 현재 페이지에서 이동
    • 앱(SDK): PIP 모드로 진입하고 NAVIGATION 호출
PayloadTypeDescription
campaignKeystring방송의 고유번호
popupResourceIdstring팝업의 고유번호
typestring팝업의 종류
urlstringlink URL

LINK_NEW_WINDOW

팝업설정 - 클릭이벤트 '링크(새창으로 열기)'로 설정 후 팝업을 클릭했을 때

  • 별도로 구현(override)하지 않는 경우, 아래와 같이 동작합니다.
    • 웹(WEB): 새 창에 linkUrl을 띄움
    • 앱(SDK): PIP 모드로 진입하고 NAVIGATION 호출
PayloadTypeDescription
campaignKeystring방송의 고유번호
popupResourceIdstring팝업의 고유번호
typestring팝업의종류
urlstringlink URL

DOWNLOAD_COUPON

팝업설정 - 클릭이벤트 '쿠폰 다운로드'로 설정 후, 팝업을 클릭했을 때

PayloadTypeDescription
campaignKeystring방송의 고유번호
popupResourceIdstring팝업의 고유번호
typestring팝업의 종류
couponstring쿠폰 번호

CUSTOM_ACTION

팝업설정 - 클릭이벤트 '사용자 정의'로 설정 후, 팝업을 클릭했을 때

NameTypeDescription
campaignKeystring방송의 고유번호
idstring팝업의 고유번호
typestring팝업의 종류
payloadobject사용자가 정의한 payload 객체



Payload types

PluginCampaign

NameTypeDescription
campaignKeystring방송의 Unique Key
campaignStatus"READY" | "ONAIR" | "CLOSED"방송 상태
titlestring방송의 제목
scheduledAtnumber (Timestamp in milliseconds)판매 가격
memostring?방송 description
backgroundUrlstring?방송중 배경 이미지 주소
rehearsalboolean?리허설 상태 여부

Goods

NameTypeExampleDescription
skustring"SKU"상품코드
namestring"PRODUCT_NAME"상품명
brandstring"BRAND"브랜드
urlstring"https://shoplive.cloud"상품 URL
showingNowbooleantrue / falseNOW 마크 표시 여부
salesStatusstring"ON_SALE" | "SOLDOUT" | "ALMOST_SOLDOUT"판매중 / 매진 / 매진 임박
originalPriceLosslessNumber{"value": "10000"}판매 가격
discountedPriceLosslessNumber{"value": "9000"}할인 가격
discountPercentageLosslessNumber{"value": "10.0"}할인율
currencystring"KRW"통화
goodsIdLosslessNumber{"value": "1"}상품의 고유번호
descriptionstring"Description"상품 설명
campaignIdLosslessNumber{"value": "1"}방송의 고유번호
isCartOnboolean?true / false카트에 담기 / 담기 취소