이벤트

이 문서는 Adbrix SDK를 사용하여 사용자의 동작을 분석하기 위해 수행해야 할 작업에 대해 설명합니다. 이를 사용하기 위해서는 SDK 연동이 선행되어야 합니다.

유의사항

커스텀 이벤트 이름 설정 시 유의 사항

• 문자 타입(String) 이어야 하며, 최소 2자 이상 최대 32자까지 입력할 수 있습니다.

• 영문 소문자와 숫자, - 그리고 _만 사용 가능합니다.

이벤트 속성 설정 시 유의 사항

1. 최대 100개까지만 처리 가능

   • 한 번에 100개 이상의 속성을 설정하면 적용되지 않습니다.

2. Key 값 제한

   • 문자 타입(String) 이어야 하며, 최소 2자 이상 최대 32자까지 입력할 수 있습니다.

   • 영문 소문자와 숫자 그리고 _만 사용 가능합니다.

3. Value 값 제한

   • 최대 1024바이트까지 입력할 수 있습니다.

   • 값으로 null을 사용할 수 없습니다.

   • 가능한 타입: Number, Boolean, String.

4. 표준 이벤트 속성 타입 제한

   • 정해진 타입만 사용할 수 있으며, 임의 변경은 불가능합니다.

5. 검증 실패 시 적용 불가

   • 조건을 충족하지 않은 속성은 이벤트에 자동으로 제외됩니다.

이벤트 기록

logEvent 메소드를 사용하여 유저의 이벤트를 기록합니다. 표준 이벤트는 상수를 제공합니다.

logEvent(eventName);

logEvent(eventName, properties);

각각의 매개변수는 다음을 의미합니다.

• eventName : 이벤트 이름

• properties : 이벤트 속성

표준이벤트 마다 필수 값이 다릅니다. 확인 후 사용하세요.

이벤트 기록 예시

Javascript

// 이벤트만 기록할 경우 ex) 상수 사용시
adbrix.logEvent(ABEvent.LOGIN);

// 또는 이벤트 속성명을 직접 입력해도 됩니다.
adbrix.logEvent("abx:login");

// 이벤트 속성과 함께 기록할 경우 ex) 회원가입
const properties = {};
properties[ABEventProperty.SIGN_CHANNEL] = ABSignUpChannel.KAKAO;
adbrix.logEvent(ABEvent.SIGN_UP, properties);

표준 이벤트 & 상품 속성

표준 이벤트와 표준 이벤트 속성, 상품 속성은 아래와 같습니다. 이벤트 이름으로도 사용가능합니다.

표준 이벤트

표준 이벤트 이름은 다음과 같이 사전 정의된 정적 상수로 제공됩니다.

상수	이벤트명	표기명
ABEvent.LOGIN	"abx:login"	로그인
ABEvent.LOGOUT	"abx:logout"	로그아웃
ABEvent.SIGN_UP	"abx:sign_up"	회원가입
ABEvent.USE_CREDIT	"abx:use_credit"	크레딧 사용
ABEvent.INVITE	"abx:invite"	사용자 초대
ABEvent.PURCHASE	"abx:purchase"	구매
ABEvent.LEVEL_ACHIEVED	"abx:level_achieved"	레벨 달성
ABEvent.TUTORIAL_COMPLETED	"abx:tutorial_completed"	튜토리얼 완료
ABEvent.CHARACTER_CREATED	"abx:character_created"	캐릭터 생성
ABEvent.STAGE_CLEARED	"abx:stage_cleared"	스테이지 완료
ABEvent.REFUND	"abx:refund"	주문 취소하기(환불하기)
ABEvent.ADD_TO_CART	"abx:add_to_cart"	장바구니 담기
ABEvent.ADD_TO_WISHLIST	"abx:add_to_wishlist"	관심 상품(위시리스트) 추가
ABEvent.PRODUCT_VIEW	"abx:product_view"	상품 상세 보기
ABEvent.CATEGORY_VIEW	"abx:category_view"	카테고리(기획전) 진입
ABEvent.REVIEW_ORDER	"abx:review_order"	주문 확인하기
ABEvent.SEARCH	"abx:search"	상품 검색하기
ABEvent.SHARE	"abx:share"	상품 공유하기
ABEvent.VIEW_HOME	"abx:view_home"	홈(메인) 화면 진입
ABEvent.LIST_VIEW	"abx:list_view"	상품 목록 조회하기
ABEvent.CART_VIEW	"abx:cart_view"	장바구니 조회하기
ABEvent.PAYMENT_INFO_ADDED	"abx:paymentinfo_added"	결제 정보 입력하기

