サービスアカウントを設定する

Suggest Edits

KARTE のプッシュ通知では、バックエンドに Firebase Cloud Messaging (以下FCM) を使用しています。

🚧

複数のFirebaseプロジェクトの利用に関して

KARTEの管理画面では一つのFirebaseプロジェクトの情報しか登録することができません。
複数のFirebaseプロジェクトの情報を紐付けることはできませんのであらかじめご了承ください。

KARTE から FCM にリクエストを送信できるようにするために、KARTE の管理画面上からサービスアカウントの設定を行います。

KARTE の管理画面のグローバルメニュー[すべてのプロダクト] > [ストア] > [アプリ設定] > [KARTE for App] を開き、下記に沿って設定してください。

  1. ネイティブアプリにおける接客表示制御のデフォルト値
  2. FCM API
  3. FirebaseプロジェクトID（またはFCM サーバーキー）
  4. Firebaseサービスアカウント秘密鍵

1. ネイティブアプリにおける接客表示制御のデフォルト値の設定

接客表示前後に画面境界を認識した際の接客表示を制御するオプションです。

表示を制御する場合はチェックを入れてください。詳細は ネイティブアプリにおける接客表示制御とは をご参照ください。

2. FCM API の設定

FCM HTTP v1 API または FCM Legacy API(非推奨) を選択します。

📘

事前に API の有効化が必要です

FCM HTTP v1 API を利用する場合、事前に Firebase Cloud Messaging API を有効化する必要があります。

有効化は Google Developer Console で行います。
https://console.developers.google.com/apis/api/fcm.googleapis.com/overview

KARTEでは、 FCM HTTP v1 API と FCM Legacy API の2種類のAPIによる送信をサポートしていますが、Google公式アナウンスによると、FCM Legacy APIは2024年6月頃を目処に廃止予定されているため、 FCM HTTP v1 API のご利用を推奨しています。

3. FirebaseプロジェクトID（またはFCM サーバーキー）の設定

FCM HTTP v1 API 利用の場合は、FirebaseプロジェクトIDを設定します

  • Firebase コンソール画面の[プロジェクトの設定] > [全般] で プロジェクトID を確認します。

  • KARTE管理画面の「FirebaseプロジェクトID」に、上記で取得した プロジェクトID を設定します。

FCM Legacy API(非推奨) 利用の場合は、FCM サーバーキーを設定します

  • Firebase コンソール画面の[プロジェクトの設定] > [全般] で サーバーキー を確認します。
  • KARTE管理画面の「FCM サーバーキー」に、上記で取得した サーバーキー を設定します。

4. Firebaseサービスアカウント秘密鍵の設定

  • Firebase コンソール画面の[プロジェクトの設定] > [サービスアカウント] > [Firebase Admin SDK] を選択し、画面下にある 新しい秘密鍵の生成 をクリックし、 秘密鍵 を生成します。

📘

言語の選択について

選択した言語に応じて構成スニペットの内容が変わります。
最終的に生成される秘密鍵は同じものになるため、言語はどれを選択しても問題ありません。

📘

KARTEからのプッシュ通知に必要なFirebaseサービスアカウントの最小権限について

以下になります。設定後、テスト配信のうえの運用開始をお願い致します。

cloudmessaging.messages.create

  • KARTE管理画面上の「Firebaseサービスアカウント秘密鍵」に、上記で生成した 秘密鍵 をアップロードします。

完了したら、 保存 ボタンをクリックして設定は完了です。

Updated about 2 months ago