APMS API User Guide

. MSG-API 호출 가이드

1.1 DeviceCert.class

1.2 LoginPms.class

1.3 NewMsg.class

1.4 ReadMsg.class

1.5 SetConfig.class

1.6 LogoutPms.class

1.7 SessionStart.class

1.8 SessionEnd.class

1.9 Visit.class

1.10 Cart.class

1.11 Purchase.class

2. APMS 에러 코드표

2.1 MsgApi Error Code

​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​
Code설명
000통신성공
100파라미터 오류, 필수 파라미터 누락
101파라미터 오류, 잘못된 파라미터 크기
102파라미터 오류, 유효하지 않은 파라미터
103복호화 오류
104JSON형식 오류
105잘못된 세션(타임아웃 등)
106암호화 오류
109사용할 수 없는 msgApi
200기타오류 (msgApi)
201기타오류 (확인되지 않음)
510유효하지 않은 앱키

2.2 SDK Error Code

​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​
Code설명
901암호화키 누락
902네트워크 타임아웃, MsgApi 주소 확인 필요
903Respones 값이 없을 경우
904MsgApi 주소 누락
905파라미터 누락
906License 사용 만료
907SDK 버전 사용불가

3. SQLite Bean

3.1 Msg.class (bean)

​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​
변수설명
idDB의 row id
userMsgId(서버에서의) 메시지의 unique한 ID
msgGrpName메시지의 그룹명
appLinkappLink(추가데이터)
iconNameiconName(추가데이터)
msgId메시지 ID
pushTitlepush 타이틀
pushMsgpush 메시지
msgText메시지 텍스트
map1추가매핑정보1
map2추가매핑정보2
map3추가매핑정보3
msgType메시지 유형
readYn읽음여부
delYn삭제여부
expireDate메시지 유효 날짜
regDate메시지 등록 날짜
msgGrpCd메시지 그룹 코드

4. TAS API 호출 가이드

4.1 TAS 서비스 시작

## 3.2 TAS 서비스 종료

  * **앱 종료시 자동 수집 기능을 종료**

    ~~~java
    TAS.Clear();

4.2 앱 사용자 식별

TAS tas = TAS.getInstance(ActivityContext);
tas.identifyUser (String userId, JSONObject userProp);
tas.identifyUser (String userId, String email, String phoneNumber, JSONObject userProp);

4.3 이벤트 수집

TAS tas = TAS.getInstance(ActivityContext);
tas.logEvent (JSONObject parameters);
tas.logEvent (String name, JSONObject parameters);

4.4 뷰 정보 수집

  TAS tas = TAS.getInstance(ActivityContext);
  tas.logPageViewEvent (String pageName);

4.5 커머스 정보 수집

Tas tas = TAS.getInstance(ActivityContext);

# 장바구니 수집 이벤트, tags는 ArrayList<String> 형식의 장바구니 리스트
tas.logCartEvent (ArrayList<String> tags); 
# 예시 : tas.logCartEvent(["사과","귤","배"])

# 장바구니 유기 이벤트, tags는 ArrayList<String> 형식의 유기할 장바구니 리스트
tas.logCartAbandonEvent (ArrayList<String> tags);
# 예시 : tas.logCartEvent(["사과","배"])

# 결제 이벤트, tags는 ArrayList<String> 형식의 결제할 장바구니 리스트
tas.logPurchaseEvent (ArrayList<String> tags, int value); 
# 예시 tas.logPurchaseEvent(["사과","배"], 10000)