표준 이벤트 속성

표준 이벤트의 속성 명의 경우 다음과 같이 이벤트 속성 명이 사전 정의된 정적 상수로 제공됩니다.

상수	이벤트 속성명	표기명
ABEventProperty.IS_SKIP	"abx:is_skip"	튜토리얼 skip 여부
ABEventProperty.LEVEL	"abx:level"	레벨
ABEventProperty.STAGE	"abx:stage"	스테이지 명
ABEventProperty.KEYWORD	"abx:keyword"	검색 키워드
ABEventProperty.SHARING_CHANNEL	"abx:sharing_channel"	공유 SNS
ABEventProperty.SIGN_CHANNEL	"abx:sign_channel"	회원가입 채널
ABEventProperty.INVITE_CHANNEL	"abx:invite_channel"	사용자 초대 채널
ABEventProperty.ORDER_ID	"abx:order_id"	주문 ID
ABEventProperty.DELIVERY_CHARGE	"abx:delivery_charge"	배송료 설정
ABEventProperty.PENALTY_CHARGE	"abx:penalty_charge"	페널티 가격
ABEventProperty.PAYMENT_METHOD	"abx:payment_method"	결제 방법
ABEventProperty.ORDER_SALES	"abx:order_sales"	판매 가격
ABEventProperty.DISCOUNT	"abx:discount"	할인 가격
ABEventProperty.ITEMS	"abx:items"	상품

상품 속성

ABEventProperty.ITEMS 내에 배열로 적재되는 상품에 대한 표준 이벤트 속성에 대한 정보입니다. ITEM_ID, ITEM_NAME, ITEM_PRICE, ITEM_QUANTITY, ITEM_DISCOUNT는 필수 값으로 반드시 포함해야 합니다.

상수	이벤트 속성명	타입	설명	필수
ABEventProperty.ITEM_PRODUCT_ID	"abx:product_id"	String	상품 번호(ID)	✅
ABEventProperty.ITEM_PRODUCT_NAME	"abx:product_name"	String	상품 명	✅
ABEventProperty.ITEM_PRICE	"abx:price"	Double	상품 단가	✅
ABEventProperty.ITEM_QUANTITY	"abx:quantity"	Integer	상품 수량	✅
ABEventProperty.ITEM_DISCOUNT	"abx:discount"	Double	상품 할인가	✅
ABEventProperty.ITEM_CURRENCY	"abx:currency"	String	화폐 단위
ABEventProperty.ITEM_CATEGORY1	"abx:category1"	String	상품 카테고리1
ABEventProperty.ITEM_CATEGORY2	"abx:category2"	String	상품 카테고리2
ABEventProperty.ITEM_CATEGORY3	"abx:category3"	String	상품 카테고리3
ABEventProperty.ITEM_CATEGORY4	"abx:category4"	String	상품 카테고리4
ABEventProperty.ITEM_CATEGORY5	"abx:category5"	String	상품 카테고리5

표준 공통 이벤트 사용 예시

로그인

유저가 로그인하는 동작을 나타내는 이벤트입니다.

Javascript

  // 로그인 이벤트
  adbrix.logEvent(ABEvent.LOGIN);

로그아웃

유저가 로그아웃하는 동작을 나타내는 이벤트입니다.

Javascript

adbrix.logEvent(ABEvent.LOGOUT);

회원가입

유저가 회원으로 가입하는 동작을 나타내는 이벤트입니다.

