payload 정의
소스라이브 모아보기 라이브리러 사용과 관련된 payload 정의는 아래와 같습니다.
라이브러리 payload
setInit
매개변수 | type | Require | Description | default |
---|---|---|---|---|
partnerId | String | true | 담당 AM을 통해 전달 받으신 partnerId | |
id | String | false | 지정 DOM ID (전체 로드시 사용) | 'sauce_collect' |
broadcast | boolean | false | 라이브 다시보기 영역의 노출여부를 설정할 수 있습니다. | true |
schedule | boolean | false | 라이브 미리보기 영역의 노출 여부를 설정할 수 있습니다. | true |
scheduleType | String | false | 라이브 미리보기 형식을 "이미지형" "피드형" "리스트형"으로 설정 할 수 있습니다. "image" | "feed" | "list" | 'image' |
curation | boolean | false | 큐레이션 카테고리 영역의 노출여부 | true |
curationDetail | boolean | false | 큐레이션 영역의 노출 여부를 설정 | true |
실제 사용 예시는 라이브러리 기본 사용법 페이지 를 참고해주세요
setMemberObject
매개변수 | type | Require | Description |
---|---|---|---|
nickName | String | true | 채팅창에 표기되는 닉네임입니다. |
memberId | String | true | 고객사 고유의 고객ID 입니다. |
gender | String | false | 성별 데이 |
memberType | "0" | "1" | false | 1은 회원 0은 비회원으로 인식됩니다. |
age | String | false | 나이 데이터 |
실제 사용 예시는 라이브러리 인증 기능 을 참고해주세요.
setMemberToken
매개변수 | type | Require | Description |
---|---|---|---|
X | String | true | JWT 토큰 |
실제 사용 예시는 라이브러리 인증 기능 을 참고해주세요.
load ( 전체 랜더링 )
매개변수 | type | Require | Description | default |
---|---|---|---|---|
X | String | false | 지정 DOM ID | 'sauce_collect' |
실제 사용 예시는 라이브러리 기본 사용법 페이지 를 참고해주세요
loadCuration
매개변수 | type | Require | Description |
---|---|---|---|
curationId | String | true | 어드민에서 확인한 큐레이션 ID |
elementId | String | true | 지정 DOM ID |
실제 사용 예시는 라이브러리 모듈 사용법 페이지 를 참고해주세요
loadBroadcast
매개변수 | type | Require | Description | default |
---|---|---|---|---|
displayType | String | true | 가로세로 표시유형 'horizontal' | 'vertical' | 'horizontal' |
elementId | String | true | 지정 DOM ID | X |
title | String | false | 라이브 다시보기 상단 타이틀 | X |
실제 사용 예시는 라이브러리 모듈 사용법 페이지 를 참고해주세요
loadSchedule
매개변수 | type | Require | Description | default |
---|---|---|---|---|
scheduleType | String | true | 라이브 미리보기 형식 ''image' | 'feed' | 'list' | 'image' |
elementId | String | true | 지정 DOM ID | X |
실제 사용 예시는 라이브러리 모듈 사용법 페이지 를 참고해주세요
loadCalendar
매개변수 | type | Require | Description | default |
---|---|---|---|---|
elementId | String | true | 지정 DOM ID | X |
실제 사용 예시는 라이브러리 모듈 사용법 페이지 를 참고해주세요
loadTopBanner
매개변수 | type | Require | Description | default |
---|---|---|---|---|
elementId | String | true | 지정 DOM ID | X |
실제 사용 예시는 라이브러리 모듈 사용법 페이지 를 참고해주세요
라이브러리 개별 브릿지 payload
라이브러리 사용시의 브릿지 세팅 방법은 라이브러리 브릿지 사용법 을 확인해주세요
flexCollectEnter
페이지 진입시 호출되는 브릿지입니다.
매개변수 | type | Require | Description |
---|---|---|---|
없음 | - | - | 페이지 진입 시 자동 호출 |
flexCollectMoveProduct
상품 클릭시 호출되는 브릿지입니다.
매개변수 | type | Description |
---|---|---|
productId | String | 상품 ID |
productUrl | String | 상품 등록 URL |
broadcastUrl | String | 소스라이브 방송 URL |
flexCollectMoveBroadcast
방송 카드 클릭시 호출되는 브릿지입니다.
매개변수 | type | Description |
---|---|---|
broadcastUrl | String | 소스라이브 방송 URL |
flexCollectMoveTopBanner
상단 배너 클릭시 호출되는 브릿지입니다.
매개변수 | type | Description |
---|---|---|
bannerLinkUrl | String | TOP 배너 링크 URL |
flexCollectMoveContentBanner
콘텐츠 배너 클릭시 호출되는 브릿지입니다.
매개변수 | type | Description |
---|---|---|
bannerLinkUrl | String | 콘텐츠 배너 링크 URL |
알람신청시 호출되는 브릿지입니다.
매개변수 | type | Description |
---|---|---|
memberId | String | 고객 ID |
programmingStartDt | String | 방송 시작 시간 (예: "2022-02-01T06:34:00.000Z") |
programmingEndDt | String | 방송 종료 시간 (예: "2022-02-02T06:34:00.000Z") |
broadcastId | String | 방송 ID |
accessToken | String | JWT 토큰 |
알람취소시 호출되는 브릿지입니다.
매개변수 | type | Description |
---|---|---|
memberId | String | 고객 ID |
programmingStartDt | String | 방송 시작 시간 (예: "2022-02-01T06:34:00.000Z") |
programmingEndDt | String | 방송 종료 시간 (예: "2022-02-02T06:34:00.000Z") |
broadcastId | String | 방송 ID |
accessToken | String | JWT 토큰 |
flexCollectBroadcastCustomButton
방송 커스텀 버튼 클릭시 호출되는 브릿지입니다.
매개변수 | type | Description |
---|---|---|
broadcastId | String | 방송 ID |
customButtonUrl | String | 버튼에 연결된 URL |
Updated 2 days ago