ドキュメント
共通ドキュメント
google-services.jsonとFirebase秘密鍵の設定方法について
Contents |
概要
mobile backend から、Android端末へのプッシュ通知をFCM(Firebase Cloud Messaging)から送信する場合、google-services.jsonとFirebaseの秘密鍵の設定が必要になります。
このドキュメントではこれらを設定する流れについて説明していきます。
ニフクラ mobile backendでの設定
まずは、ニフクラ mobile backendでプッシュ通知の設定を行います。
プッシュ通知の有効化
アプリ設定から、左メニューのプッシュ通知の項目を選択してください。
プッシュ通知の許可設定を行う部分があるので、「許可する」に変更して変更を保存してください。
google-services.jsonを設定
Firebaseのプロジェクトを作成
mobile backendとFCMの連携に必要な設定 を参考にFirebaseのプロジェクトを作成してください。
※既にプッシュ通知機能を利用していて、上記のステップを実施しているユーザーはここをスキップしてください。
Cloud Messagingを有効化
Firebaseのプロジェクトを作成 のステップで作成したプロジェクトのダッシュボードに入ります。その後、ダッシュボード内にある「Cloud Messaging」の「使ってみる」をクリックします。
クリック後、ダッシュボードが「Cloud Messaging」用の画面に変わります。その画面の中の「開始するにはアプリを追加してください」の文章の上にあるAndroidアイコンのボタンをクリックします。
google-services.jsonを発行してアプリに登録
Cloud Messagingを有効化 のステップを最後まで実施すると以下のような画面が出てきます。この画面内でAndroidパッケージやアプリのニックネームなどを入力し、「アプリを登録」をクリックします。
※省略可と書いてあるフォームは必ず入力する必要はありません。
「アプリを登録」クリックすると、以下のような画面が出ます。画面内に出ているステップに従い、google-services.jsonをダウンロードして、Androidアプリ内にgoogle-services.jsonを配置してください。画面内のステップが完了したら「次へ」をクリックします。
「次へ」をクリックすると、以下のような画面が出ます。mobile backendのSDKを使わず、Androidアプリ内でREST APIを用いているユーザーはこの画面内のステップを実施する必要があります。mobile backendのSDKを使用しているユーザーは、2018年8月内にリリースされるFCM対応されたSDKを使用すれば、このステップはスキップして問題ありません。
※FCM対応前のSDKを使用してこの画面内のステップを実施しても、Androidアプリ側ではプッシュ通知は受け取れません。
この画面内の対応が完了したら「次へ」をクリックします。
「次へ」をクリックすると、以下のような画面が出ます。先程までのステップを完了させてアプリを実行しているユーザーはこの画面で確認することができます。まだアプリを実行していないユーザーは「このステップをスキップ」をクリックしても問題ありません。
これでgoogle-services.jsonを発行してアプリに登録するステップは終了です。
Firebaseの秘密鍵をmobile backendに設定
もう一つのステップとしてFirebaseの秘密鍵をmobile backendに設定する必要があります。
Firebaseの秘密鍵のダウンロード
Firebaseのダッシュボードの左上付近の「Project OverView」という文章があります。その横に歯車ボタンがあり、そこにカーソルを合わせると文章が出てきます。その中の「プロジェクトの設定」をクリックします。(①)
クリックするとFirebaseのプロジェクトの設定画面が出てきます。その設定画面の上のメニューの中から「サービスアカウント」をクリックします。(②)
クリックすると以下のような画面が出てきます。この画面の中の「新しい秘密鍵の生成」をクリックして、出てくるモーダルの中の「キーを生成」をクリックします。(③)
そうするとFirebaseの秘密鍵がダウンロードできます。
秘密鍵をmobile backendに設定
mobile backendの管理画面を開きます。右上に「アプリ設定」という文章があるので、そこをクリックします。そうするとアプリ設定の画面が出るので、アプリ設定画面の左側にある「プッシュ通知」をクリックして、プッシュ通知の設定画面を出します。その設定画面の中に、以下の画像のようなAndroidプッシュ通知の設定項目があります。
この設定項目の「プッシュ通知設定ファイルの選択」というボタンをクリックして、先程ダウンロードしたFirebaseの秘密鍵jsonファイルをアップロードします。アップロードが完了すると以下の画像のようになります。
※注意
アップロードするファイルの名前にはルールがありますので、ご注意ください。
詳細は、開発ガイドライン:ファイルストアについてをご参照ください。
これでgoogle-services.jsonとFirebaseの秘密鍵の設定は完了です。
不正な秘密鍵
Firebaseの秘密鍵が不正である場合、プッシュ通知が配信できません。
不正な秘密鍵である原因として、下記事項が考えられます。ご確認ください。
- 秘密鍵がjson形式ファイルでない
- 秘密鍵ファイル内容に、下記内容が含まれていない
- type
- project_id
お探しの内容が見つからなかった場合はユーザーコミュニティ
もご活用ください。(回答保証はいたしかねます)
なお、 Expertプラン以上のお客様はテクニカルサポートにてご質問を承らせて頂きます。
推奨画面サイズ1024×768px以上