@blux.ai/web-sdk v0.0.7

Blux Web sdk 행동데이터 연동 안내 문서

Installation

• Supported Node.js Version >= 10.24.1
• npm/yarn을 이용하여 설치하실 수 있습니다.

// NPM 이용
npm install @blux.ai/web-sdk

// Yarn 이용
yarn add @blux.ai/web-sdk

Initialize

• 필요 변수 : 클라이언트 ID, API 키

BluxClient.setLogLevel("debug");
BluxClient.init({
  bluxClientId: "{blux_client_id}",
  bluxApiKey: "{blux_api_key}",
});

• setLogLevel : 연동 관련하여 디버깅을 하기 위해서 로깅을 활성화할 수 있습니다. 해당 설정은 정적이므로 BluxClient를 초기화하기 전에 호출하실 수 있습니다.
  • 'debug'
  • 'log'
  • 'warning'
  • 'error'
  • 'fatal'

signIn

• 회원 유저에 대해서 부여하고 계시는 유저 ID를 넘겨주시면 됩니다.
• Blux 서비스에서 같은 UserId를 가지는 유저는 같은 유저로 식별됩니다.
• 비회원 유저에서 회원 유저로 식별되는 시점에 아래 함수를 호출해주세요.
• 회원 유저가 앱을 실행하는 시점에도 initialize 메소드 호출 이후에 실행되어야 합니다.

BluxClient.signIn("USER ID");

setUserProperties

• 유저에게 지정된 속성들을 부여합니다. 전화번호, 이메일 번호를 등록할 수 있습니다.

BluxClient.setUserProperties({
  phone_number: "+821011112222",
  email_address: "test@example.com",
});

setCustomUserProperties

• setUserProperties에서 설정할 수 있는 지정된 속성 외 임의의 속성을 부여할 수 있습니다.

BluxClient.setCustomUserProperties({
  custom_key1: "any_value",
  custom_key2: true,
  custom_key3: null,
  custom_key4: 3,
});

signOut

• 유저가 서비스에서 로그아웃 한 경우 호출해주시면 됩니다.
• 유저들을 더 잘 식별하기위해 사용됩니다.

BluxClient.signOut();

sendEvent

상품 상세 페이지 진입

: 유저가 제품 상세보기 페이지에 들어가거나, 영상을 시청하는 등 클릭을 통해 어떠한 아이템에 대해 관심을 보이는 행동을 보일 때 사용 가능한 이벤트입니다.

BluxClient.sendEvent(
  new AddProductDetailViewEvent({
    itemId: "ITEM_ID",
  }),
);

상품 좋아요

: 유저가 제품이나 영상 등에 좋아요를 누르거나, 찜을 해두는 등 적극적인 관심을 보이는 행동을 할 때 사용 가능한 이벤트입니다.

BluxClient.sendEvent(
  new AddLikeEvent({
    itemId: "ITEM_ID",
  }),
);

상품 장바구니 담기

: 이커머스에서 유저가 제품을 장바구니에 담는 행동을 할 때 사용 가능한 이벤트입니다.

BluxClient.sendEvent(
  new AddCartaddEvent({
    itemId: "ITEM_ID",
  }),
);

상품 구매

: 유저가 제품을 구매했을 때 사용 가능한 이벤트입니다. 추가 인풋으로 price가 요구되며, 제품의 구매 당시 가격을 기록하면 됩니다.

• 동일 상품 복수 구매
  • price 파라미터의 경우, 해당 상품 판매를 통한 총 매출을 계산할 때 활용됩니다. 추천에 의한 매출 기여액 지표를 보여드릴 때 사용되는 값으로 만약 5,000원짜리 상품을 5개 구매하였다면, 25,000 을 입력하시면 됩니다.
• 복수 상품 구매
  • AddPurchaseEvent 객체를 각 상품 구매건에 맞춰서 생성한 후 list 형태로 넘겨주시면 됩니다.

BluxClient.sendEvent(
  new AddPurchaseEvent({
    itemId: "ITEM_ID",
    price: 1000,
  }),
);

// 복수 상품을 구매한 경우
BluxClient.sendEvent([
  new AddPurchaseEvent({
    itemId: "ITEM_ID_1",
    price: 1000,
  }),
  new AddPurchaseEvent({
    itemId: "ITEM_ID_2",
    price: 2000,
  }),
]);