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

• 필요 변수 : Application ID, API 키

const bluxClient = new BluxClient({
  bluxApplicationId: "BLUX_APPLICATION_ID",
  bluxAPIKey: "BLUX_API_KEY",
});
bluxClient.setLogLevel("warning");

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

signIn

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

bluxClient.signIn({ userId: "USER ID" });

setUserProperties

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

bluxClient.setUserProperties({
  userProperties: {
    phone_number: "01011112222",
    email_address: "[email protected]",
  },
});

setCustomUserProperties

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

bluxClient.setCustomUserProperties({
  customUserProperties: {
    custom_key1: "any_value",
    custom_key2: true,
    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",
  }),
);

상품 구매

: 유저가 제품을 구매했을 때 사용 가능한 이벤트입니다. paidAmount 파라미터의 경우, 캠페인을 통한 성과 집계에 사용되는 값입니다.

bluxClient.sendEvent(
  new AddOrderEvent({
    orderId: "ORDER_ID",
    paidAmount: 1200,
    orderAmount: 2000,
    items: [
      {
        id: "ITEM_ID_1",
        price: 1000,
        quantity: 1,
      },
    ],
  }),
);

// 복수 상품을 구매한 경우
bluxClient.sendEvent(
  new AddOrderEvent({
    orderId: "ORDER_ID",
    paidAmount: 1200,
    orderAmount: 2000,
    items: [
      {
        id: "ITEM_ID_1",
        price: 1000,
        quantity: 1,
      },
      {
        id: "ITEM_ID_2",
        price: 2000,
        quantity: 2,
      },
    ],
  }),
);