【Unity】Firebase のプッシュ通知と FantomPlugin の共存（Firebase と他のプラグインの共存方法）

2019/02/25 Mon [edit]

　ちょっと最近 VRM Live Viewer に構いっきりで(笑)、FantomPlugin の更新の方が滞っているのだが、Android 8.0 以降では通知システムも変わってしまったので、試しに Firebase のプッシュ通知をオーバーライドできるかやってみた。結果はそれほど難しく無く可能だったので、細かい部分はカスタマイズした方が良いと思うが、導入もできると思う。あくまで簡単な例となるが、FantomPlugin と Firebase の共存の方法を提供しておこう。

　ただ、この機能は Unity2018.2.x 以降のプロジェクト内で Java をプラグインとして扱えるようになったおかげで使えるようになったものなので、必要であれば、以下の記事も参照して欲しい。

・【Unity】【C#】プロジェクト内で Android(Java)プラグインをビルドする

■プラグインの導入
　●Firebase SDK のインポート
　●FantomPlugin のインポート
■FantomPlugin オーバーライド用 Acrivity の導入
■Firebase の準備
■アプリをビルドする
■Firebase からプッシュ通知を送る

(※) Unity2018.3.5f1 (Unity 2018.2 以降) / Firebase SDK 5.5.0 / Windows10(x64) で確認

■プラグインの導入

　大まかには Firebase SDK と FantomPlugin の２つを用意することになる。といっても、ここではオーバーライドするプラグインの例に FantomPlugin を使っているというだけで、考え方さえわかれば、他のプラグインに Firebase を利用することも可能だろう。

●Firebase SDK のインポート（掲載時点 SDK ver.5.5.0）

　Firebase のプッシュ通知を利用するには、公式から配布されている Unity 用のパッケージを導入する必要がある。以下のページに「SDK をダウンロード」というボタンがあるので、クリックして zip をダウンロード→解凍して欲しい。

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

　zip を解凍すると、「dotnet4」というフォルダがあるので、その中から「FirebaseMessaging.unitypackage」をインポートしよう。これには Firebase からプッシュ通知を受け取るアクティビティやマニフェストファイル、API などが含まれている。初回のインポートでは依存関係のライブラリを自動導入するので、結構時間かかるかも知れない（※Build Target が Android になってない場合はここでやっておくと良い）。また、「dotnet3」にも同じものが入っているが、これは .NET 3.x 時代のもので、Unity2018 ではデフォルトで .NET 4.x となっているので、ここでは不要だ。

　Resolver（依存関係の解決）が終わったら、大量のファイルが「Assets/Plugins/Android」に配置されていると思う。Firebase を既存のプロジェクトに使うだけなら、ここにある「AndroidManifest.xml」はあまりいじる必要はないが（だいたい自動でやってくれる）。他のプラグインと共存するには少し手を加える必要がある。その辺りは後で説明しよう。

●FantomPlugin のインポート

　とりあえず今回はアセットストア版の「FantomPlugin (Android Native Dialogs and Functions Plugin)」（※長いので略してるだけ(笑)）を使って説明しよう。Google Drive 版を使っている人でも基本的には同じなので、パス名などを置き換えてもらえばできると思う。

　より詳しいセットアップは「AssetStore版 FantomPlugin のセットアップ」の記事にも書いてあるが、簡単な方法としてはエディタ上で [Ctrl+9] でアセットストアを開き「Android Native Dialogs and Functions Plugin」を検索すれば、すぐに出てくると思うので、とりあえずダウンロード→インポートして欲しい。

■FantomPlugin オーバーライド用 Acrivity の導入

　インポートが終わったら、もう１つプロジェクトに追加して欲しいものがある。それは先ほど保留した「AndroidManifest.xml」に関わる問題でもある。というのは Firebase SDK のインポートで作られたマニフェストファイル（AndroidManifest.xml）は Firebase 専用となっている。この辺りの説明は少し難しくなってしまうのだが、なるべく簡単に説明すると、この「Firebase 専用のものをオーバーライドすることにより、他のプラグインの機能を共存してしまおう」ということだ。そのオーバーライドするのに必要な Activity を用意した。そのうち、アセットストア版にも出すつもりだが、とりあえずは先行配布としてこれを使って欲しい。

＞＞FantomPlugin オーバーライド用 Activity をダウンロード

　ダウンロードして zip を解凍すると「Firebase」フォルダに「OverrideFantomPluginOnFirebaseMessagingActivity.java」というのが入っていると思う。これは現在使われている「FantomPlugin」と同じもので、Unity2018.2 のプラグイン用の Java コードをプロジェクト内でビルドするために作ってみたものだ（内容的にはプラグイン「fantomPlugin.aar」の内部に入ってる「FullPluginOnUnityPlayerActivity」と全く同じ）。

　また、「AndroidManifest_FirebaseMessaging.xml」というのも入っているが、これは Firebase の「AdnroidManifest.xml」に「OverrideFantomPluginOnFirebaseMessagingActivity」をオーバーライドするように修正したものだ。Firebase のデフォルト設定に追加しただけのものなので、必要あれば編集した方が良いかも知れない。

　これらをプロジェクトのプラグインルート「Assets/Plugins/Android/」以下に置いて欲しい。ここに Java ファイルを置いておけば Unity が自動でビルドしてくれる（Build System が「Gradle」のときのみ[※Unity2018 はデフォルト]）。

