アップデート通知機能の組み込みと利用
アップデート通知機能
Shell App SDK for Android でリリースしたバージョンについて、アップデートの通知を行いたいときに使うのが、アップデート通知機能です。
アップデート通知には以下の2種類があります。
- 後で問題が発覚したバージョンを強制的にアップデートしたいときに使う、強制アップデート通知
- 最新バージョンをリリースしたさいに任意でのアップデートを促す、任意アップデート通知
リリースするそれぞれのバージョンにセマンティックなバージョン番号をつけておき、アップデートを促すダイアログを表示することができます。
 | セマンティックバージョニングとは、バージョン番号を 1.3.2 のようなX.Y.Z (Major.Minor.Patch) で表現する方法のことです。 それぞれの番号は 65536 未満の値にしてください。なお、セマンティックバージョニングについて詳しくはこちらを参照してください。 |
AndroidManifest.xml
バージョン番号を指定するには、下記のように AndroidManifestを編集します。
- versionCode にビルド番号を指定してください
- versionName にセマンティックなバージョン番号をつけてください
Sandbox 環境での アップデート通知の確認
Mobage Developers Japan (デベロッパーサイト) にて、「アプリケーション一覧」 > 「アプリケーション」 > 「Android」 > 「アップデート通知管理」を選択します。
「Sandbox アップデート通知設定」 を ON にします。
「Sandbox アップデート通知設定」 が ON になっていると、 Shell App SDK for Android 1.2.0 以降が組み込まれているアプリにて以下のようなダイアログが表示されます。
このダイアログが表示されれば、アップデート通知機能の組み込み確認は完了です。
本番環境でのアップデート通知の確認
本番環境でアップデート通知を実施するには、以下を設定する必要があります。
- アップデートする新しいバージョン
- アップデートしたい古いバージョン
アップデートする新しいバージョンについて
アップデート通知を行うためには、アップデートする新しいバージョンが必要となります。
新しいバージョンを Google Play からダウンロード出来る状態にして、以下のような情報をアップデート通知管理に追加します。
| 項目名 | 説明 |
|---|---|
| バージョン | ゲームアプリ毎に設定するパッケージのセマンティックなバージョン番号を指定します。 |
| SDK | パッケージに組み込んでいる Shell App SDK for Android のバージョン番号を指定します。 |
| サポートOS | サポート対象となる Android OS のバージョン番号を指定します。 |
アップデート通知管理に入力したバージョン番号のパッケージが、Google Play 上でダウンロード出来る状態になっていれば、「リリース済みにする」というリンクが表示されます。
「リリース済みにする」をクリックして、「リリースステータス」を「リリース済み」に変更してください。
アップデートしたい古いバージョンについて
アップデートしたい古いバージョンのバージョン番号をアップデート通知管理に追加します。
こちら新しいバージョンが登録されていれば、Google Play からダウンロードできなくても「リリース済みにする」というリンクが表示されます。
「リリース済みにする」をクリックして、「リリースステータス」を「リリース済み」に変更してください。
ここでは、以下のように新しいバージョンと古いバージョンを設定しました。
| バージョン | SDK | サポートOS | |
|---|---|---|---|
| 新しいバージョン | 1.4.2 | 1.2.0 | 2.3.3 以上 |
| アップデートしたい古いバージョン | 0.0.1 | 1.2.0 | 2.3.3 以上 |
| アップデート通知管理に登録する順番に意味は無く、後から古いバージョンについて登録しても問題ありません。 アップデート通知管理に登録されていないバージョンがあった場合、そのバージョンへのアップデート通知は送られません。通知を送りたい全てのバージョンについて登録をお願いします。 |
任意アップデート通知
Shell App SDK for Android が組み込まれたアプリが起動したタイミングで、バージョンが古いと下記のダイアログが表示され、ユーザーの任意によるアップデートを促すことができます。
任意アップデート通知では、ユーザはアプリをアップデートするか、通知をキャンセルしてゲームプレイを継続するかを選択することができます
強制アップデート通知
提供したそれぞれのバージョンについて、後に問題が発覚したバージョンを強制的にアップデートしたいときに使うのが、強制アップデート通知です。
リリースするそれぞれのバージョンにセマンティックなバージョン番号をつけておき、後に問題が発生したバージョンを指定して、アップデートを促すダイアログを表示することができます。
ここでは下記のような設定を行い、バージョン0.0.1について「強制アップデートする」を選択して設定します。
強制アップデート通知を「する」という設定がされ、対象バージョンで遊んでいるユーザーは、アプリのアップデートを行わない限りゲームをプレイすることができなくなりました。
 | Platform から提供している Shell App SDK に脆弱性が発見され、その脆弱性がある Shell App SDK を利用していない最新のバージョンがあった場合に、Platform 側で強制アップデートをかける可能性があります。 最新のバージョンがない場合、強制アップデートは実施されません |
注意点
アップデート通知のダイアログは以下のタイミングで表示されます。
- アプリの起動時
- アプリのレジューム時
- JavaScript SDK の API の mobage.init() 呼び出し時
アップデート通知の設定を行っても上記タイミング以外ではダイアログが表示されない点をを注意して、アップデート通知を設定する必要があります。
更新履歴
- 2016/04/04
- 注意点を追加しました
- 2015/02/05
- 新規作成