Javascript

const properties = {};
properties[ABEventProperty.SIGN_CHANNEL] = ABSignUpChannel.KAKAO;
adbrix.logEvent(ABEvent.SIGN_UP, properties);

표준 이벤트 속성

이름	타입	설명	필수
ABEventProperty.SIGN_CHANNEL	String	회원가입 채널	✅

구매

유저가 상품이나 서비스를 구매하는 동작을 나타내는 이벤트입니다.

Javascript

const item = {};
item[ABEventProperty.ITEM_PRODUCT_ID] = "상품번호";
item[ABEventProperty.ITEM_PRODUCT_NAME] = "상품이름";
item[ABEventProperty.ITEM_PRICE] = 5000;
item[ABEventProperty.ITEM_DISCOUNT] = 500;
item[ABEventProperty.ITEM_QUANTITY] = 6;
item[ABEventProperty.ITEM_CATEGORY1] = "식품";
item[ABEventProperty.ITEM_CATEGORY2] = "과자";

const itemList = [];
itemList.push(item);

const properties = {};
properties[ABEventProperty.ITEMS] = itemList;
properties[ABEventProperty.PAYMENT_METHOD] = ABPaymentMethod.CREDIT_CARD;
properties[ABEventProperty.ORDER_ID] = "Order-123";
properties[ABEventProperty.ORDER_SALES] = 30000;
properties[ABEventProperty.DELIVERY_CHARGE] = 2500;
properties[ABEventProperty.DISCOUNT] = 3000;

adbrix.logEvent(ABEvent.PURCHASE, properties);

표준 이벤트 속성

이름	타입	설명	필수
ABEventProperty.ITEMS	Array	상품 속성	✅
ABEventProperty.ORDER_ID	String	주문 번호(ID)	✅
ABEventProperty.PAYMENT_METHOD	String	결제 방법	✅
ABEventProperty.ORDER_SALES	NUMBER	주문 총액	✅
ABEventProperty.DELIVERY_CHARGE	NUMBER	배송료	✅
ABEventProperty.DISCOUNT	NUMBER	상품할인가	✅

표준 커머스 이벤트 사용 예시

홈 화면 조회

유저가 앱의 홈 화면을 조회하는 동작을 나타내는 이벤트입니다.

Javascript

const properties = {};
properties["key"] = "value"; //사용자 정의 속성 값(Optional)
adbrix.logEvent(ABEvent.VIEW_HOME, properties);

카테고리 진입

유저가 카테고리(기획전) 화면으로 진입한 이벤트를 분석합니다.

Javascript

const properties = {};
properties[ABEventProperty.CATEGORY1] = "식품";  //화면의 Category
properties[ABEventProperty.CATEGORY2] = "과자"; 
properties[ABEventProperty.CATEGORY3] = "기획전"; 
properties[ABEventProperty.CATEGORY4] = "오늘의특가"; 

const item = {};
item[ABEventProperty.ITEM_PRODUCT_ID] = "상품번호";
item[ABEventProperty.ITEM_PRODUCT_NAME] = "상품이름";
item[ABEventProperty.ITEM_PRICE] = 5000;
item[ABEventProperty.ITEM_DISCOUNT] = 500;
item[ABEventProperty.ITEM_QUANTITY] = 5;
item[ABEventProperty.ITEM_CATEGORY1] = "식품"; //상품의 Category
item[ABEventProperty.ITEM_CATEGORY2] = "과자";

const itemList = [];
itemList.push(item);

properties[ABEventProperty.ITEMS] = itemList

adbrix.logEvent(ABEvent.CATEGORY_VIEW, properties);

표준 이벤트 속성

이름	타입	설명	필수
ABEventProperty.CATEGORY1	String	상품 카테고리	✅
ABEventProperty.CATEGORY2	String	상품 카테고리
ABEventProperty.CATEGORY3	String	상품 카테고리
ABEventProperty.CATEGORY4	String	상품 카테고리
ABEventProperty.CATEGORY5	String	상품 카테고리
ABEventProperty.ITEMS	Array	상품 속성	✅

