C++ で Firebase を使ってみる

1. 概要

この Codelab では、Google アナリティクスを例として、サンプル Android ゲームに C++ Firebase Games SDK を統合する方法を学びます。必要な機能を追加したり、プレーヤーの進捗状況を測定するための基本的な分析ロジックを統合したり、テスターとゲームを共有して早期のフィードバックを得たりすることができます。

チュートリアル

この Codelab を作成者と一緒に進めたい場合は、こちらの動画をご覧ください。

学習内容

Android CMake ベースのゲームに Firebase を追加する方法。
必要な C++ 依存関係と Gradle 依存関係を特定する方法。
アナリティクスイベントをログに記録する方法。
分析イベントをデバッグする方法。
App Distribution でゲームを共有する方法。

必要なもの

Android Studio
サンプルコード
Google Play 開発者サービスを備えたテストデバイスまたはエミュレータ

2. サンプルコードを取得する

GitHub からチェックアウトまたはダウンロードします。

git clone https://github.com/FirebaseExtended/cmake-way-for-firebase.git

Firebase SDK をダウンロードする

macOS/Linux:

sh download.sh

Windows（PowerShell から）:

./download.ps1

SDK を手動でダウンロードすることもできます。この場合、Firebase C++ SDK は /third_party に抽出する必要があります。firebase_cpp_sdk という名前のフォルダに、Firebase SDK のルート CMakeLists.txt が含まれるようにします。

3. サンプルゲームを実行する

まず、サンプルゲームをプレイして、すべてが動作することを確認します。手続き型で生成されたレベルと、ジャンプ用のボタンが 1 つだけあるシンプルなエンドレスランナーです。

[File] > [New] > [Import Project] を選択します（または、スプラッシュ画面で [Import Project] を選択します）。
リポジトリに含まれている proj.android/ フォルダを開きます。

[省略可] proj.android/gradle.properties を開き、PROP_APP_ABI を見つけます。ビルド時間を短縮するために、ターゲットアーキテクチャ以外のすべてを削除できます。PROP_APP_ABI=x86 はエミュレータ専用にビルドします。PROP_APP_ABI=armeabi-v7a はほとんどのスマートフォン向けにビルドします。
[デバッグ] ボタンをクリックして、ゲームをビルドして実行します。Cocos2dx ゲームエンジンのビルドには時間がかかります。

4. Firebase コンソールの設定

Firebase コンソールで新しいプロジェクトを作成します。
「Popsicle Runner」などの名前を付けます。
アナリティクスを有効にする
アナリティクスのアカウントを追加または作成する
プロジェクトに新しい Android アプリを追加する
パッケージ名として「com.firebase.popsiclerunner」を追加します。

google-services.json をダウンロードして proj.android/app にコピーします。

Firebase SDK を追加する手順は無視して、[次へ] をクリックします。
インストールを確認するよう求められたら、[このステップをスキップ] をクリックできます。

5. ゲームに Firebase を追加する

CMakeLists.txt に Firebase SDK を追加する

ルートレベルの CMakeLists.txt を開きます。このコードの先頭付近に次のコードがあります。

CMakeLists.txt

add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/third_party/firebase_cpp_sdk)
target_link_libraries(${APP_NAME} firebase_analytics firebase_app)

add_subdirectory には Firebase C++ SDK が含まれており、このゲームで使用できるようになっています

target_link_libraries Android 向けにビルドされた Firebase の C++ ライブラリにゲームをフックします。

Google サービスプラグインを追加する

Firebase SDK をフックするには、gradle ビルドスクリプトに Google サービスプラグインを追加する必要があります。これを行うには、プロジェクトレベルの build.gradle ファイル（proj.android フォルダにあります）を開きます。また、ビルドスクリプトの依存関係として classpath 'com.google.gms:google-services:4.3.3' を追加します。

build.gradle

buildscript {
    repositories {
        google()
        jcenter()
    }

    dependencies {
        classpath 'com.android.tools.build:gradle:4.0.1'

        // NOTE: Do not place your application dependencies here; they belong
        // in the individual module build.gradle files
        classpath 'com.google.gms:google-services:4.3.3'  // Google Services plugin
    }
}

次に、モジュールレベルの build.gradle ファイル（proj.android/app フォルダにあります）にプラグインを追加します。apply plugin: 'com.android.application' の下に apply plugin: 'com.google.gms.google-services' を追加します。

build.gradle

