Unity を使用して Firebase Cloud Messaging クライアントアプリを設定する

クロスプラットフォーム対応の Firebase Cloud Messaging クライアントアプリを Unity で記述するには、Firebase Cloud Messaging API を使用します。Android と Apple それぞれに必要な設定を追加すれば、両方のプラットフォームで Unity SDK を動作させることができます。

始める前に

前提条件

Unity 2019.1 以降をインストールします。これより前のバージョンも互換性がある可能性がありますが、積極的にはサポートされません。Unity 2019.1 のサポートは非推奨とみなされており、次のメジャーリリース以後は積極的にサポートされなくなります。
（Apple プラットフォームのみ）以下をインストールします。
- Xcode 13.3.1 以降
- CocoaPods 1.10.0 以降
Unity プロジェクトが次の要件を満たしていることを確認します。
- iOS の場合 - ターゲットが iOS 11 以降であること
- tvOS の場合 - ターゲットが tvOS 12 以降であること
- Android の場合 - ターゲットが API レベル 19（KitKat）以降であること

デバイスを設定するか、エミュレータを使用して Unity プロジェクトを実行します。
- iOS または tvOS の場合 - 実機を設定してアプリを実行するか、次の作業を行います。
  - 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 プロダクトを選択します。

Firebase Cloud Messaging のエクスペリエンスを最適化するために、プロジェクトで Google アナリティクスを有効にすることをおすすめします。また、アナリティクスを設定する際に、アナリティクス用の Firebase パッケージをアプリに追加する必要もあります。
アナリティクスが有効な場合
- Google アナリティクス用の Firebase パッケージを追加: FirebaseAnalytics.unitypackage
- Firebase Cloud Messaging 用のパッケージを追加: FirebaseMessaging.unitypackage
アナリティクスが無効な場合
Firebase Cloud Messaging 用のパッケージを追加: FirebaseMessaging.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 を使用するように登録、構成されました。

Apple プラットフォームでプッシュ通知を有効にする

ステップ 1: ユーザー通知フレームワークを追加する

Xcode でプロジェクトをクリックし、編集領域で [General] タブを選択します。
[Linked Frameworks and Libraries] が表示されるまで下にスクロールし、[+] ボタンをクリックしてフレームワークを追加します。
表示されたウィンドウで UserNotifications.framework までスクロールし、そのエントリをクリックしてから [Add] をクリックします。

ステップ 2: プッシュ通知を有効にする

Xcode でプロジェクトをクリックし、編集領域で [Capabilities] タブを選択します。
[Push Notifications] を [On] に切り替えます。
[Background Modes] までスクロールして、[On] に切り替えます。
[Background Modes] の下の [Remote notifications] チェックボックスをオンにします。

Firebase Cloud Messaging を初期化する

Firebase Cloud Message ライブラリは、TokenReceived または MessageReceived イベントのハンドラが追加されるときに初期化されます。

初期化時に、クライアントアプリインスタンス用の登録トークンが要求されます。アプリは OnTokenReceived イベントでトークンを受け取ります。後で使用するためにこれをキャッシュに保存しておく必要があります。このトークンは、この特定のデバイスをメッセージの対象にする場合に必要になります。

さらに、受信メッセージを受信できるようにするには OnMessageReceived イベントに登録する必要があります。

セットアップ全体は次のようになります。

public void Start() {
  Firebase.Messaging.FirebaseMessaging.TokenReceived += OnTokenReceived;
  Firebase.Messaging.FirebaseMessaging.MessageReceived += OnMessageReceived;
}

public void OnTokenReceived(object sender, Firebase.Messaging.TokenReceivedEventArgs token) {
  UnityEngine.Debug.Log("Received Registration Token: " + token.Token);
}

public void OnMessageReceived(object sender, Firebase.Messaging.MessageReceivedEventArgs e) {
  UnityEngine.Debug.Log("Received a new message from: " + e.Message.From);
}

Android エントリポイントアクティビティを構成する

Android では、デフォルトの UnityPlayerActivity に代わるカスタムエントリポイントアクティビティが Firebase Cloud Messaging にバンドルされています。カスタムエントリポイントを使用していない場合、この置換は自動的に行われ、追加の操作を行う必要はありません。デフォルトのエントリポイントアクティビティを使用しないアプリや、独自の Assets/Plugins/AndroidManifest.xml を提供するアプリは、追加の構成が必要になります。

Android 上の Firebase Cloud Messaging Unity プラグインには、次の 2 つの追加のファイルがバンドルされています。

Assets/Plugins/Android/libmessaging_unity_player_activity.jar には、標準の UnityPlayerActivity を置き換える MessagingUnityPlayerActivity という名前のアクティビティが含まれています。
Assets/Plugins/Android/AndroidManifest.xml は、MessagingUnityPlayerActivity をアプリへのエントリポイントとして使用するようアプリに指示します。

これらのファイルは、デフォルトの UnityPlayerActivity により onStop、onRestart のアクティビティのライフサイクルの遷移が処理されていないか、または Firebase Cloud Messaging で受信メッセージを正しく処理するために必要な onNewIntent が実装されていない場合に提供されます。

カスタムエントリポイントアクティビティを構成する

アプリでデフォルトの UnityPlayerActivity を使用しない場合は、提供されている AndroidManifest.xml を削除して、カスタムアクティビティが Android のアクティビティのライフサイクルのすべての遷移を正しく処理できるようにする必要があります（方法については、以下の例をご覧ください）。カスタムアクティビティが UnityPlayerActivity を拡張する場合は、代わりに、必要なすべてのメソッドを実装する com.google.firebase.MessagingUnityPlayerActivity を拡張できます。