상품 상세 보기

유저가 특정 상품의 상세 정보를 조회하는 동작을 나타내는 이벤트입니다.

Javascript

const item = {};
item[ABEventProperty.ITEM_PRODUCT_ID] = "상품번호";
item[ABEventProperty.ITEM_PRODUCT_NAME] = "상품이름";
item[ABEventProperty.ITEM_PRICE] = 5000;
item[ABEventProperty.ITEM_DISCOUNT] = 500;
item[ABEventProperty.ITEM_QUANTITY] = 5;
item[ABEventProperty.ITEM_CATEGORY1] = "식품";
item[ABEventProperty.ITEM_CATEGORY2] = "과자";

const itemList = [];
itemList.push(item);

const properties = {};
properties[ABEventProperty.ITEMS] = itemList;
adbrix.logEvent(ABEvent.PRODUCT_VIEW, properties);

표준 이벤트 속성

이름	타입	설명	필수
ABEventProperty.ITEMS	Array	상품 속성	✅

장바구니 담기

유저가 상품을 장바구니에 담는 동작을 나타내는 이벤트입니다.

Javascript

const item = {};
item[ABEventProperty.ITEM_PRODUCT_ID] = "상품번호";
item[ABEventProperty.ITEM_PRODUCT_NAME] = "상품이름";
item[ABEventProperty.ITEM_PRICE] = 5000;
item[ABEventProperty.ITEM_DISCOUNT] = 500;
item[ABEventProperty.ITEM_QUANTITY] = 5;
item[ABEventProperty.ITEM_CATEGORY1] = "식품";
item[ABEventProperty.ITEM_CATEGORY2] = "과자";

const itemList = [];
itemList.push(item);

const properties = {};
properties[ABEventProperty.ITEMS] = itemList;
adbrix.logEvent(ABEvent.ADD_TO_CART, properties);

표준 이벤트 속성

이름	타입	설명	필수
ABEventProperty.ITEMS	Array	상품 속성	✅

관심 상품 추가

유저가 상품을 관심 목록에 추가하는 동작을 나타내는 이벤트입니다.

Javascript

const item = {};
item[ABEventProperty.ITEM_PRODUCT_ID] = "상품번호";
item[ABEventProperty.ITEM_PRODUCT_NAME] = "상품이름";
item[ABEventProperty.ITEM_PRICE] = 5000;
item[ABEventProperty.ITEM_DISCOUNT] = 500;
item[ABEventProperty.ITEM_QUANTITY] = 5;
item[ABEventProperty.ITEM_CATEGORY1] = "식품";
item[ABEventProperty.ITEM_CATEGORY2] = "과자";

const itemList = [];
itemList.push(item);

const properties = {};
properties[ABEventProperty.ITEMS] = itemList;
adbrix.logEvent(ABEvent.ADD_TO_WISHLIST, properties);

표준 이벤트 속성

이름	타입	설명	필수
ABEventProperty.ITEMS	Array	상품 속성	✅

주문 확인 하기

유저가 구매한 주문을 취소하고 환불하는 동작을 나타내는 이벤트입니다.

Javascript

const item = {};
item[ABEventProperty.ITEM_PRODUCT_ID] = "상품번호";
item[ABEventProperty.ITEM_PRODUCT_NAME] = "상품이름";
item[ABEventProperty.ITEM_PRICE] = 5000;
item[ABEventProperty.ITEM_DISCOUNT] = 500;
item[ABEventProperty.ITEM_QUANTITY] = 5;
item[ABEventProperty.ITEM_CATEGORY1] = "식품";
item[ABEventProperty.ITEM_CATEGORY2] = "과자";

const itemList = [];
itemList.push(item);

const properties = {};
properties[ABEventProperty.ITEMS] = itemList;
adbrix.logEvent(ABEvent.REVIEW_ORDER, properties);

표준 이벤트 속성

이름	타입	설명	필수
ABEventProperty.ITEMS	Array	상품 속성	✅

주문 취소하기

