SDK ์ฐ๋
JavaScript SDK๋ IE11+ ๋ฐ ๋ชจ๋ ์ฃผ์ ๋ธ๋ผ์ฐ์ ๋ฅผ ์ง์ํฉ๋๋ค.
JavaScript SDK๋ฅผ ์ฌ์ฉํ๊ธฐ ์ํด์๋
Promise,MapAPI๊ฐ ํ์๋ก ์ง์๋์ด์ผ ํฉ๋๋ค.
ํด๋ฆฌํ์ด ํ์ํ๋ค๋ฉดcore-js๋ฅผ ์ด์ฉํ๋ ๊ฒ์ ์ถ์ฒํฉ๋๋ค.
1. ์์กด์ฑ ์ถ๊ฐ
npm install --save @hackler/javascript-sdkyarn add @hackler/javascript-sdk<!-- HTML์ ๊ฒฝ์ฐ ์์กด์ฑ ์ถ๊ฐ ์์
์ด ํ์ํ์ง ์์ต๋๋ค -->2. SDK ์ด๊ธฐํ
SDK๋ฅผ ์ฌ์ฉํ๊ธฐ ์ํด์ ๋ฐ๋์ HackleClient ๋ฅผ ์ด๊ธฐํ ํด์ผ ํฉ๋๋ค. ์ธ์คํด์ค๋ฅผ ์ด๊ธฐํ ํ๊ธฐ ์ํด SDK ํค๊ฐ ํ์ํฉ๋๋ค.
HackleClient๋ SDK์ ๊ธฐ๋ฅ์ ์ฌ์ฉํ๊ธฐ ์ํ ๋ฉ์๋๋ค์ ์ ๊ณตํ๋ ํด๋์ค์ ๋๋ค.- SDK ํค๋ ํตํด ์๋น์ค์ ๋์๋ณด๋ ์์ ์์นํ SDK ์ฐ๋ ์ ๋ณด์์ ํ์ธํ์ค ์ ์์ต๋๋ค.
import * as Hackle from "@hackler/javascript-sdk";
// YOUR_BROWSER_SDK_KEY๋ก ์ด๊ธฐํ
const hackleClient = Hackle.createInstance("YOUR_BROWSER_SDK_KEY");<!-- ๊ธฐ์กด ์ฝ๋ head ์์ ์ถ๊ฐ -->
<script src="https://cdn2.hackle.io/npm/@hackler/[email protected]/lib/index.browser.umd.min.js"></script>
<script>
// YOUR_BROWSER_SDK_KEY๋ก ์ด๊ธฐํ
window.hackleClient = Hackle.createInstance("YOUR_BROWSER_SDK_KEY");
</script>์ด๊ธฐํ ์ค์ ์ ๋ณด
์ค์ ์ ๋ณด๋ฅผ ํฌํจํ์ฌ SDK๋ฅผ ์ด๊ธฐํ ํ ์ ์์ต๋๋ค.
๋๋ฒ๊ทธ ๋ชจ๋
debug ์ต์
์ true ๋ก ์ค์ ํ์ฌ ํ์ฑํ ํฉ๋๋ค. ๋๋ฒ๊ทธ ๋ชจ๋๋ฅผ ํ์ฑํ ์ํค๋ฉด ๋ชจ๋ ๊ธฐ๋ฅ์ ๋ํ ๋ก๊ทธ๊ฐ ์ฝ์์ ์ถ๋ ฅ๋ฉ๋๋ค.
const config = {
debug: true
};
// ์ค์ ์ ๋ณด๋ฅผ ํฌํจํ์ฌ ์ด๊ธฐํ
const hackleClient = Hackle.createInstance("YOUR_BROWSER_SDK_KEY", config);๋ชจ๋ ์ค์ ์ต์
ํค | ๊ธฐ๋ฅ | ๊ธฐ๋ณธ๊ฐ | ์ง์ ๋ฒ์ |
|---|---|---|---|
debug | ๋ชจ๋ ๊ธฐ๋ฅ์ ๋ํ ๋ก๊ทธ๋ฅผ ์ฝ์์ ์ถ๋ ฅํฉ๋๋ค. | false | 1.0.0+ |
pollingIntervalMillis | ๋์๋ณด๋์์ ์ค์ ํ ์ ๋ณด๋ฅผ ์ฃผ๊ธฐ์ ์ผ๋ก ์ ๋ฐ์ดํธ ํ ์ ์์ต๋๋ค. ์ต์๊ฐ : 60000 (60์ด) | -1 (์ฃผ๊ธฐ์ ์ผ๋ก ์ ๋ฐ์ดํธํ์ง ์์) | 11.1.0+ |
exposureEventDedupIntervalMillis | ๋์ผํ ์ฌ์ฉ์๊ฐ ์ฐ์์ผ๋ก ๋ฐ์์ํจ ๋์ผํ A/B ํ ์คํธ, ๊ธฐ๋ฅํ๋๊ทธ ๋ถ๋ฐฐ๊ฒฐ๊ณผ์ ๋ํ ๋ ธ์ถ ์ด๋ฒคํธ๋ฅผ ์ ๊ฑฐํฉ๋๋ค. ์ต์๊ฐ: 1000 (1์ด) ์ต๋๊ฐ: 3600000 (1์๊ฐ) | 36000 (1๋ถ / 11.23.0 ์ด์) -1 (์ค๋ณต์ ๊ฑฐ ํ์ง ์์ / 11.23.0 ๋ฏธ๋ง) | 11.1.0+ |
sessionTimeoutMillis | ์ธ์ ๋ง๋ฃ ์๊ฐ์ ์ค์ ํฉ๋๋ค. | 1800000 (30๋ถ) | 11.8.0+ |
devTool | ์ฌ์ฉ์ ํ์์ ์ฌ์ฉํ ์ ์๋๋ก ํฉ๋๋ค. ์์ธํ ์ค๋ช ์ ๋ฅผ ์ฐธ๊ณ ํด์ฃผ์ธ์. | undefined | 11.13.0+ |
autoOpenDevTool | ์ฌ์ฉ์ ํ์ ๋ฒํผ์ด ์๋์ผ๋ก ๋ํ๋๋๋ก ํ๋ ์ต์ ์ ๋๋ค. | false | 11.13.0+ |
sameSiteCookie | ํตํด ์ฟ ํค์ sameSite ํ๋๊ทธ๋ฅผ ์ค์ ํ๊ณ ์ฟ ํค ๊ฐ์ธ์ ๋ณด ๋ณดํธ ์ ์ฑ ์ ๊ฒฐ์ ํฉ๋๋ค. | Lax | 11.20.0+ |
secureCookie | true ๋ก ์ค์ ํ์๋ฉด ํตํด ์ฟ ํค์ Secure ํ๋๊ทธ๋ฅผ ์ค์ ํฉ๋๋ค. | false | 11.20.0+ |
์ด๊ธฐํ ์๋ฃ
์ด๊ธฐํ๊ฐ ์์๋๋ฉด ํตํด ์๋ฒ๋ก๋ถํฐ ํ์ํ ์ ๋ณด๋ค์ ๊ฐ์ ธ์์ SDK์ ์ ์ฅํฉ๋๋ค. ์ด ์์
์ ๋น๋๊ธฐ๋ก ์คํ๋๋ฉฐ onReady๋ฅผ ํตํด SDK ์ฌ์ฉ ์ค๋น๊ฐ ์๋ฃ๋ ๊ฒ์ ์ ์ ์์ต๋๋ค. ์ฃผ๋ก ์ด๊ธฐํ๊ฐ ์๋ฃ๋ ์ดํ ์คํ๋์ด์ผ ํ๋ ๊ธฐ๋ฅ(A/B ํ
์คํธ, ๊ธฐ๋ฅํ๋๊ทธ)์ ์ํด ์ฌ์ฉ๋ฉ๋๋ค.
// deprecated
hackleClient.onReady(() => {
// SDK ready to use
});async function initHackle(){
await hackleClient.onInitialized();
// SDK ready to use
}๋์๋ณด๋ ์ค์ ์ ๋ณด ๊ฐฑ์
๋์๋ณด๋ ์ค์ ์ ๋ณด๋ฅผ ๋ช ์์ ์ผ๋ก ๊ฐฑ์ ํ ์ ์์ต๋๋ค.
hackleClient.fetch();ํด๋น ํจ์๋ 60์ด์ ํ๋ฒ ์ ํ์ ์ผ๋ก ํธ์ถํ ์ ์์ต๋๋ค.
3. ์ฌ์ฉ์ ์ค์
์ฌ์ฉ์ ์ ๋ณด๋ฅผ SDK์ ์ค์ ํ ์ ์์ต๋๋ค.
์ฌ์ฉ์ ID ์ค์
์ฌ์ฉ์๊ฐ ๋ก๊ทธ์ธํ ๊ฒฝ์ฐ, setUserId ๋ฅผ ํธ์ถํด์ ๋ก๊ทธ์ธํ ์ฌ์ฉ์์ ID๋ฅผ ์ค์ ํ ์ ์์ต๋๋ค.
- ๋ก๊ทธ์ธ ์ ํ๋ฒ๋ง ์ค์ ํ๋ฉด ๋ฉ๋๋ค.
- ์ด๋ฏธ ๋ก๊ทธ์ธ์ด ๋์ด์๋ ์ฌ์ฉ์์ ๊ฒฝ์ฐ์๋ ๋ก๊ทธ์ธํ ์ ๋ณด๋ฅผ ๊ฐ์ง๊ณ ์ค๋ ์์ ์ ํธ์ถํ๋ฉด ๋ฉ๋๋ค.
const userId = ... // ๋ก๊ทธ์ธํ ์ฌ์ฉ์์ ID (ํ์๋ฒํธ, ๋ฉค๋ฒ ID ๋ฑ)
hackleClient.setUserId(userId);์ฌ์ฉ์ ์์ฑ ์ค์
์ด๋ฉ์ผ์ฃผ์, ์์น, ๋์ด, ํ์๋ฑ๊ธ๊ณผ ๊ฐ์ ์ ๋ณด๋ฅผ ์ฌ์ฉ์ ์์ฑ์ผ๋ก ์ฌ์ฉํ ์ ์์ต๋๋ค.
import { PropertyOperationsBuilder } from "@hackler/javascript-sdk"
const operations = new PropertyOperationsBuilder()
.set("age", 42)
.set("grade", "GOLD")
.build();
hackleClient.updateUserProperties(operations);<script>
const operations = new Hackle.PropertyOperationsBuilder()
.set("age", 42)
.set("grade", "GOLD")
.build();
hackleClient.updateUserProperties(operations);
</script>์ฌ์ฉ์ ๋ก๊ทธ์์ ์ ์ฌ์ค์
์ฌ์ฉ์๊ฐ ๋ก๊ทธ์์ ํ ๊ฒฝ์ฐ resetUser๋ฅผ ํธ์ถํด์ ๊ธฐ์กด์ ์ค์ ํ ์ฌ์ฉ์ ์ ๋ณด๋ฅผ ๋ฆฌ์
ํ ์ ์์ต๋๋ค. ์๋ ์ ๋ณด๊ฐ ๋ฆฌ์
๋ฉ๋๋ค.
- ์ฌ์ฉ์ ID
- ์ฌ์ฉ์ ์์ฑ
hackleClient.resetUser();4. ์ด๋ฒคํธ ์ ์ก
์ฌ์ฉ์๊ฐ ์ํํ๋ ํ๋์ ์ด๋ฒคํธ๋ก ์ ์กํ ์ ์์ต๋๋ค. ์ ์ก๋ ์ด๋ฒคํธ๋ A/B ํ ์คํธ ๋ถ์, ๋ฐ์ดํฐ ๋ถ์ ๋ฑ์ ์ฌ์ฉ๋ฉ๋๋ค. ์๋ฅผ๋ค์ด, ์ฌ์ฉ์๊ฐ ๊ตฌ๋งค๋ผ๋ ํ๋์ ํ๋ค๋ฉด ์๋์ ๊ฐ์ด ์ด๋ฒคํธ๋ฅผ ์ ์กํ ์ ์์ต๋๋ค.
// ์ด๋ฒคํธ ์์ง
hackleClient.track('purchase')
// ์ด๋ฒคํธ๋ฅผ ์์ฑ๊ณผ ํจ๊ป ์์ง
const event = {
key: "purchase",
properties: {
amount: 4200,
pay_method: "CARD",
is_discount: false,
product_ids: [42, 43]
}
}
hackleClient.track(event);์ ์กํ ์ด๋ฒคํธ ํ์ธํ๊ธฐ
๋์๋ณด๋ ์ด๋ฒคํธ๊ด๋ฆฌ ๋ฉ๋ด์์ ์ ์กํ ์ด๋ฒคํธ๋ฅผ ํ์ธํ ์ ์์ต๋๋ค. ์ด๋ฒคํธ ์ ์ก ํ ๋์๋ณด๋์ ํ์๋๊ธฐ๊น์ง ์ผ๋ฐ์ ์ผ๋ก ~60์ด๊ฐ ๊ฑธ๋ฆฝ๋๋ค.
5. A/B ํ
์คํธ
์ฌ์ฉ์๋ฅผ ํ
์คํธ ๊ทธ๋ฃน์ผ๋ก ๋ถ๋ฐฐํ๊ณ ๋ถ๋ฐฐ๋ ๊ฒฐ๊ณผ์ ํด๋นํ๋ ๋ก์ง์ ์์ฑํ์ฌ A/B ํ
์คํธ๋ฅผ ๊ตฌํํฉ๋๋ค. variation์ ์คํํค๋ฅผ ์ ๋ฌํ์ฌ ํธ์ถํ๋ฉด ๋ถ๋ฐฐ๊ฒฐ๊ณผ๋ฅผ ๋ฆฌํด๋ฐ์ ์ ์์ต๋๋ค.
์คํํค: ๊ฐ A/B ํ ์คํธ๋ณ๋ก ๊ฐ๊ฒ ๋๋ ๊ณ ์ ๋ฒํธ์ ๋๋ค. A/B ํ ์คํธ๋ฅผ ์์ฑํ๋ฉด ์๋์ผ๋ก ๋ฐ๊ธ๋ฉ๋๋ค.
// SDK๊ฐ ์ค๋น๋ ์ดํ์ ์คํ์ด ๋์ด์ผํฉ๋๋ค. onReady๋ก ๊ฐ์ธ๋ ๊ฒ์ ์์ง ๋ง์ธ์.
hackleClient.onReady(function() {
// ์คํ ํค๊ฐ 42์ธ A/B ํ
์คํธ์์ ์ฌ์ฉ์์๊ฒ ๋
ธ์ถํ ํ
์คํธ ๊ทธ๋ฃน์ ๊ฒฐ์ ํฉ๋๋ค.
// ๊ฒฐ์ ํ์ง ๋ชปํ๋ ์ํฉ์ธ ๊ฒฝ์ฐ ํ
์คํธ ๊ทธ๋ฃน A๋ฅผ ๋ฐํํฉ๋๋ค.
const variation = hackleClient.variation(42);
// ํ ๋น๋ฐ์ ๊ทธ๋ฃน์ ๋ํ ๋ก์ง
if (variation === "A") {
// ๊ทธ๋ฃน A ๋ก์ง
} else if (variation === "B") {
// ๊ทธ๋ฃน B ๋ก์ง
}
});๋ถ๋ฐฐ ๊ฒฐ๊ณผ ํ์ธํ๊ธฐ
๋์๋ณด๋ A/B ํ ์คํธ์ ์์ธํ์ด์ง์ ์ค์๊ฐ ๋ ธ์ถ ํํฉ ํญ์์ ๋ถ๋ฐฐ๋ ๊ฒฐ๊ณผ๋ฅผ ํ์ธํ ์ ์์ต๋๋ค. ๋ถ๋ฐฐ ํ ๋์๋ณด๋์ ํ์๋๊ธฐ๊น์ง ์ผ๋ฐ์ ์ผ๋ก ~60์ด๊ฐ ๊ฑธ๋ฆฝ๋๋ค.
6. ๊ธฐ๋ฅ ํ๋๊ทธ
๊ธฐ๋ฅ ํ๋๊ทธ๋ ์ผ์ง(on) ์ํ์ ๊บผ์ง(off) ์ํ๊ฐ ์์ต๋๋ค. ์ํ์ ๋ฐ๋ผ ๋ค๋ฅธ ๋ก์ง์ ์์ฑํ์ฌ ๊ธฐ๋ฅ ํ๋๊ทธ๋ฅผ ๊ตฌํํฉ๋๋ค. isFeatureOn์ ๊ธฐ๋ฅํ๋๊ทธํค๋ฅผ ์ ๋ฌํ์ฌ ํธ์ถํ๋ฉด on/off ์ฌ๋ถ๋ฅผ ๋ฆฌํด๋ฐ์ ์ ์์ต๋๋ค.
๊ธฐ๋ฅํ๋๊ทธํค: ๊ฐ ๊ธฐ๋ฅํ๋๊ทธ๋ณ๋ก ๊ฐ๊ฒ ๋๋ ๊ณ ์ ๋ฒํธ์ ๋๋ค. ๊ธฐ๋ฅํ๋๊ทธ๋ฅผ ์์ฑํ๋ฉด ์๋์ผ๋ก ๋ฐ๊ธ๋ฉ๋๋ค.
// SDK๊ฐ ์ค๋น๋ ์ดํ์ ์คํ์ด ๋์ด์ผํฉ๋๋ค. onReady๋ก ๊ฐ์ธ๋ ๊ฒ์ ์์ง ๋ง์ธ์.
hackleClient.onReady(function() {
// ๊ธฐ๋ฅ ํค๊ฐ 42์ธ ๊ธฐ๋ฅ ํ๋๊ทธ์์ ์ฌ์ฉ์์ ์ํ๋ฅผ ๊ฒฐ์ ํฉ๋๋ค.
// ๊ฒฐ์ ํ์ง ๋ชปํ๋ ์ํฉ์ธ ๊ฒฝ์ฐ false(๊บผ์ง ์ํ)๋ฅผ ๋ฐํํฉ๋๋ค.
const isOn = hackleClient.isFeatureOn(42);
// ์ํ ๋ณ ๋ก์ง
if (isOn) {
// ON ๊ธฐ๋ฅ
} else {
// OFF ๊ธฐ๋ฅ
}
});Updated 8 days ago
