メインコンテンツへスキップ

Firebase Cloud Messaging API（HTTP v1 API）設定手順

  • 更新

FANSHIP Android SDK にてプッシュ通知をお届けするために Cloud Messaging API（以下Legacy HTTP API）を使用しておりましたが、先日、Google から Legacy HTTP API を2024年6月20日をもって廃止する旨の発表がありました。

FANSHIPでは、Legacy HTTP APIとFirebase Cloud Messaging API（以下HTTP v1 API）のどちらもサポートしますが、Legacy HTTP APIをご利用中のお客様は、Legacy HTTP API 廃止後にプッシュ通知を送ることが出来なくなる可能性があるため、Legacy HTTP API が廃止される2024年6月20日までに本手順に沿って管理画面から HTTP v1 API の設定をお願いします。

※管理画面をご利用でないお客様は、FANSHIP Management API v3.1 を使用してプロジェクトIDと秘密鍵を設定可能です。手順はこちら。

 

  1. プロジェクトを作成する（プロジェクトがない場合のみ）
  2. プロジェクトIDを確認する
  3. Firebase Cloud Messaging API（V1）が有効になっていることを確認する
  4. 秘密鍵を取得する
  5. 秘密鍵とプロジェクトIDを設定する

 

1. プロジェクトを作成する（プロジェクトがない場合のみ）

Firebase Console へログインし、「プロジェクトを作成」または「プロジェクトを追加」を押下します。

mceclip0.png

プロジェクト名を付け、「続行」を押下します。
その後も表示される手順に従い、設定を行います。

1.png

 

プロジェクトが作成されると以下のような画面が表示されるので、「続行」を押下します。

4.png

 

2. プロジェクトIDを確認する

メニュー「プロジェクトの概要」の右横にある歯車アイコンを押下し、「プロジェクトの設定」を押下します。



開いたページにて、プロジェクトIDを確認することができます。
後の手順で必要となりますので、控えておいてください。



3. Firebase Cloud Messaging API（V1）が有効になっていることを確認する

「Cloud Messaging」タブを押下し、「Firebase Cloud Messaging API（V1）」が有効になっていることを確認します。


FCM HTTP v1 API を利用する場合、事前に Firebase Cloud Messaging API を有効化する必要があります。
有効になっていない場合、Google Developer Consoleから有効化してください。

 

4. 秘密鍵を取得する

「サービスアカウント」タブを開き、「新しい秘密鍵の生成」を押下します。
※選択した言語に応じて構成スニペットの内容が変わりますが、
最終的に生成される秘密鍵は同一のものになるため、言語はどれを選択しても問題ありません。



2. 「キーを生成」を押下すると、秘密鍵（JSONファイル）が生成され、自動でダウンロードされます。
後の手順で必要となりますので、大切に保管しておいてください。



5. 秘密鍵とプロジェクトIDを設定する

管理画面から設定

  1. 管理画面へログイン後、画面右上のログイン中ユーザー名から「基本情報」を押下します。

    管理画面_基本情報.png

  2. 「Android 基本情報」内の「設定を更新する」ボタンを押下します。

    管理画面_Android基本情報.png

  3. 利用するAPIの種別は「HTTP v1」を選択します。
    プロジェクトIDを入力後、秘密鍵ファイルを選択して「上書きする」ボタンを押下すると、完了です。

    管理画面_FCM_HTTPv1.png

FANSHIP Management API v3.1 を使用して設定

「Androidアプリケーションの設定」より、プロジェクトIDと秘密鍵を設定できます。
詳細は FANSHIP Management API v3.1 仕様書 をご参照ください。

また、「基本情報取得API」より、現状の設定内容を確認できます。

 

よくあるお問合せ

切り替え後、プッシュ通知が届きません。

切り替え直後のみ、若干の配信遅延が発生する可能性はありますが、配信が行われないことはありません。
切り替え後は必ずテスト配信を行い、プッシュ通知が届くことをご確認いただきますようお願いいたします。
配信が届かなかった場合、キー自体が正しいことの確認や、以下ガイドもご確認ください。
プッシュ通知が届きません

 

「上書きする」ボタンを押下後、エラーが表示され、切り替えできません。

管理画面にて「上書きする」ボタンを押下後、 Server error occurred. MAPIHTTPError: 403 というエラーが表示される場合、ログイン中のオペレーターの権限が「デフォルトの権限（フルアクセス権限）」以外の「本番配信できない」権限または「自身が配信したもののみ閲覧可」権限である可能性が考えられます。

HTTP v1 API 切り替え作業時は、フルアクセス権限のオペレーターでログインし、作業を行ってください。
フルアクセス権限のオペレーターが分からない場合は、FANSHIPサポートまでお問い合わせください。

オペレーターの権限の詳細については以下ガイドをご確認ください。
ログインIDについて

関連記事