유저가 구매한 주문을 취소하고 환불하는 동작을 나타내는 이벤트입니다.

Javascript

const item = {};
item[ABEventProperty.ITEM_PRODUCT_ID] = "상품번호";
item[ABEventProperty.ITEM_PRODUCT_NAME] = "상품이름";
item[ABEventProperty.ITEM_PRICE] = 5000;
item[ABEventProperty.ITEM_DISCOUNT] = 500;
item[ABEventProperty.ITEM_QUANTITY] = 5;
item[ABEventProperty.ITEM_CATEGORY1] = "식품";
item[ABEventProperty.ITEM_CATEGORY2] = "과자";

const itemList = [];
itemList.push(item);

const properties = {};
properties[ABEventProperty.ITEMS] = itemList;
adbrix.logEvent(ABEvent.REFUND, properties);

표준 이벤트 속성

이름	타입	설명	필수
ABEventProperty.ITEMS	Array	상품 속성	✅
ABEventProperty.TOTAL_REFUND_AMOUNT	NUMBER	환불 총액	✅

상품 검색하기

유저가 상품을 검색하여 결과를 확인하는 동작을 나타내는 이벤트입니다.

Javascript

const item = {};
item[ABEventProperty.ITEM_PRODUCT_ID] = "상품번호";
item[ABEventProperty.ITEM_PRODUCT_NAME] = "상품이름";
item[ABEventProperty.ITEM_PRICE] = 16000;
item[ABEventProperty.ITEM_DISCOUNT] = 700;
item[ABEventProperty.ITEM_QUANTITY] = 10;
item[ABEventProperty.ITEM_CATEGORY1] = "식품";
item[ABEventProperty.ITEM_CATEGORY2] = "과자";

const itemList = [];
itemList.push(item);

const properties = {};
properties[ABEventProperty.ITEMS] = itemList;
properties[ABEventProperty.KEYWORD] = "사또밥";

adbrix.logEvent(ABEvent.SEARCH, properties);

표준 이벤트 속성

이름	타입	설명	필수
ABEventProperty.ITEMS	Array	상품 속성	✅
ABEventProperty.KEYWORD	String	검색 키워드	✅

상품 공유하기

유저가 상품을 공유하는 동작을 나타내는 이벤트입니다.

Javascript

const item = {};
item[ABEventProperty.ITEM_PRODUCT_ID] = "상품번호";
item[ABEventProperty.ITEM_PRODUCT_NAME] = "상품이름";
item[ABEventProperty.ITEM_PRICE] = 5000;
item[ABEventProperty.ITEM_DISCOUNT] = 500;
item[ABEventProperty.ITEM_QUANTITY] = 5;
item[ABEventProperty.ITEM_CATEGORY1] = "식품";
item[ABEventProperty.ITEM_CATEGORY2] = "과자";

const itemList = [];
itemList.push(item);

const properties = {};
properties[ABEventProperty.ITEMS] = itemList;
properties[ABEventProperty.SHARING_CHANNEL] = "Facebook";

adbrix.logEvent(ABEvent.SHARE, properties);

표준 이벤트 속성

이름	타입	설명	필수
ABEventProperty.ITEMS	Array	상품 속성	✅
ABEventProperty.SHARING_CHANNEL	String	상품 공유 채널	✅

상품 목록 조회

유저가 상품 목록을 조회하는 동작을 나타내는 이벤트입니다.

Javascript

const item = {};
item[ABEventProperty.ITEM_PRODUCT_ID] = "상품번호";
item[ABEventProperty.ITEM_PRODUCT_NAME] = "상품이름";
item[ABEventProperty.ITEM_PRICE] = 5000;
item[ABEventProperty.ITEM_DISCOUNT] = 500;
item[ABEventProperty.ITEM_QUANTITY] = 5;
item[ABEventProperty.ITEM_CATEGORY1] = "식품";
item[ABEventProperty.ITEM_CATEGORY2] = "과자";

const itemList = [];
itemList.push(item);

const properties = {};
properties[ABEventProperty.ITEMS] = itemList;