　また、元の「AndroidManifest.xml」はリネームして「AndroidManifest_old.xml」とでもしておき、「AndroidManifest_FirebaseMessaging.xml」を「AndroidManifest.xml」にリネームすると、オーバーライドが有効になる。

　この辺りの内容は少し難しくなるので、簡単に説明にしておくと、「UnityPlayerActivity（Unity）継承→ MessagingUnityPlayerActivity（Firebase）継承→ OverrideFantomPluginOnFirebaseMessagingActivity（FantomPlugin）」のようにオーバーライドされていることになる（※つまり自作するときは同じように、競合しないようなオーバーライドする Activity を作れば良い）。

　必要なら参考資料を載せておこう。ダウンロードした zip の中の「Default」フォルダがあると思うが、その中にある「OverrideFantomPluginOnUnityPlayerActivity.java」はデフォルトの「UnityPlayerActivity」を継承している。Firebase のオーバーライドと同じように継承するものを変更すれば、他のプラグインもオーバーライドできるかも知れない。

・UnityPlayerActivity Java コードの拡張
・Activity
・アプリマニフェスト

■Firebase の準備

　アプリ方の準備はだいたい終わったので、次のプッシュ通知を送信する Firebase自体をセットアップしよう。

１．Firebase をまだ利用してない人は、まずは登録しよう。といっても Google アカウントを持っていれば、サイトに行けばすぐに新規登録できると思う。登録完了したら、いつでも画面の右上あたりにある「コンソールへ移動」があるので、プロジェクト管理へ移動できる。

２．コンソール（「Firebaseへようこそ」）へ来たら、プッシュ通知を利用するプロジェクトを作成しよう。「＋プロジェクトを追加」を押して、プロジェクト名などを任意に入力し、「プロジェクトを作成」ボタンを押せば良いだけだ。完了したら、プロジェクトへ移動しよう。

３．初回の場合、プロジェクトにはアプリが追加されてないので以下の画面が出ると思う。今回は Android のプラグインをオーバーライドする実験なので、Android のアイコンを押そう。

４．「アプリの登録」の「Android パッケージ名」は Unity の Identification と合わせておく必要がある（※以下のアプリIDは例なので、自分のアプリのIDに置きかえる）。Unity の PlayerSettings（File＞Build Settings...＞Player Settings...＞Other Settings＞Identification）を開いてコピペすると良い。ここが１文字でも間違ってたら、通知は届かないので注意しよう。

●Unity 側

※FantomPlugin を使う場合、Android 4.2 以上にする必要がある。

５．これら Firebase の設定を Unity に認識させるために、設定ファイル「google-services.json」をダウンロードしておく必要がある。このファイルは Unity の Assets 直下に置くことで反映される（ID の紐づけ）。

●Unity 側

６．次の「Firebase SDK の追加」は Unity の場合、自動でやってくれるので必要ない。

7．最後の「アプリを実行してインストールを確認」はスキップしてしまって良いだろう。

■アプリをビルドする

　これまでの準備が整ったらアプリをビルドしてみよう。注意すべき点は、「OverrideFantomPluginOnFirebaseMessagingActivity.java」「AndroidManifest_FirebaseMessaging.xml（AndroidManifest.xml）」「アプリのID（Android パッケージ名/Identification）」「google-services.json」だ。結構大変だが、置く場所なども含めて確認して欲しい。

　確認が取れたら、ビルドするシーンは何でも良いが、FantomPlugin のデモなら、「FantomPlugin/Demo/Scenes/」以下に置いてある。それらを「Build Setting＞Scenes In Buildに追加し、「Player Settings...」で「Minimum API Level」が 4.2 以上（※これは FantomPlugin の仕様。できれば 5.0 以上の方が良いかも知れない）になってればOKだ。ビルドして一度起動してみよう。また、今回は通知を受信する実験をするだけなので、アプリはすぐに終了して構わない。

■Firebase からプッシュ通知を送る

　ここまででの手順が間違ってなければ、既に Firebase からプッシュ通知の送信ができるようになっている。Firebase のコンソールへ行き、左のメニューから「Cloud Messsaging」へ移動しよう。初回なら「Send your first message」のボタンが出るので、それを押すとメッセージを作成することができる。

１．通知の作成画面では任意にテキストを入力して行こう。気をつけて欲しいのは既にリリースされているアプリの場合、適当に入力したものがユーザーに届いてしまうことである。その辺は自己責任で(笑)。

２．一番重要なのは、このターゲットのアプリ（ID）だ。ここを Unity のアプリの Identification と同じにすることによって、そのアプリ用の通知として送られる。間違えないようにしよう（Android / iOS などでも分別できる）。

３．以降の「スケジュール設定」は「Now」（今すぐ）で、「コンバージョンイベント」はデフォルトで良いだろう。「その他のオプション」では「Android 通知チャンネル」という項目があるが、これは Android 8.0 以降の「通知チャンネル」の機能で、通知ごとに種類を分別できるようにするものだ（例えば「お知らせ」とか「更新情報」とか、別々に通知のオン・オフできるようにするため）。Android 8.0 より前の機種では分別はされない。

・Android O(APIバージョン26)のPush通知