.png){kind=logo}
매개변수 객체 (Payload)
- 인쇄
매개변수 객체 (Payload)
- 인쇄
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
샵라이브에서 제공하는 messageCallback 함수들의 매개변수 객체인 payload에 대한 가이드입니다.
ON_CLICK_CAMPAIGN_LIST_ITEM
모아보기 방송 목록 중 하나를 클릭했을 때
Payload | Type |
|---|---|
campaign |
ON_PLAYER_MODAL_SHOWN
플레이어 모달 UI 가 화면에 표시 되었을 때
Payload | Type |
|---|---|
campaign |
ON_PLAYER_MODAL_HIDDEN
플레이어 모달 UI 가 닫히고 화면에서 사라졌을 때
Payload | Type |
|---|---|
campaign |
ON_CLICK_CLOSE_PLAYER_MODAL
사용자가 플레이어 모달 UI 의 닫기버튼을 클릭 했을 때
Payload | Type |
|---|---|
campaign |
ON_LIVE_MINI_PREVIEW_SHOWN / ON_LIVE_MINI_PREVIEW_HIDDEN
라이브 방송 배너가 표시되거나 라이브 방송 배너가 화면에서 사라질 때
ON_CLICK_CLOSE_LIVE_MINI_PREVIEW
사용자가 라이브 방송 배너의 닫기 버튼을 클릭했을 때
CLICK_PRODUCT
상품 목록 중 상품 하나를 클릭했을 때
Payload | Type |
|---|---|
goods |
LINK_NEW_WINDOW
상품 배너 클릭했을 때 (팝업설정 - 클릭이벤트 '새창으로 열기')
Payload | Type |
|---|---|
url | string |
CLICK_SHARE_BTN
공유 버튼을 클릭했을 때
Payload | Type |
|---|---|
campaignKey | string |
shareUrl | string |
NOW_ONAIR_CHECKED
라이브 방송의 진행 여부 확인할 때
Payload | Type |
|---|---|
campaign |
ON_CLICK_BUY_BUTTON
상품 목록의 Buy 버튼을 클릭했을 때
Payload | Type |
|---|---|
goods | |
shareUrl | string |
CLICK_PRODUCT_CART
상품 목록의 Cart 버튼을 클릭했을 때
Payload | Type |
|---|---|
goods | |
shareUrl | string |
ON_PRODUCT_LIST_SHOWN
상품목록 팝업이 표시될 때
Payload | Type |
|---|---|
productList | Array [Goods] |
LINK
팝업설정 - 클릭이벤트 링크로 설정 후 팝업을 클릭했을 때
별도로 구현(override)하지 않는 경우, 아래와 같이 동작합니다.
웹(WEB): 현재 라이브 페이지 이탈하며 현재 페이지에서 이동
앱(SDK): PIP 모드로 진입하고 NAVIGATION 호출
Payload | Type | Description |
|---|---|---|
campaignKey | string | 방송의 고유번호 |
popupResourceId | string | 팝업의 고유번호 |
type | string | 팝업의 종류 |
url | string | link URL |
LINK_NEW_WINDOW
팝업설정 - 클릭이벤트 '링크(새창으로 열기)'로 설정 후 팝업을 클릭했을 때
별도로 구현(override)하지 않는 경우, 아래와 같이 동작합니다.
웹(WEB): 새 창에 linkUrl을 띄움
앱(SDK): PIP 모드로 진입하고 NAVIGATION 호출
Payload | Type | Description |
|---|---|---|
campaignKey | string | 방송의 고유번호 |
popupResourceId | string | 팝업의 고유번호 |
type | string | 팝업의 종류 |
url | string | link URL |
DOWNLOAD_COUPON
팝업설정 > 클릭 이벤트를 쿠폰 다운로드로 설정 후, 팝업을 클릭했을 때
Payload | Type | Description |
|---|---|---|
campaignKey | string | 방송의 고유번호 |
popupResourceId | string | 팝업의 고유번호 |
type | string | 팝업의 종류 |
coupon | string | 쿠폰 번호 |
CUSTOM_ACTION
팝업설정 > 클릭 이벤트를 사용자 정의로 설정 후, 팝업을 클릭했을 때
Name | Type | Description |
|---|---|---|
campaignKey | string | 방송의 고유번호 |
id | string | 팝업의 고유번호 |
type | string | 팝업의 종류 |
payload | object | 사용자가 정의한 payload 객체 |
Payload types
PluginCampaign
Name | Type | Description |
|---|---|---|
campaignKey | string | 방송의 Unique Key |
campaignStatus | "READY" | "ONAIR" | "CLOSED" | 방송 상태 |
title | string | 방송의 제목 |
scheduledAt | number (Timestamp in milliseconds) | 방송 예정 시각 |
tags | array<string> | 방송에 등록된 태그 목록 |
memo | string? | 방송 description |
backgroundUrl | string? | 방송중 배경 이미지 주소 |
rehearsal | boolean? | 리허설 상태 여부 |
Goods
Name | Type | Example | Description |
|---|---|---|---|
sku | string | "SKU" | 상품코드 |
name | string | "PRODUCT_NAME" | 상품명 |
brand | string | "BRAND" | 브랜드 |
url | string | 상품 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 | 카트에 담기 / 담기 취소 |