ゲーム分析サービス GameAnalytics を Corona SDK にて利用する場合の簡易的な説明です。
GameAnalytics に反映されるまでの時間について
Realtime tool
イベントが送信されてから15分以内に反映されます。
Cohorts, Funnels and Heatmap tools
UTC 12:00 と UTC 24:00 の1日2回のみ反映されます。
Dashboards and Explore tool
ダッシュボードに表示されるデータは、24時間以内に反映されます。
ダウンロードと設定
ダウンロード
以下の GirHub リポジトリからコードをダウンロードします。
読み込み
local GA = require ("GameAnalytics")
注意: GameAnalytics のモジュールはグローバルで定義されていない為、利用する際は毎回読み込みを行う必要があります。
初期化
GA.init({
game_key = “YOUR_GAME_KEY”,
secret_key = “YOUR_SECRET_KEY”,
build_name = "1.0",
})
注意: もし、Android で利用する場合は、以下の作業が必要となります。
-
build.settings
にandroid.permission.INTERNET
を追記する。 - アプリから GameAnalytics サーバーに Android ID を送信することを防ぐ為、
build.settings
にandroid.permission.READ_PHONE_STATE
を設定しないようにして下さい。
オプション
一般的なオプション
- デバッグモード
GameAnalytics に関するデバッグ出力を表示することが可能です。
アプリをリリースする場合は、デバッグモードを無効にして下さい。
デフォルト値は true
です。
GA.isDebug = false
- シミュレーターモード
シミュレーターでアプリを実行している場合は、GameAnalytics サーバーにて、送信されたデータを計測しないように設定することが可能です。
デフォルト値は false
です。
GA.runInSimulator = true
- ローミング状態の時だけ送信する
ローミング状態(キャリアのデータネットワークを介してインターネットに接続されている)の時だけ、データを GameAnalytics サーバーに送信することが可能です。
デフォルト値は false
です。
GA.submitWhileRoaming = true
注意: 一部の Android デバイスはローミング状態を検出することが出来ません。この場合、設定されている値に関係なく、データが送信されます。
- アーカイブデータ
インターネットの利用が出来ない場合や、submitWhileRoaming
が false
に設定されている時に、 デバイスがローミングしている場合に、データをアーカイブしておくことが可能です。
ゲームが再開された場合や、インターネットの利用が出来るようになった場合に、アーカイブされたデータが送信されます。
デフォルト値は false
です。
GA.archiveEvents = true
アーカイブされたデータにて、デバイスのストレージを圧迫させない為に、アーカイブされるデータのサイズ制限を設定することが可能です。
デフォルト値は 512 KB
です。
GA.archiveEventsLimit = 256
ゲームオプション
- デバイス情報送信
セッションが開始される度に、デバイスの詳細情報を送信することが可能です。
デフォルト値は false
です。
GA.submitSystemInfo = true
ストーリーボードオプション
もし、Corona SDK のストーリーボードを利用している場合、GameAnalytics SDK の幾つかの組み込みオプションを利用することが可能です。
エリアパラメータにストーリーボードのシーン名称を利用する
ストーリーボードをフックして、自動的にカスタムイベントのエリアパラメータにストーリーボードのシーン名称を利用します。これは、design
/ quality
/ business
の全てのカスタムイベントに対して適用されます。
デフォルト値は false
です。
GA.useStoryboard = true
注意: カスタムイベントのエリアパラメータは上書きすることが可能です。
ストーリーボードイベントを送信する
ストーリーボードのシーン遷移を自動的に検出して、以下のイベントを送信します。
- enterScene
- exitScene
- overlayBegan
- overlayEnded
各種イベントには、それぞれのストーリーボードのシーン名称を持つエリアパラメータが含まれます。
exitScene
と overlayEnded
イベントは、シーン切り替えやオーバーレイに費やした時間(秒)も合わせて送信します。
デフォルト値は false
です。
GA.submitStoryboardEvents = true