Unity プロジェクトに Firebase を追加する

Firebase Unity SDK を使用して Unity ゲームをパワーアップさせることができます。

Unity プロジェクトに Firebase を簡単に組み込めることを示すために、サンプルゲーム「MechaHamster」を作成しました。このゲームは、GitHub、App Store、Google Play ストアからダウンロードできます。

MechaHamster（GitHub）

MechaHamster（App Store）

MechaHamster（Play ストア）

Firebase でゲームをパワーアップする方法の詳細については、Firebase のゲームのページをご覧ください。

Unity プロジェクトに Firebase を追加済みの場合は、Firebase Unity SDK の最新バージョンを使用していることを確認します。

前提条件

Unity 2018.4 以降をインストールします。これより前のバージョンも互換性がある可能性がありますが、積極的にはサポートされません。Unity 2018.4 のサポートは非推奨とみなされており、次のメジャーリリース以後は積極的にサポートされなくなります。
（iOS のみ）以下をインストールします。
- Xcode 13.3.1 以降
- CocoaPods 1.10.0 以降
Unity プロジェクトが次の要件を満たしていることを確認します。
- iOS の場合 - ターゲットが iOS 10 以降であること
- Android の場合 - ターゲットが API レベル 19（KitKat）以降であること
  
  注: Unity 2017 または 2018 を使用して Android ビルドを実行すると「Error while dexing」というエラーが発生する場合は、よくある質問で回避策を確認してください。

実機を設定するか、エミュレータを使用してアプリを実行します。
- iOS の場合 - 物理的 iOS デバイスをセットアップするか、iOS シミュレータを使用します。
  Cloud Messaging を使用しますか？
  iOS の Cloud Messaging を使用する場合の前提条件は次のとおりです。
  - 物理 iOS デバイスを設定します。
  - Apple Developer アカウントの Apple Push Notification Authentication Key を取得します。
  - プッシュ通知を XCode の [App] > [Capabilities] で有効にします。
- Android の場合 - エミュレータでは Google Play のエミュレータイメージを使用する必要があります。

Google アカウントを使用して Firebase にログインします。

Unity プロジェクトがまだない方で Firebase プロダクトを試してみたい場合は、クイックスタートサンプルをダウンロードしてください。

ステップ 1: Firebase プロジェクトを作成する

Unity プロジェクトに Firebase を追加する前に、Unity プロジェクトに接続するための Firebase プロジェクトを作成する必要があります。Firebase プロジェクトの詳細については、Firebase プロジェクトについて理解するをご覧ください。

Firebase プロジェクトを作成する

Firebase コンソールで [プロジェクトを追加] をクリックします。
- Firebase リソースを既存の Google Cloud プロジェクトに追加するには、そのプロジェクト名を入力するか、プルダウンメニューから選択します。
- 新しいプロジェクトを作成するには、目的のプロジェクト名を入力します。必要に応じて、プロジェクト名の下に表示されるプロジェクト ID を編集することもできます。
  
  指定した名前に基づいて Firebase プロジェクトの一意の ID が生成されます。このプロジェクト ID を編集したい場合は、この時点で行う必要があります。プロジェクトのリソースがプロビジョニングされた後でプロジェクト ID を変更することはできません。Firebase がプロジェクト ID を使用する仕組みについては、Firebase プロジェクトについて理解するをご覧ください。
Firebase の利用規約が表示されたら、内容を読み、同意します。
[続行] をクリックします。

（省略可）プロジェクトに対し Google アナリティクスを設定します。これにより、次の Firebase プロダクトを使用して最適なエクスペリエンスを実現できます。

既存の Google アナリティクスアカウントを選択するか、新しいアカウントを作成します。

新しいアカウントを作成する場合は、アナリティクスレポートのロケーションを選択し、プロジェクトのデータ共有設定と Google アナリティクスの規約に同意します。

[プロジェクトを作成]（既存の Google Cloud プロジェクトを使用する場合は [Firebase を追加]）をクリックします。

Firebase プロジェクトのリソースが自動的にプロビジョニングされます。処理が完了すると、Firebase コンソールに Firebase プロジェクトの概要ページが表示されます。

ステップ 2: アプリを Firebase に登録する

Firebase プロジェクトに接続するアプリやゲームを登録できます。

Firebase コンソールに移動します。
プロジェクトの概要ページの中央で、Unity アイコン（）をクリックして設定ワークフローを起動します。

