Cordova/Monaca SDK

1. 대응Cordova버젼

본SDK는 Cordova 5.0이상의 환경에서 작동됩니다.

Android플랫폼의 경우
※ Cordova-android플랫폼3.6.4이상
※ Android SDK 4.4 (android-19) 이후의

iOS플랫폼의 경우
※ Cordova-ios플랫폼3.7.0이상
※ OS X El Capitan이상
※ XCode 7.0이상

Monaca의 경우
※Monaca 프로젝트가 사용하고 있는 Cordova가 위 조건을 충족해야 합니다.
※사용자 Cordova 플러그인을 지원하는 Monaca 플랜을 사용해야 합니다.

2. Cordova/Monaca의Project에SDK를 적용하는 방법

Step1:SDK의 적용

  • Cordova
  • Monaca
프로젝트 폴더에 이하의 커맨드를 실행, 또한 IDE에서 플러그인을 추가 하여 주세요.

cordova plugin add cordova-plugin-smartbeat

※중복 유저 카운트의 방지설정을 하는 경우,‘cordova-plugin-smartbeat’ 대신에‘cordova-plugin-smartbeat-plus’을 사용하여 주세요.

IDE 메뉴에서 Configure > Cordova Plugin Settings... 를 선택하고, Cordova 플러그인 페이지를 연 다음, 「Import Cordova Plugin」을 클릭하세요.

「Specify URL or Package Name」을 선택하고 「cordova-plugin-smartbeat」라고 입력한 다음, 「OK」를 누르세요.

※ 사용자 중복 카운트 방지를 설정할 경우, 'cordova-plugin-smartbeat' 대신 'cordova-plugin-smartbeat-plus'를 사용하세요.

Step2:API키의 설정

www/js/index.js 또는 어플리케이션의 메인JS파일로 Cordova의ondeviceready이벤트 핸들러에 이하의 코드를 실제의 API키를 넣은 상태에서 추가하여 주세요.

SmartBeat.startWithApiKey({android: "Android용API키", ios: "iOS용API키"});

Step3:중복 유저카운트 방지설정

유저수의 집계에 IDFA을 사용하는 것으로 동일 유저의 중복 카운트를 방지 합니다. 이거에 의해 어플리의 재인스톨을 반복하는 행위(속칭「리세마라」)가 있어도 불필요한 MAU(Monthly Active Users)수의 중가를 억제하는게 가능합니다.

※ 중복된 유저의 카운트를 막는 설정을 유효화하는 것으로 오디언스 기능도 유효화 됩니다.

본기능을 유효로 하지 않은 경우에는 이하의 순서가 필요하지 않습니다.

  • Cordova
  • Monaca
아래와 같이 cordova-plugin-smartbeat에 플러그인을 제외하고 cordova-plugin-smartbeat-plus에 변경할 수 있도록 커멘드를 실행하여 주세요.

cordova plugin rm cordova-plugin-smartbeat
cordova plugin add cordova-plugin-smartbeat-plus
Cordova 플러그인 페이지에서 cordova-plugin-smartbeat를 비활성화하세요.

「Import Cordova Plugin」에서 cordova-plugin-smartbeat-plus를 가져오세요.

3. 옵션기능

본 기능에서는 추가 기능에 대해서 말씀 드립니다. 어플리케이션으로 부터 API을 불러오는 것으로 이런 추가기능을 유효로 하는 것이 가능합니다.

3.1 Catch한 Exception의 보존

SDK버전 1.2.0이후

App이 캐치한 Exception을 기록할 수 있습니다.

유효화 방법
try {
    throw new Error();
} catch (e) {
    SmartBeat.logException(e);
}

3.2 로그 출력

단말의 로그에 출력하는것이 아닌 , 로그의 수집을 하는 것이 가능합니다.
※64KB에 도달하지 않는 경우는 최대 500행 , 그이외는 64KB에 허용되는 범위에서 최신의 로그를 취득합니다.

유효화 방법

이하의 API불러오기를 실행하는 것으로 로그를 보존 가능합니다.

Smartbeat.log("Log message here");

3.3 유저ID설정

대상의 어플리케이션이 관리하는 유저를 식별하는 ID가 이미 있는 경우, 그것을 설정하는 것이 가능합니다.
설정된 유저ID는 크래쉬와 함께 SmartBeat서버에 송신됩니다.어떤 유저에게 크래쉬가 발생했는지 등 관리 콘솔상에서 확인이 가능합니다.

유효화 방법

이하의 API불러오기를 실행하는 것으로 설정가능 합니다.

SmartBeat.setUserId("user001");

3.4 확장정보

크래쉬 정보에 확장정보를 부여하는 것이 가능합니다. 어플리케이션에 따라서 유저가 설정한 정보 및 어플리케이션이 내부에 보존하고 있는 정보가 크래쉬 해석에 도움이 됩니다.

유효화 방법

이하의 API불러오기를 실행하는 것으로 임의의 키네임과 키 수치의 세트를 크래쉬 데이터와 함께 보존하는게 가능합니다.

SmartBeat.setExtraData("key","value");

3.5 브레드 크럼(breadcrumb)기능

임의의 포인트로 브레드크럼을 남기는 것으로 부터 에러가 발생할때 까지의 유저가 한 조작 및 화면 전이등을 수집하는 것이 가능합니다.

유효화 방법

브레드 크럼을 떨구는(기록을 남기고 싶은)장소에서 아래의 API를 불러와 주세요.

SmartBeat.leaveBreadcrumb:("game scene 1");

브레드 크럼은 최후에 기록된 부분으로 부터 최대 128개까지 보존됩니다.
일반 동작과 상태 변경 사항을 자동으로 브레드크럼으로 기록합니다. 자동 기록 대상은 이곳(Android / iOS) 을 참조하세요.

3.6 오디언스 기능

유저 식별자로서 IDFA를 사용하는 것으로 어플리케이션을 이용하는 유저의 남여비교 및 연령분포를 확인하는 것이 가능합니다.

유효화 방법

중복 유저 카운트의 방지 설정을 유효화하는 것으로 오디언스 기능도 유효화가 됩니다. 중복 유저 카운트의 방지 설정에 대해서는 이쪽을 참조 부탁드리겠습니다.