Boot Option

이 문서에서는 boot 시 인자로 전달하는 부트 옵션에 대해 설명합니다.

예시 코드는 시작하기를 참고합니다.

필수 옵션

pluginKey

타입	설명
`string`	채널의 플러그인 키.

선택 옵션

memberId

타입	설명
`string`	멤버 유저의 id.

customLauncherSelector

타입	설명
`string`	커스텀 채널 버튼을 선택할 수 있는 CSS 선택자. 기본 채팅 버튼을 커스터마이징할 때 사용합니다.

타입

설명

string

커스텀 채널 버튼을 선택할 수 있는 CSS 선택자.

기본 채팅 버튼을 커스터마이징할 때 사용합니다.

hideChannelButtonOnBoot

타입	설명
`boolean`	기본 채널 버튼을 숨길지 여부를 설정합니다. 기본값은 `false`입니다.

타입

설명

boolean

기본 채널 버튼을 숨길지 여부를 설정합니다.

기본값은 `false`입니다.

zIndex

타입	설명
`number`	SDK가 생성하는 엘리먼트의 z-index를 설정합니다. 채널 버튼, 메신저, 마케팅 팝업에 적용됩니다. 기본값은 `10000000`입니다.

타입

설명

number

SDK가 생성하는 엘리먼트의 z-index를 설정합니다. 채널 버튼, 메신저, 마케팅 팝업에 적용됩니다.

기본값은 10000000입니다.

language

타입	설명
`string` (`'en'` \| `'ko'` \| `'ja'`)	언어의 기본값을 설정합니다. 설정된 언어에 따라 텍스트를 다르게 표시합니다. 유저가 새로 생성될 경우, 해당 유저의 언어는 `language`와 동일한 값으로 설정됩니다. 이미 생성된 유저의 언어는 변경하지 않습니다.

타입

설명

string

('en' | 'ko' | 'ja')

언어의 기본값을 설정합니다.

설정된 언어에 따라 텍스트를 다르게 표시합니다.

유저가 새로 생성될 경우, 해당 유저의 언어는 language와 동일한 값으로 설정됩니다. 이미 생성된 유저의 언어는 변경하지 않습니다.

trackDefaultEvent

타입	설명
`boolean`	기본 (PageView) 이벤트 트래킹 여부를 설정합니다. 기본값은 `true`입니다.

타입

설명

boolean

기본 (PageView) 이벤트 트래킹 여부를 설정합니다.

기본값은 true입니다.

trackUtmSource

타입	설명
`boolean`	UTM source와 referrer를 트래킹할지 여부를 설정합니다. 기본값은 `true`입니다.

타입

설명

boolean

UTM source와 referrer를 트래킹할지 여부를 설정합니다.

기본값은 true입니다.

profile

타입	설명
`object`	유저의 프로필을 설정합니다.

unsubscribe

unsubscribe는 2023년까지만 지원되며, 그 이후로는 지원 중단됩니다.

unsubscribeEmail과 unsubscribeTexting을 대신 사용할 것을 권장합니다.

타입	설명
`boolean`	유저의 마케팅 수신을 거부할지 여부를 설정합니다. 기본값은 `false`입니다.

타입

설명

boolean

유저의 마케팅 수신을 거부할지 여부를 설정합니다.

기본값은 false입니다.

unsubscribeEmail

타입	설명
`boolean`	유저의 마케팅 이메일 수신 거부 여부를 설정합니다. 기본값은 `false`입니다.

타입

설명

boolean

유저의 마케팅 이메일 수신 거부 여부를 설정합니다.

기본값은 false입니다.

unsubscribeTexting

타입	설명
`boolean`	유저의 마케팅 SMS 수신 거부 여부를 설정합니다. 기본값은 `false`입니다.

타입

설명

boolean

유저의 마케팅 SMS 수신 거부 여부를 설정합니다.

기본값은 false입니다.

memberHash

타입	설명
`string`	memberId를 HMAC-SHA256으로 해싱한 값을 전달합니다. 멤버 해시에 대한 더 자세한 내용은 멤버 해시 이해하기를 참고합니다.

타입

설명

string

memberId를 HMAC-SHA256으로 해싱한 값을 전달합니다.

멤버 해시에 대한 더 자세한 내용은 멤버 해시 이해하기를 참고합니다.

hidePopup

타입	설명
`boolean`	마케팅 팝업와 메시지 알림 팝업을 숨길지 여부를 설정합니다. 기본값은 `false`입니다.

타입

설명

boolean

마케팅 팝업와 메시지 알림 팝업을 숨길지 여부를 설정합니다.

기본값은 false입니다.

appearance

타입	설명
`string` (`'light'` \| `'dark'` \| `'system'` \| `null`)	초기 테마를 설정합니다. 기본값은 `null`입니다.

타입

설명

string

('light' | 'dark' | 'system' | null)

초기 테마를 설정합니다.

기본값은 null입니다.

'light': 라이트 테마를 사용합니다.
'dark': 다크 테마를 사용합니다.
'system': 시스템 테마를 따릅니다.
null: 데스크의 테마 설정을 따릅니다.