テンプレートの利用による Shell App SDK for Android の組み込み (Android Studio) 1.7.0 以降について

本ドキュメントは、Shell App SDK 1.7.0 以降のテンプレートプロジェクトを対象にしています。

サンプルコードのダウンロード

https://github.com/DeNADev/MobageShellAppSDKSampleApp

より、テンプレートプロジェクトとなるサンプルコードのダウンロード、もしくは git clone を行います。

SDK の配置

  1. Shell App SDK をデベロッパーサイトよりダウンロードします。
    https://developer.dena.jp/mbga/admin/sdk/shellappsdk
  2. ダウンロードした Shell App SDK を任意の位置に解凍し、さらに Android 用の SDK が含まれる zip を解凍します。
  3. 解凍したディレクトリ内に含まれる MobageShellAppSDK ディレクトリをサンプルコードのあるディレクトリの直下にコピーします。(以下キャプチャの位置にコピーします)

Android Studio のセットアップ

http://developer.android.com/sdk へアクセスして、Android Studio をダウンロードします。「Download Android Studio」ボタンをクリックして Android Studio のイメージファイルをダウンロードしてください。

img ファイルを開き、Applications ディレクトリへインストールを行ってください。

インストールが完了したら、アプリケーションの「Android Studio.app」を実行します。実行するとセットアップウィザードが開きますが、「Next」ボタンをクリックして先に進んで下さい。全てデフォルトで問題ありません。

テンプレートプロジェクトをインポートする

Shell App SDK のサンプルプロジェクトをインポートします。このサンプルプロジェクトをテンプレートとして、Shell App SDK を使用したアプリを作成することができます。

Android Studio を起動すると以下のような画面が表示されますので、「Open an exitsting Android Studio project」をクリックします。

 

ディレクトリを選択する画面が表示されますので、サンプルコードのディレクトリ配下の android/MobageShellAppSDKSampleApp を選択し、「Open」ボタンをクリックしてください。

 

Google Play services のインストール

Shell App SDK を使用するためには、Google Play services ライブラリをインストールする必要があります。以下の手順に従ってインストールしてください。

  1. Android Studio の起動
  2. メニューバーの Android Studio より、Preferences を選択
  3. [Apperance & Behavior] -> [System Settings] -> [Android SDK] を選択し、[SDK Tools] タブをクリックしてください。
  4. Google Play services がインストールされていない場合、インストールを行ってください。

SDK Tools 内のその他ライブラリは、場合によってはインストールもしくはバージョンアップが必要になることがあります。適宜対応を行ってください。

 

テンプレートプロジェクトの編集

build.gradle ファイルの編集

ShellAppSDKSample プロジェクトの shellAppSDKSample/build.gradle の android/defaultConfig/applicationId に記載されている_MOBAGE_APPLICATION_ID_ と記載されている部分を 12XXXXXX というデベロッパーサイトに記載されている AppId に書き換えてください。

また、shellAppSDKSample/build.gradle の dependencies の項目に、以下の内容が記載されていることを確認します。以下の文字列が記載されていることにより、Google Play services ライブラリをインポートできます。

 

MobageShellAppSDKSampleApp/build.gradle の buildscript と allprojects の項目で jcenter() の前に google() が記述されていることを確認してください。

記述の順番が違うことによってライブラリのインポートが正常に行なえません。

 

 

 AndroidManifest.xml の編集

AndroidManifest.xml は build.gradle によって自動的に書き換わります。

Shell App SDK for Android では、セマンティックなバージョン番号をつけなければなりません。

セマンティックバージョニングとは、バージョン番号を 1.3.2 のようなX.Y.Z (Major.Minor.Patch) で表現する方法のことです。
それぞれの番号は 65536 未満の値にしてください。なお、セマンティックバージョニングについて詳しくはこちらを参照してください。

テンプレートを利用する場合は既に 1.0.0 に設定されてセマンティックになっていますが、バージョンを変更する際は、android:versionName の値をセマンティックなバージョン番号であることを確認してください。

 

 

GameActivity.java の編集

GameActivity.java の onCreate メソッドに記載されている以下のコードの _EMBEDDED_KEY_ と _EMBEDDED_SECRET_ という文字列の部分をデベロッパーサイトに記載されている Embedded Key/Embedded Secret に置き換えます。

以下のように書き換えてください。

リモート通知を利用する場合には setClientCredentials() の呼び出し方が変わります。

下記のリンク内の 「FCM 初期化について」を確認してください。

Remote Notification の組み込み Shell App SDK for Android 1.7.0 以降について

strings.xml の編集

ShellAppSDKSample プロジェクトの shellAppSDKSample/src/main/res/values/strings.xml の _INITIAL_URL_ という文字列の部分をデベロッパーサイトに記載されている Client URL に記載されている内容に書き換えます。

以下のように書き換えてください。

プロジェクトへの反映

「Sync Project With Gradle Files」ボタンをクリックして、build.gradle などを変更した結果をプロジェクトへ反映してください。

反映すると、これまで出ていたエラーは無くなりプロジェクトをビルドできるようになります。

環境によってはライブラリのバージョンなどが足りずにエラーが出ることがありますが、適宜アップデートを行い、ビルドを通してください。

 

プロジェクトのビルド

まず、実行するプロジェクトを選択します。shellAppSDKSample を選択してください。

実行、もしくはデバッグボタンをクリックして実行してください。

Android 実機を USB 接続したまま実行ボタンをクリックすると、端末選択画面が表示されます。選択して「OK」ボタンをクリックすることで端末上で実行が可能です。

実機上でサンプルが実行されますので、「login/connect」ボタンをクリックしてログインなどを行ってみてください。

本サンプルは Shell App SDK を使ったテンプレートとして活用いただける形になっていますので、このテンプレートプロジェクトを改造して、Shell App SDK を用いたアプリを作成してみてください。また、バックボタン、リロードボタン、メニューボタンが実装されていますが、メニューボタンはjavascript:app.menu.toggle()をブリッジで呼び出す実装になっています。サーバーサイドのサンプルとあわせて実装方法を確認してみてください。

更新履歴

  • 2018/12/06
    • AAPT2 禁止解除に伴い、記載を削除
  • 2018/11/30
    • 新規作成

 

 

 

 

 

PREVIOUS

テンプレートの利用による Shell App SDK for Android の組み込み (Android Studio)

NEXT

Remote Notification の組み込み