• 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」より、現状の設定内容を確認できます。

     

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

  • APNs証明書(p8形式)の発行方法

    1. 証明書の作成(iOS dev center)

    (1)ブラウザを起動(ブラウザはsafariが推奨されます)

    (2)https://developer.apple.com/ にアクセスし「Account」へ

    (3)iOS dev center にログインします

    ※2段階認証が必要な場合がありますのでご注意ください。

     

    (4)Certificates, IDs & Profiles > Keys ページに移動し、Keyを追加するため、プラスボタンを押してください。

     

    __________2021-04-12_17.32.41.png

     

    (5)Apple Push Notifications service (APNs)にチェックをいれ、Keyに任意の名前を記入後、「Continue」を押してください。

     

    mceclip1.png

     

    (6)以下確認画面が表示されますので、問題がなければ「Register」を押してp8形式の証明書を発行してください。

    mceclip2.png

     

    (7)p8形式の証明書をダウンロード可能となっているので、「Download」をクリックして下さい。

    ※下部に表示されている「KEY ID」はFANSHIP管理画面に登録する際に必要となります。

     

    (8)FANSHIP管理画面に作成した証明書を登録します。

    登録方法は、「APNs証明書・FCMサーバーキー管理画面への登録」を参照してください。

     

     

    ※注意事項
    p8形式を使用すると、Apple developer accoutに紐づく
    p8ファイル(キー)とBundle IDsが一致するアプリ
    にプッシュ通知を送信できる状態になりますのでご注意ください。

     

  • APNs証明書(p12形式)の更新方法

    APNs証明書(p12形式)の有効期限は1年間であるため、毎年更新(再作成・差替え)が必要となります。
    更新方法を以下の順で説明します。

    1. 新しい証明書の要求(キーチェーンアクセス)
    2. 証明書の作成(iOS dev center)
    3. 証明書と鍵の書き出し(キーチェーンアクセス)

     

    1.新しい証明書の要求(キーチェーンアクセス)

    MacOSのパソコンで作業してください。

    (1)アプリケーションからキーチェーンアクセスを起動してください。
    キーチェーンアクセス >証明書アシスタント > 認証局に証明書を要求 1.png

     

    (2)証明書情報を入力して「続ける」をクリックしてください。

    2.png

     

    ユーザーのメールアドレス iOS Dev Centerに登録したメールアドレス
    通称 iOS Dev Centerに登録した名前
    CAのメールアドレス 空白
    要求の処理 「ディスクに保存」、「鍵ペア情報を指定」にチェック


    (3)証明書の要求ファイル(CSR)の保存ダイアログが表示されるので任意の場所に保存してください。

    (4)鍵ペア情報はデフォルトのまま「続ける」をクリックしてください。

    3.png

     

    (5) 「完了」をクリックし完了してください。

    4.png


    2. 証明書の作成(iOS dev center)

    (1)ブラウザを起動(ブラウザはsafariが推奨されます)

    (2)https://developer.apple.com/ にアクセスし「Account」へ

    (3)iOS dev center にログインします

    ※2段階認証が必要な場合がありますのでご注意ください。

     

    (4)「Certificates,Identifies & Profiles」のIdentifiersにて、該当のIDをクリックします。

    5.png

     

    (5)「Push Notifications」を選択後、「Edit」で次へ進みます。

    6.png


    (6)「Apple Push Notfication service SSL Certificates」内に 「Development SSL Certificate」、「Production SSL Certificate」のボックスがそれぞれあるので証明書を作成したい方のボックス内の「Create Certificate」クリックします。

    • Production(本番用)、Development(開発用)共に、現在の証明書が有効なまま、追加で作成が可能です。
    • 本番環境の有効期限切れ対応の場合、Developmentの証明書は不要です。必要になった段階で、作成ください。

    7.png

     

    (7)「Choose File」に保存したCSR(CertificateSigningRequest)を指定し、Continue」で次へ進みます。

    8.png

     

    (8)証明書の日付が約1年後になっているものを「Download」ボタンで保存し、完了です。

    9.png

     

    3. 証明書と鍵の書き出し(キーチェーンアクセス)

    (1)保存した証明書をダブルクリックしてください。

    (2)キーチェーンに証明書が追加されたことを確認してください。

    (3)キーチェーンの分類「自分の証明書」の Apple Production(開発用はDevelopment)OS Push Serverを選択してください。

    (4)メニュー「ファイル」→「書き出す…」をクリックしてください

    10.png

     

    (5)「名前」を入力し、「フォーマット」に「個人情報交換(.p12)」を選択し「保存」をクリックします。

    11.png

     

    (6)パスワードを入力した場合は、FANSHIP 管理画面登録時に必要となります。※空欄のままでも次へ進めます。

    12.png

     

    ※以下のような証明書を書き出すためのパスワードの確認画面が表示された場合、Macへログインするパスワードを入力してください。

    13.png

     

    作成した証明書を FANSHIP 管理画面へ登録して更新作業は完了となります。

    登録方法は、「APNs証明書・FCMサーバーキー管理画面への登録」を参照してください。

     

     

  • APNs証明書の作成方法

    APNs証明書の作成手順について説明します。

     作成手順は以下です。

     

    1.Apple Developer Programの登録

    証明書の取得には必須となりますので、こちらからご登録ください。(有償:$99/年)

     

    2.新しい証明書の要求(キーチェーンアクセス)

    こちらをご参照ください。

     

    3.開発用証明書の作成

     https://developer.apple.com/ の、「Certificates, Identifiers & Profiles」>「Certificates」>「All」から開発用証明書を作成します。

     

    4.AppIDの作成

    こちらをご参照ください。

     

    5. Deviceの登録

    https://developer.apple.com/ の、「Devices」>「All」から端末の「Name」と「UUID」を登録します。

     

    6. プロビショニングプロファイルの作成

    https://developer.apple.com/

     

    • 「Provisioning Profiles」>「All」から、右上の「+」をクリック
    • 利用する App ID、開発用証明書、端末を紐付けてください
    • 「Development」から「iOS App Development」を選択し、「Continue」をクリックします
    • 4.で作成した App ID を選択し、「Continue」をクリックします
    • 開発用証明書 を選択し、「Continue」をクリックします
    • 5で登録したものか既存の端末を選択し、「Continue」をクリックします
    • 「Profile Name」にファイル名を入力します
    • 確認し「Continue」をクリックします
    • プロビショニングプロファイルを「Download」をクリックして書き出します
    • 「Done」をクリックしますして完了です。

    7.証明書の作成

    p12形式の場合、こちらをご参照ください。

    p8形式の場合、こちらをご参照ください。

     

    8.証明書と鍵の書き出し(キーチェーンアクセス)

    こちらをご参照ください。

  • AppIDの作成方法

    AppIDの作成方法を説明します。

     

    AppIDの作成

    (1)ブラウザを起動(ブラウザはsafariが推奨されます)

    (2)https://developer.apple.com/ にアクセスし「Account」へ

    (3)iOS dev center にログインします

    (4)「Certificates, Identifiers & Profiles」をクリックします

    (5)「Identifiers」の「App IDs」をクリックして、右上の「+」をクリックします

    mceclip0.png

    (6)App ID Description」の「Name」を記入します

    mceclip1.png

    (7)「App ID Suffix」は「Explicit App ID」を選択します。

      「Bundle ID」を入力します

    mceclip2.png

    (8)「App Services」の「Push Notifications」にチェックを入れ、「Continue」で次に進んでください。

    mceclip4.png

     

     

     

  • FCMサーバーキー取得方法

    ※Cloud Messaging API(Legacy HTTP API)は2024年6月20日をもって廃止され、FCMサーバーキーは使用できなくなります。
    Legacy HTTP API をご利用のお客様は、2024年6月20日までにFirebase Cloud Messaging API(HTTP v1 API)の設定をお願いします。設定手順はこちらをご確認ください。

     

    Android SDKで利用するFCM サーバーキーの設定方法は以下の通りです。
    ※2022年10月時点のものとなり、変更になる場合がございますのでご了承ください

    1. Firebase Console へログイン
    2. プロジェクトの作成
    3. サーバーキーの取得

     

    1.Firebase Console へログインします
    https://console.firebase.google.com

     

     2. プロジェクトを作成します

    ①「プロジェクトを作成」または「プロジェクトを追加」をクリックします。

    mceclip0.png

    ②プロジェクト名を付け、「続行」をクリック。

    その後も表示される手順に従い、設定を行います。

    1.png
    ③プロジェクトを作成できると以下のような画面が表示されるので、「続行」をクリック。

    4.png

     

    3. サーバーキーを取得します

    ①作成したプロジェクト名の右横の歯車のアイコンをクリックし「プロジェクトの設定」を選択します。

    2022-10-13_12h58_43.png

    ②「Cloud Messaging」タブを選択後、「Cloud Messaging API(レガシー)」から「Google Cloud ConsoleでAPIを管理」をクリック。

    2022-10-06_15h24_15.png

    ③遷移した画面先で、「Cloud Messaging」の「有効にする」をクリック

    2022-10-06_15h24_37.png

    ④②の「Cloud Messaging」タブに戻るとサーバーキーが表示されます。 2022-10-06_15h25_28.png

     

    ⑤④で取得したサーバーキーをコピーし、FANSHIP管理画面へ登録します。
    登録方法は、「APNs証明書・FCMサーバーキー管理画面への登録」を参照してください。

  • FCMサーバーキー取得方法(既存プロジェクトが存在する場合)

    プッシュ通知以外で、Firebaseを利用していた場合のFCMサーバーキーの取得方法は以下の通りです。

    ※2019年3月時点のものとなり、変更になる場合がございますのでご了承ください

     

    1.Firebase Consoleへログインします

    https://console.firebase.google.com

     

    2.対象プロジェクトを選択します

     ①対象プロジェクトを選択します。

    ②プロジェクト名の右横の歯車のアイコンをクリックし「プロジェクトの設定」を選択します。

    ③「クラウドメッセージング」を選択します。

    ④サーバーキーをコピーして管理画面へ登録します。
    登録方法は、「APNs証明書・FCMサーバーキー管理画面への登録」を参照してください。

    ⑤GCMのサーバーキーが表示されます。
    現在のサーバーキーかご確認ください。

  • APNs証明書・FCMサーバーキー管理画面への登録

    APNs証明書、FCMサーバーキーの取得が完了したら、FANSHIP へ登録を実施してください。

    1. APNs証明書管理画面への登録
    2. FCMサーバーキー管理画面への登録

    ※証明書・サーバーキー登録前にプッシュ通知の登録を行うと、証明書・サーバーキー登録した際、
    登録しているプッシュ通知が自動的に配信されますので、ご注意ください。

     

    APNs証明書管理画面への登録

    (1)管理画面にログインします。

    (2)設定 > プッシュ通知設定 > iOS設定

    (3) p12証明書の場合

    • p12ファイルを選択
    • APNsサーバー種別(Production または Development)を選択
    • こちらで作成したp12証明書ファイルを選択しアップロード
    • 上記で作成時に設定した、証明書のパスワードを入力
      上書きする」をクリック

    mceclip4.png

     

    (4) p8証明書の場合

    • p8ファイルを選択
    • APNsサーバー種別(Production または Development)を選択
    • こちらで作成したp8証明書ファイルを選択しアップロード
    • Key IDを入力
      • p8証明書ダウンロード画面の、下部に記載されているKey IDを入力してください。
    • Team IDを入力
    • Bundle ID(App用)を入力
      • アプリのBundleIDを指定してください。Xcodeに記載されています。
    • Bundle ID(Appclip用)を入力(任意)
      • Appclipを使用する場合、Appclip用のBundleIDを指定してください。必須ではありません。

     「上書きをする」をクリック

    mceclip3.png

     

     

    FCMサーバーキー管理画面への登録

    (1)管理画面へログインします。

    (2)設定 > プッシュ通知設定 > Android設定

    (3)「FCMサーバーキー」の入力欄に、サーバーキーを入力し、「上書きする」ボタンを押下します。

    ※通常、一度設定したサーバーキーは変更する必要はありません。
     初期設定時に間違えたキーを設定してしまったなど特殊な場合に限られます。

     

     

     

     

  • Firebase への移行

    Android アプリへの FANSHIP からのプッシュ配信は、

    1. Google Developers Console での GCM 有効化・API key 等の取得
    2. FANSHIP 管理画面に取得した API key 情報を登録


    という方法で導入していただいておりましたが、Google Developers Console からの API key の取得が行えなくなっており、今後はFirebase Console をご利用いただく形になります。

    また、Google Developers Console ではFCM サーバーキーを取得できませんので、FCM 対応のSDK に差
    替えを実施する場合は、必ずGCM からFCM(Firebase Cloud Messaging)への移行を行ってください。

     

     

    以降方法は以下の通りです。
    ※2018年9月時点のものとなり、変更になる場合がございますのでご了承ください

    1.  Firebase Console へログイン
    2. プロジェクトを移行


    1.Firebase Console へログインします。

     https://console.firebase.google.com

     

     2. プロジェクトを移行します。

    ①「プロジェクトを追加」をクリックします。

     

    ②プロジェクト名をクリックし、GCMから移行したいプロジェクト名を選択します。

    ③国/地域を選択します。

    ④チェック項目を確認(右下の次へで詳細設定も可能)し、「Firebaseを追加」をクリックします。

    ⑤FCMサーバーの取得は「FCMサーバーキー取得方法」を参照してください。