すでに Firebase プロジェクトにアプリを追加している場合は、[アプリを追加] をクリックするとプラットフォームのオプションが表示されます。
登録する Unity プロジェクトのビルドターゲットを選択するか、両方のターゲットを同時に登録することもできます。
注: 現在、Unity プロジェクトのビルドターゲットを 1 つだけ登録している場合は、後から設定ワークフローに戻って他のビルドターゲットを登録できます。
Unity プロジェクトのプラットフォーム固有の ID を入力します。
- iOS の場合 - Unity プロジェクトの iOS ID を [iOS バンドル ID] に入力します。
- Android の場合 - Unity プロジェクトの Android ID を [Android パッケージ名] に入力します。「パッケージ名」と「アプリケーション ID」は、しばしば同じ意味で使用されます。
Unity プロジェクトの ID はどこで確認できますか？
Unity IDE で Unity プロジェクトを開き、各プラットフォームの設定セクションに移動します。
- iOS の場合 - [Build Settings] > [iOS] に移動します。
- Android の場合 - [Android] > [Player Settings] > [Other Settings] に移動します。
Unity プロジェクトの ID はバンドル ID の値です（ID の例: com.yourcompany.yourproject）。
プロジェクトが実際に使用している ID を入力してください。ID 値は大文字と小文字が区別され、Firebase プロジェクトに登録された後はそれらの Firebase アプリに固定となり変更できません。
（省略可）Unity プロジェクトのプラットフォーム固有のニックネームを入力します。
これらのニックネームは内部用の便宜的な ID であり、Firebase コンソールにのみ表示されます。
[アプリの登録] をクリックします。

ステップ 3: Firebase 構成ファイルを追加する

Firebase コンソールの設定ワークフローでプラットフォーム固有の Firebase 構成ファイルを取得します。
Unity プロジェクトで iOS と Android の両方のビルドターゲットを登録する場合は、両方のプラットフォームの構成ファイルをダウンロードして追加する必要があります。
- iOS の場合 - [GoogleService-Info.plist をダウンロード] をクリックします。
- Android の場合 - [google-services.json をダウンロード] をクリックします。
この構成ファイルについて知っておくべきことは何ですか？
- Firebase 構成ファイルには、プロジェクト用の機密ではない一意の識別子が含まれています。この構成ファイルの詳細については、Firebase プロジェクトについて理解するをご覧ください。
- Firebase 構成ファイルはいつでも再ダウンロードできます。
- 構成ファイル名に (2) などの文字が追加されていないことを確認します。
Unity プロジェクトで [Project] ウィンドウを開き、構成ファイルを Assets フォルダに移動します。
Firebase コンソールの設定ワークフローに戻り、[次へ] をクリックします。

ステップ 4: Firebase Unity SDK を追加する

Firebase コンソールで [Firebase Unity SDK をダウンロード] をクリックし、適切な場所で SDK を解凍します。
- Firebase Unity SDK はいつでも再ダウンロードできます。
- Firebase Unity SDK はプラットフォーム固有ではありません。
開いている Unity プロジェクトで、[Assets] > [Import Package] > [Custom Package] を選択します。
解凍した SDK から、アプリで使用するサポートされている Firebase プロダクトを選択します。
アナリティクスが有効な場合
- Google アナリティクス用の Firebase パッケージを追加: FirebaseAnalytics.unitypackage
- アプリで使用する Firebase プロダクトのパッケージを追加します。たとえば、Firebase Authentication と Firebase Realtime Database を使用する場合:
  FirebaseAuth.unitypackage および FirebaseDatabase.unitypackage を追加します。
アナリティクスが無効な場合
アプリで使用する Firebase プロダクトのパッケージを追加します。たとえば、Firebase Authentication と Firebase Realtime Database を使用する場合:
FirebaseAuth.unitypackage および FirebaseDatabase.unitypackage を追加します。
Unity 5.x 以前では .NET 3.x フレームワークを使用しているため、dotnet3/ パッケージをインポートします。

Unity 2017.x 以降では、.NET 4.x フレームワークを使用できます。Unity プロジェクトで .NET 4.x を使用している場合は、dotnet4/ パッケージをインポートします。

Unity 2019 以降では .NET 3.x フレームワークがサポートされないため、dotnet4/ パッケージをインポートします。
[Import Unity Package] ウィンドウで [Import] をクリックします。
Firebase コンソールの設定ワークフローに戻り、[次へ] をクリックします。

ステップ 5: Google Play 開発者サービスの要件を確認する

Android 向け Firebase Unity SDK を使用するには、最新の Google Play 開発者サービスが必要です。

アプリケーションの先頭に次のコードを追加します。SDK で他のメソッドを呼び出す前に Google Play 開発者サービスを確認し、必要であれば、Firebase Unity SDK で必要とされるバージョンに更新します。

Firebase.FirebaseApp.CheckAndFixDependenciesAsync().ContinueWith(task => {
  var dependencyStatus = task.Result;
  if (dependencyStatus == Firebase.DependencyStatus.Available) {
    // Create and hold a reference to your FirebaseApp,
    // where app is a Firebase.FirebaseApp property of your application class.
       app = Firebase.FirebaseApp.DefaultInstance;

    // Set a flag here to indicate whether Firebase is ready to use by your app.
  } else {
    UnityEngine.Debug.LogError(System.String.Format(
      "Could not resolve all Firebase dependencies: {0}", dependencyStatus));
    // Firebase Unity SDK is not safe to use here.
  }
});