adbrix.logEvent(ABEvent.LIST_VIEW, properties);

표준 이벤트 속성

이름	타입	설명	필수
ABEventProperty.ITEMS	Array	상품 속성	✅

장바구니 조회

유저가 장바구니를 조회하는 동작을 나타내는 이벤트입니다.

Javascript

const item = {};
item[ABEventProperty.ITEM_PRODUCT_ID] = "상품번호";
item[ABEventProperty.ITEM_PRODUCT_NAME] = "상품이름";
item[ABEventProperty.ITEM_PRICE] = 5000;
item[ABEventProperty.ITEM_DISCOUNT] = 500;
item[ABEventProperty.ITEM_QUANTITY] = 5;
item[ABEventProperty.ITEM_CATEGORY1] = "식품";
item[ABEventProperty.ITEM_CATEGORY2] = "과자";

const itemList = [];
itemList.push(item);
//itemList.push(item2); 아이템이 2개 이상인경우 추가로 입력

const properties = {};
properties[ABEventProperty.ITEMS] = itemList;

adbrix.logEvent(ABEvent.CART_VIEW, properties);

표준 이벤트 속성

이름	타입	설명	필수
ABEventProperty.ITEMS	Array	상품 속성	✅

구매 정보 입력

유저가 구매 정보를 입력하는 동작을 나타내는 이벤트입니다.

Javascript

const properties = {};
properties["key"] = "value"; //사용자 정의 속성 값(Optional)
adbrix.logEvent(ABEvent.PAYMENT_INFO_ADDED, properties);

표준 게임 이벤트 사용 예시

튜토리얼 완료

앱에서 발생한 튜토리얼 완료 이벤트입니다.

javascript

const properties = {};
properties[ABEventProperty.IS_SKIP] = false;
adbrix.logEvent(ABEvent.TUTORIAL_COMPLETED, properties);

표준 이벤트 속성

이름	타입	설명	필수
ABEventProperty.IS_SKIP	Boolean	튜토리얼 skip 여부	✅

캐릭터 생성

앱에서 발생한 캐릭터 생성 이벤트입니다.

javascript

adbrix.logEvent(ABEvent.CHARACTER_CREATED);

스테이지 완료

앱에서 발생한 스테이지 완료 이벤트입니다.

javascript

const properties = {};
properties[ABEventProperty.STAGE] = "STAGE_NAME";
adbrix.logEvent(ABEvent.STAGE_CLEARED, properties);

표준 이벤트 속성

이름	타입	설명	필수
ABEventProperty.STAGE	String	스테이지 이름	✅

레벨 달성

앱에서 발생한 레벨 달성 이벤트입니다.

javascript

const properties = {};
properties[ABEventProperty.LEVEL] = 50;
adbrix.logEvent(ABEvent.LEVEL_ACHIVED, properties);

표준 이벤트 속성

이름	타입	설명	필수
ABEventProperty.LEVEL	Integer	사용자 레벨	✅

커스텀 이벤트

사용자가 직접 임의의 이벤트 명칭과 속성을 입력하여 반영하는 이벤트입니다. 표준 이벤트에도 디파이너리 콘솔에서 커스텀 속성을 추가하여 사용할 수 있습니다.

속성이 없을 경우

Javascript

adbrix.logEvent("CUSTOM_EVENT_NAME");

속성이 있을 경우

Javascript

const properties = {};
properties["CUSTOM_PROPERTY_KEY"] = "CUSTOM_PROPERTY_VALUE"; //사용자 정의 속성 값(Optional)
adbrix.logEvent("CUSTOM_EVENT_NAME", properties);

자동으로 수집되는 데이터

adbrix SDK는 다음의 정보에 대해서 자동으로 수집합니다.

해당 값은 브라우저의 환경 및 종류에 따라 수집되지 않을 수 있습니다.

• 브라우저

• 브라우저의 버젼

• OS

• 설정된 언어

• 설정된 Time Zone Offset

• Url

• Referer

• utm 파라미터