Payload Definition
The payload definitions related to the use of the Saucelive Collection Library are as follows.
Library payload
setInit
| parameter | type | Require | Description | default |
|---|---|---|---|---|
| partnerId | String | true | The partnerId you received | |
| id | String | false | The target DOM ID (used for full rendering) | 'sauce_collect' |
| broadcast | boolean | false | Set whether to display the Live Replay area | true |
| schedule | boolean | false | Set whether to display the Live Preview area | true |
| scheduleType | String | false | Set the Live Preview format to one of: "image", "feed", or "list" "image" | "feed" | "list" | 'image' |
| curation | boolean | false | Set whether to display the Curation Category area | true |
| curationDetail | boolean | false | Set whether to display the Curation Detail area | true |
See the example in Library Basic Usage Page for more details.
setMemberObject
| parameter | type | Require | Description |
|---|---|---|---|
| nickName | String | true | Nickname displayed in the chat window. |
| memberId | String | true | Unique customer ID issued by your system. |
| gender | String | false | Gender data. |
| memberType | "0" | "1" | false | 1 for member, 0 for guest. |
| age | String | false | Age data. |
See the example in Library Authentication Feature for more details.
setMemberToken
| parameter | type | Description |
|---|---|---|
| X | String | JWT Token |
See the example in Library Authentication Feature for more details.
load ( 전체 랜더링 )
| Parameter | type | Require | Description | default |
|---|---|---|---|---|
| X | String | false | Specified DOM ID | 'sauce_collect' |
See the example in Library Basic Usage Page for more details.
loadCuration
| Parameter | Type | Require | Description |
|---|---|---|---|
| curationId | String | true | Curation ID retrieved from the Admin. |
| elementId | String | true | Specified DOM ID |
See the example in Library Module Usage Page for more details.
loadBroadcast
| Parameter | Type | Require | Description | default |
|---|---|---|---|---|
| displayType | String | true | Display types. 'horizontal' | 'vertical' | 'horizontal' |
| elementId | String | true | Specified DOM ID | X |
| title | String | false | Top title for the Live Replay section. | X |
See the example in Library Module Usage Page for more details.
loadSchedule
| Parameter | Type | Require | Description | default |
|---|---|---|---|---|
| scheduleType | String | true | Live Preview format. ''image' | 'feed' | 'list' | 'image' |
| elementId | String | true | Specified DOM ID | X |
See the example in Library Module Usage Page for more details.
loadCalendar
| Parameter | Type | Require | Description | default |
|---|---|---|---|---|
| elementId | String | true | Specified DOM ID | X |
See the example in Library Module Usage Page for more details.
loadTopBanner
| Parameter | Type | Require | Description | default |
|---|---|---|---|---|
| elementId | String | true | Specified DOM ID | X |
See the example in Library Module Usage Page for more details.
Library-Specific Bridge Payload
When using the library, please refer to the Library Bridge Usage Guide or how to configure the bridge settings.
flexCollectEnter
This bridge is triggered when the page is loaded.
| Parameter | Type | Require | Description |
|---|---|---|---|
| 없음 | - | - | Automatically triggered on page load. |
flexCollectMoveProduct
This bridge is triggered when a product is clicked.
| Parameter | Type | Description |
|---|---|---|
| productId | String | Product ID |
| productUrl | String | Product registration URL |
| broadcastUrl | String | Saucelive broadcast URL |
flexCollectMoveBroadcast
This bridge is triggered when a broadcast card is clicked.
| Parameter | Type | Description |
|---|---|---|
| broadcastUrl | String | Saucelive broadcast URL |
flexCollectMoveTopBanner
This bridge is triggered when the top banner is clicked.
| Parameter | Type | Description |
|---|---|---|
| bannerLinkUrl | String | TOP banner link URL |
flexCollectMoveContentBanner
This bridge is triggered when a content banner is clicked.
| Parameter | Type | Description |
|---|---|---|
| bannerLinkUrl | String | Contents banner link URL |
This bridge is triggered when a user subscribes to a notification.
| Parameter | Type | Description |
|---|---|---|
| memberId | String | member ID |
| programmingStartDt | String | Broadcast start time (e.g., "2022-02-01T06:34:00.000Z") |
| programmingEndDt | String | Broadcast end time (e.g., "2022-02-02T06:34:00.000Z") |
| broadcastId | String | Broadcast ID |
| accessToken | String | JWT Token |
This bridge is triggered when a user cancels an alert.
| Parameter | Type | Description |
|---|---|---|
| memberId | String | member ID |
| programmingStartDt | String | Broadcast start time (e.g., "2022-02-01T06:34:00.000Z") |
| programmingEndDt | String | Broadcast end time (e.g., "2022-02-02T06:34:00.000Z") |
| broadcastId | String | Broadcast ID |
| accessToken | String | JWT Token |
flexCollectBroadcastCustomButton
This bridge is triggered when a custom broadcast button is clicked.
| Parameter | Type | Description |
|---|---|---|
| broadcastId | String | Broadcast ID |
| customButtonUrl | String | URL linked to the button. |
Updated 13 days ago