これで設定は完了です。Unity プロジェクトは Firebase を使用するように登録、構成されました。

設定で問題がある場合は、Unity のトラブルシューティングとよくある質問をご覧ください。

デスクトップワークフローを設定する（ベータ版）

ゲームを作成する場合、Unity エディタやデスクトッププラットフォームでまずゲームをテストしてから、開発の後の段階でモバイルデバイスにデプロイしてテストする方が簡単なことが良くあります。このワークフローをサポートするために、Windows、macOS、Linux、および Unity エディタ内で実行できる Firebase Unity SDK のサブセットが用意されています。

モバイルプラットフォームの場合と同じ手順に沿って、デスクトッププラットフォームの Unity プロジェクトを設定します（上記のアプリを Firebase プロジェクトに登録するから開始）。
Unity IDE で Unity プロジェクトを実行するか、デスクトップ用に Unity プロジェクトをビルドします。

注: Firebase は Unity プロジェクトに追加したモバイル Firebase 構成ファイル（GoogleService-Info.plist または google-services.json）を検索します。次に、モバイル構成ファイルからデスクトップ Firebase 構成ファイル（google-services-desktop.json）を自動的に生成します。
このデスクトップ構成ファイルには、Firebase コンソールの設定ワークフローで入力した Unity プロジェクト ID が含まれています。このファイルが、アプリと Firebase プロジェクトを関連付けます。
（省略可）Unity プロジェクトを編集モードで実行します。

Firebase Unity SDK は Unity の編集モードでも実行できるため、エディタのプラグインで使用できます。
1. エディタで使用される FirebaseApp を作成する場合、デフォルトのインスタンスは使用しません。
2. 代わりに FirebaseApp.Create() 呼び出しに対して一意の名前を指定します。
  
  Unity IDE で使用されるインスタンスと Unity プロジェクトで使用されるインスタンスの間のオプションの競合を避けるために、この操作は重要です。

サポートされている Firebase プロダクト

Unity Firebase ライブラリの詳細については、リファレンスドキュメントをご覧ください。

iOS および Android の Firebase Unity SDK では、次の Firebase プロダクトがサポートされています。

Firebase プロダクト	Unity パッケージ
AdMob	AdMob Unity プラグインで個別に配信
アナリティクス	`FirebaseAnalytics.unitypackage`
Authentication	`FirebaseAuth.unitypackage`
Cloud Firestore	`FirebaseFirestore.unitypackage`
Cloud Functions	`FirebaseFunctions.unitypackage`
Cloud Messaging	`FirebaseMessaging.unitypackage` （推奨）`FirebaseAnalytics.unitypackage`
Cloud Storage	`FirebaseStorage.unitypackage`
Crashlytics	`FirebaseCrashlytics.unitypackage` （推奨）`FirebaseAnalytics.unitypackage`
Dynamic Links	`FirebaseDynamicLinks.unitypackage` （推奨）`FirebaseAnalytics.unitypackage`
Realtime Database	`FirebaseDatabase.unitypackage`
Remote Config	`FirebaseRemoteConfig.unitypackage` （推奨）`FirebaseAnalytics.unitypackage`

サポートされている Firebase プロダクト（デスクトップ）

Firebase Unity SDK にはプロダクトのサブセットに対するデスクトップワークフローのサポートが含まれているため、Firebase の特定の部分を Unity エディタや、Windows、macOS、Linux のスタンドアロンデスクトップビルドで使用できます。

Firebase プロダクト（デスクトップ）	Unity パッケージ
Authentication	`FirebaseAuth.unitypackage`
Cloud Functions	`FirebaseFunctions.unitypackage`
Cloud Firestore	`FirebaseFirestore.unitypackage`
Cloud Storage	`FirebaseStorage.unitypackage`
Realtime Database	`FirebaseDatabase.unitypackage`
Remote Config	`FirebaseRemoteConfig.unitypackage`

Firebase では残りのデスクトップライブラリはスタブ（非機能的）実装であり、Windows、macOS、Linux 向けのビルドを便利にするために提供されています。このため、デスクトップを対象としてコードを条件付きでコンパイルする必要はありません。

次のステップ

Firebase アプリのサンプルを確認する。
アプリを起動する準備をする。
- Google Cloud コンソールでプロジェクトの予算アラートを設定する。
- Firebase コンソールの [使用量と請求額] ダッシュボードをモニタリングして、複数の Firebase サービスにまたがるプロジェクトの全体的な使用状況を確認する。
- Firebase リリースチェックリストを確認する。
Firebase や Unity プロジェクトでお困りの場合は、Unity のトラブルシューティングとよくある質問をご覧ください。