カスタムアクティビティを使用していて com.google.firebase.MessagingUnityPlayerActivity を拡張していない場合は、次のスニペットをアクティビティに入れる必要があります。

/**
 * Workaround for when a message is sent containing both a Data and Notification payload.
 *
 * When the app is in the background, if a message with both a data and notification payload is
 * received the data payload is stored on the Intent passed to onNewIntent. By default, that
 * intent does not get set as the Intent that started the app, so when the app comes back online
 * it doesn't see a new FCM message to respond to. As a workaround, we override onNewIntent so
 * that it sends the intent to the MessageForwardingService which forwards the message to the
 * FirebaseMessagingService which in turn sends the message to the application.
 */
@Override
protected void onNewIntent(Intent intent) {
  Intent message = new Intent(this, MessageForwardingService.class);
  message.setAction(MessageForwardingService.ACTION_REMOTE_INTENT);
  message.putExtras(intent);
  message.setData(intent.getData());
  // For older versions of Firebase C++ SDK (< 7.1.0), use `startService`.
  // startService(message);
  MessageForwardingService.enqueueWork(this, message);
}

/**
 * Dispose of the mUnityPlayer when restarting the app.
 *
 * This ensures that when the app starts up again it does not start with stale data.
 */
@Override
protected void onCreate(Bundle savedInstanceState) {
  if (mUnityPlayer != null) {
    mUnityPlayer.quit();
    mUnityPlayer = null;
  }
  super.onCreate(savedInstanceState);
}

Firebase C++ SDK の新しいバージョン（7.1.0 以降）では JobIntentService が使用されるため、AndroidManifest.xml ファイルで追加の変更を行う必要があります。

<service android:name="com.google.firebase.messaging.MessageForwardingService"
     android:permission="android.permission.BIND_JOB_SERVICE"
     android:exported="false" >
</service>

Android でのメッセージ配信に関する注意点

アプリがまったく実行されていないときにユーザーが通知をタップすると、デフォルトでは、メッセージが FCM の組み込みコールバックでルーティングされません。この場合、メッセージペイロードは、アプリの起動に使用される Intent を通じて受信されます。

アプリがバックグラウンドで動作しているときに受信したメッセージでは、通知項目の内容がシステムトレイ通知の入力に使用されますが、その通知内容は FCM に通知されません。つまり、FirebaseMessage.Notification が null になります。

要約:

アプリの状態	通知	データ	両方
フォアグラウンド	`Firebase.Messaging.FirebaseMessaging.MessageReceived`	`Firebase.Messaging.FirebaseMessaging.MessageReceived`	`Firebase.Messaging.FirebaseMessaging.MessageReceived`
バックグラウンド	システムトレイ	`Firebase.Messaging.FirebaseMessaging.MessageReceived`	通知: システムトレイデータ: インテントの追加部分内

自動初期化を禁止する

FCM はモバイルデバイスターゲティング用の登録トークンを生成します。トークンが生成されると、ライブラリによってその ID と構成データが Firebase にアップロードされます。トークンを使用する前に明示的にオプトインする場合は、構成時に FCM（Android ではアナリティクス）を無効にして生成を禁止できます。この操作を Apple で行うには、メタデータ値を Info.plist に追加します（GoogleService-Info.plist ではありません）。Android で行う場合は、メタデータ値を AndroidManifest.xml に追加します。

Android

<?xml version="1.0" encoding="utf-8"?>
<application>
  <meta-data android:name="firebase_messaging_auto_init_enabled"
             android:value="false" />
  <meta-data android:name="firebase_analytics_collection_enabled"
             android:value="false" />
</application>

Swift

FirebaseMessagingAutoInitEnabled = NO

FCM をもう一度有効にするには、ランタイムコールを実行します。

Firebase.Messaging.FirebaseMessaging.TokenRegistrationOnInitEnabled = true;

この値をいったん設定すると、アプリを再起動しても維持されます。

Android でディープリンクを含むメッセージを処理する

FCM では、ディープリンクを含むメッセージをアプリに送信できます。ディープリンクを含むメッセージを受信するには、アプリのディープリンクを処理するアクティビティに新しいインテントフィルタを追加する必要があります。インテントフィルタは、ドメインのディープリンクをキャッチする必要があります。メッセージにディープリンクが含まれていない場合は、この構成を行う必要はありません。AndroidManifest.xml では次のように追加します。

<intent-filter>
  <action android:name="android.intent.action.VIEW"/>
  <category android:name="android.intent.category.DEFAULT"/>
  <category android:name="android.intent.category.BROWSABLE"/>
  <data android:host="CHANGE_THIS_DOMAIN.example.com" android:scheme="http"/>
  <data android:host="CHANGE_THIS_DOMAIN.example.com" android:scheme="https"/>
</intent-filter>

ワイルドカードを指定すると、インテントフィルタをより柔軟に設定できます。次に例を示します。

<intent-filter>
  <action android:name="android.intent.action.VIEW"/>
  <category android:name="android.intent.category.DEFAULT"/>
  <category android:name="android.intent.category.BROWSABLE"/>
  <data android:host="*.example.com" android:scheme="http"/>
  <data android:host="*.example.com" android:scheme="https"/>
</intent-filter>

指定したスキームとホストへのリンクを含む通知がタップされると、アプリがこのインテントフィルタを含むアクティビティを開始し、リンクを処理します。

次のステップ

クライアントアプリを設定したら、Firebase でダウンストリームメッセージやトピックメッセージを送信できる状態になります。詳細については、この機能のクイックスタートサンプルをご覧ください。

その他のより高度な動作をアプリに追加するには、アプリサーバーからのメッセージ送信に関する次のガイドをご覧ください。

これらの機能を利用するには、サーバーの実装が必要です。