apply plugin: 'com.android.application'
apply plugin: 'com.google.gms.google-services'  // Google Services plugin

Gradle で C++ SDK を見つける

Gradle に Firebase C++ SDK の場所を伝えるには、settings.gradle ファイルの末尾に次の行を追加します。

settings.gradle

gradle.ext.firebase_cpp_sdk_dir = "$settingsDir/../third_party/firebase_cpp_sdk/"
includeBuild "$gradle.ext.firebase_cpp_sdk_dir"

Android の依存関係を追加する

Firebase の Android 依存関係をフックするには、popsicle_runner（proj.android/app/build.gradle 内）のモジュールレベルの Gradle ファイルを開き、末尾の一般的な dependences { セクションの直前に次の行を追加します。

build.gradle

apply from: "$gradle.firebase_cpp_sdk_dir/Android/firebase_dependencies.gradle"
firebaseCpp.dependencies {
    analytics
}

AndroidX と Jetifier

gradle.properties を開き、末尾に以下を追加して、AndroidX と Jetifier のサポートを追加します。

gradle.properties

android.useAndroidX = true
android.enableJetifier = true

ゲームで Firebase を初期化する

Classes/AppDelegate.cpp を開いて、ゲームで Firebase を初期化します。次の #include ディレクティブを先頭に追加します。

AppDelegate.cpp

#include <firebase/app.h>
#include <firebase/analytics.h>

次に、App::Create を追加して、必要な Firebase 機能を初期化します。そのためには、AppDelegate::applicationDidFinishLaunching を検索して、auto scene = MainMenuScene::createScene() の前に次のコードを追加します。

AppDelegate.cpp

{
    using namespace firebase;
    auto app = App::Create(JniHelper::getEnv(), JniHelper::getActivity());
    analytics::Initialize(*app);
}

ゲームをデバッグして Firebase ダッシュボードを更新すると、1 分ほどで新しいユーザーが 1 人表示されます。

6. アナリティクスを追加する

開発の初期段階でも、アナリティクスはベータ版テスターがゲームをどのように利用しているかを測定するのに役立つツールです。定着率レポートなど、自動的に収集される分析情報もありますが、特定のゲームに合わせてカスタムイベントを追加すると便利です。

まず、プレーヤーがレベルを開始したときに分析イベントを記録することをおすすめします。レベル開始イベントの数を使用すると、プレーヤーがセッション内でゲームをリプレイする頻度を把握できます。

また、プレーヤーが死亡したときに、どこまで進んだかを記録するイベントもログに記録します。これにより、変更が 1 回のセッションの長さにどのように影響するかを確認し、プレイヤーが短くて難しいゲームを好むか、長くて簡単なゲームを好むかを判断できます。

アナリティクスのヘッダーを追加する

Classes/PopsicleScene.cpp を開き、Firebase ヘッダーを先頭に追加して、分析呼び出しを行えるようにします。

PopsicleScene.cpp

#include <firebase/analytics.h>
#include <firebase/analytics/event_names.h>

Level Start イベントを記録する

この Scene が Cocos2dx Director によってステージングされたときにイベントをログに記録するには、スタブ関数 PopsicleScene::onEnter() を見つけます。ここに次のコードを入力して、Level Start イベントを記録します。

PopsicleScene.cpp

using namespace firebase;
analytics::LogEvent(analytics::kEventLevelStart);

レベル終了イベントをログに記録する

プレーヤーの進捗状況を確認するため、プレーヤーが死亡したときの進行状況とともにレベル終了イベントを記録しましょう。そのためには、PopsicleScene::gameOver() を見つけて、_gameOver = true; を設定する前に if(!_gameOver) { ブロックの末尾に次のコードを追加します。

PopsicleScene.cpp

{
    using namespace firebase;
    analytics::LogEvent(analytics::kEventLevelEnd, "distance", _lastDistance);
}

kEventLevelEnd はレベル終了イベントです。一方、"distance" は「イベントパラメータ」です。ここでは、最後に記録された距離を追加しています。これは、プレイヤーが死亡するまでに移動した距離を近似するのに適しています。

7. テストイベント

[デバッグ] をクリックできるようになりましたが、イベントがアナリティクスダッシュボードに報告されるまでには時間がかかります。これには 2 つの理由があります。1 つ目は、バッテリーを節約するためにイベントがバッチ処理され、1 時間に 1 回程度アップロードされること、2 つ目は、レポートが 24 時間ごとに生成されることです。

デバッグモードを有効にする

デバイスをデバッグモードにすることで、アナリティクスイベントをデバッグすることは可能です。

まず、Android Debug Bridge（ADB）がインストールされ、セットアップされていることを確認します。adb devices と入力すると、テストするデバイスが表示されます。

$ adb devices
List of devices attached
emulator-5554   device

次の adb shell コマンドを実行します。

adb shell setprop debug.firebase.analytics.app com.firebase.popsiclerunner

これにより、Firebase 向け Google アナリティクスにイベントを直ちに記録するよう指示し、テスト時にライブイベントが汚染されないように、通常のレポートから自動的に除外します。後でこの操作を元に戻す場合は、次のように入力します。

adb shell setprop debug.firebase.analytics.app .none.

イベントの表示

Firebase コンソールで [DebugView] を開きます。

[デバッグ] をクリックしてゲームをプレイします。新しいイベントは、ゲーム内で発生するとほぼ同時に表示されます。

level_end イベントを展開すると、記録したカスタムの「距離」パラメータも表示されます。

8. テスターを見つける

次に、スタジオの内部、親しい友人、コミュニティなど、ゲームをプレイしてもらうユーザーを確保します。Firebase App Distribution を使用すると、プレーヤーをゲームに簡単に招待できます。

スタンドアロンバイナリのビルド

まず、[Build] > [Build Bundles(s) / APK(s)] > [Build APK(s)] から共有するスタンドアロン APK をビルドします。

Android Studio に、ビルドされたファイルの場所を指定できるダイアログボックスが表示されます。見逃した場合は、[イベントログ] をクリックしてリンクを再度取得できます。

Firebase App Distribution にアップロードする

App Distribution を開き、[始める] をクリックします。
[.apk をここにドラッグして新しいリリースを作成します] と表示されているボックスに .apk ファイルをドラッグ＆ドロップします。
最初のテスターとしてメールアドレスを入力します。
[次へ] をクリックします。
説明を追加して [配信] をクリックする

テスターを招待する

メールアドレスを手動で入力する代わりに、招待リンクを作成できます。この招待リンクでユーザーをキャプチャする際に、テスターのグループに追加することもできます。たとえば、内部テスターと外部テスターを分離できます。

[テスターとグループ] をクリックします。
新しいグループを作成し、「Android テスター」などの名前を付けます。
[招待リンク] をクリックします。
[新しい招待リンク] をクリックします。
プルダウンからグループを設定します。
[リンクを作成] をクリックします。
[リンクをコピー] をクリックして、任意の手段で共有します。

9. 完了

C++ ベースのゲームにアナリティクスを追加し、友人を招待してプレイしてもらい、Android 開発で一般的な CMake ベースと Gradle ベースのビルドシステムで Firebase ライブラリを見つけてリンクする方法を学びました。

学習した内容

Android CMake ベースのゲームに Firebase を追加する方法。
必要な C++ 依存関係と Gradle 依存関係を特定する方法。
アナリティクスイベントをログに記録する方法。
分析イベントをデバッグする方法。
App Distribution でゲームを共有する方法。

次のステップ

ユーザーを匿名でログインさせ、ハイスコアを Realtime Database に保存してみましょう。
独自のゲームでアナリティクスイベントをログに記録します。
iOS ゲームにアナリティクスを追加してみましょう。

詳細

ゲーム固有のイベントのリストを確認し、それらがご自身のゲームにどのように適合するかを検討してください。

C++ で Firebase を使ってみる

1. 概要

チュートリアル

学習内容

必要なもの

2. サンプルコードを取得する

Firebase SDK をダウンロードする

3. サンプルゲームを実行する

4. Firebase コンソールの設定

5. ゲームに Firebase を追加する

CMakeLists.txt に Firebase SDK を追加する

Google サービス プラグインを追加する

Gradle で C++ SDK を見つける

Android の依存関係を追加する

AndroidX と Jetifier

ゲームで Firebase を初期化する

6. アナリティクスを追加する

アナリティクスのヘッダーを追加する

Level Start イベントを記録する

レベル終了イベントをログに記録する

7. テストイベント

デバッグモードを有効にする

イベントの表示

8. テスターを見つける

スタンドアロン バイナリのビルド

Firebase App Distribution にアップロードする

テスターを招待する

9. 完了

学習した内容

次のステップ

詳細

Google サービスプラグインを追加する

スタンドアロンバイナリのビルド