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のメニューから、設定 > Cordovaプラグインの管理...を選んでCordovaプラグインのページを開き、「Cordovaプラグインのインポート」をクリックしてください。

「URLもしくはパッケージ名を指定します」を選択して「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を無効にしてください。

「Cordovaプラグインのインポート」からcordova-plugin-smartbeat-plusをインポートしてください。

3. オプション機能

本節にて、追加機能に関して記述します。アプリケーションからAPIを呼び出すことでこれら追加機能を有効にすることが可能です。

3.2 CatchしたExceptionの保存

SDKバージョン1.2.0以降

アプリケーションがCatchした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");

パンくずは最後に記録されたものから最大16個保存されます。
例えば、「マップ画面」→「ゲーム画面」→「設定画面」などと、キーとなる画面の遷移時に残した場合、エラー直前にユーザがどのような画面遷移を行ったかを知ることができます。

3.6 オーディエンス機能

ユーザ識別子として IDFA を使用することで、アプリケーションを利用するユーザの男女比や年齢分布を確認できるようになります。

有効化方法

重複ユーザカウントの抑止設定を有効にすることでオーディエンス機能も有効となります。重複ユーザカウントの抑止設定についてはこちらを参照ください。