iOS アプリにプッシュ通知を追加する

1. はじめに

最終更新日: 2020-1-6

Firebase Cloud Messaging（FCM）は、メッセージを無料で確実に送信するためのクロスプラットフォームメッセージングソリューションです。

FCM を使用すると、同期可能な新しいメールやその他のデータがあることをクライアントアプリに通知できます。通知メッセージを送信することで、ユーザーのリエンゲージメントと維持率の向上につなげることができます。インスタントメッセージなどの用途では、メッセージで最大 4 KB のペイロードをクライアントアプリに転送できます。

仕組み

FCM の実装には、送信と受信のために以下の 2 つの主要コンポーネントが含まれています。

メッセージの作成、ターゲティング、送信を行う Cloud Functions for Firebase やアプリサーバーなどの信頼できる環境。
対応するプラットフォーム固有のトランスポートサービスを介してメッセージを受信する iOS、Android、またはウェブ（JavaScript）クライアントアプリ。

FCM アーキテクチャの概要

FCM は、メッセージの作成、転送、受信を行う次のコンポーネントセットに依存します。

メッセージリクエストを作成または構築するためのツール。Notifications Composer には、通知リクエストを作成するための GUI ベースのオプションが用意されています。すべてのメッセージタイプを完全に自動化してサポートするには、Firebase Admin SDK または FCM サーバープロトコルをサポートする、信頼できるサーバー環境でメッセージリクエストを構築する必要があります。この環境は、Cloud Functions for Firebase、Google App Engine、または独自のアプリサーバーです。
メッセージリクエストを受け入れる機能などが搭載された FCM バックエンドは、トピックを介してメッセージのファンアウトを実行し、メッセージメタデータ（メッセージ ID など）を生成します。
メッセージをターゲットデバイスにルーティングするプラットフォームレベルのトランスポートレイヤがメッセージ配信を処理し、必要に応じてプラットフォーム固有の構成を適用します。このトランスポートレイヤには次のものが含まれます。

Google Play 開発者サービスを搭載した Android デバイス向けの Android トランスポートレイヤ（ATL）
iOS デバイス向けの Apple Push Notification Service（APN）
ウェブアプリのウェブ push プロトコル

ユーザーのデバイス上の FCM SDK では、アプリのフォアグラウンドまたはバックグラウンドの状態と、関連するアプリケーションロジックに従って通知が表示されるか、メッセージが処理されます。

作成するアプリの概要

この Codelab では、FCM を使用してサンプルの iOS アプリにプッシュ通知を追加します。

学習内容

プッシュメッセージのユーザーを登録、登録解除する方法
受信したプッシュメッセージを処理する方法
通知を表示する方法
通知のクリックに応答する方法

必要なもの

Xcode 11.0 以降
CocoaPods 1.9.0 以降
Apple デベロッパーアカウント
アプリを実行する物理 iOS デバイス
Swift の基本知識

2. 設定方法

サンプルコードをダウンロードする

この Codelab では、独自のテストアプリを作成しますが、既存のサンプルアプリを表示して実行する場合は、クイックスタートサンプルコードをダウンロードできます。

サンプルを入手するには、次の 2 つの方法があります。

git リポジトリのクローンを作成します。

$ git clone https://github.com/firebase/quickstart-ios.git

zip ファイルをダウンロードします。

ソースを ZIP ファイルとしてダウンロードした場合は、解凍するとルートフォルダ quickstart-ios が作成されます。

新しいアプリを作成する

次の手順で独自のテストアプリを作成します（以下の手順は XCode 12.3 で行います）。

XCode を開き、[Create a new Xcode project] を選択します。
[App] を選択し、[Next] をクリックします。

[Product Name] に「MessagingExample)
[Team] を選択します（チームを作成していない場合は、Apple デベロッパーアカウントで構成します）。
[Organization Identifier] に「com.your-name」と入力します。
入力 Bundle Identifier (例: com.your-name.MessagingExample」（すべての iOS アプリで一意である必要があります）と入力します。
[Interface] プルダウンで [Storyboard] を選択します。
[Life Cycle] プルダウンで [UIKit App Delegate] を選択します。
[Language] で [Swift] を選択します。
[Next] をクリックします。

APN キーを作成してアプリを Firebase プロジェクトに登録する際に、バンドル ID が必要になります。

3. APNs の構成

認証キーを作成する

このセクションでは、プッシュ通知に使用できるアプリ ID の認証キーを生成する方法について説明します。既存のキーがある場合は、新しいキーを生成する代わりにそのキーを使用できます。

認証キーを作成するには:

デベロッパーアカウントで [Certificates, Identifiers &Profiles] に移動し、[Keys] に移動します。

右上隅にある [Add] ボタン（+）をクリックします。

APNs Auth Key の説明を入力します
[Key Services] で [APN] チェックボックスをオンにし、[Continue] をクリックします。

[Register]、[Download] の順にクリックします。キーを安全な場所に保存します。このダウンロードは 1 回限りであり、後でキーを取得することはできません。

アプリ ID を作成する

アプリ ID はアプリを一意に特定する識別子です。慣例的に、アプリ ID はドメインを反転させて表記されます。

Apple Developer Member Center に移動してログインします。
[Certificates, Identifiers and Profiles] に移動します。
[Identifiers] に移動します。
[+] ボタンをクリックして新しいアプリ ID を作成します。
[App IDs] ラジオボタンを選択し、[Continue] をクリックします。

[App] を選択し、[Continue] をクリックします。

新しいアプリ ID を作成するには:
アプリ ID の名前を入力します。
チーム ID を入力します。この値は、[Membership] タブの [Team ID] と同じである必要があります。
[App ID Suffix] セクションで [Explicit App ID] を選択してから、[Bundle ID] に独自のバンドル ID を入力します。
[App Services] セクションで [Push Notifications] がオンになっていることを確認します。
[Continue] をクリックして、入力内容に間違いがないことを確認します。
[Identifier] の値は、チーム ID の値とバンドル ID の値を連結したものに一致している必要があります。
[Push Notifications] は [Configurable] になっている必要があります。
[Register] をクリックしてアプリ ID を作成します。

プロファイルを作成する

開発中にアプリをテストする場合、App Store にまだ公開されていないアプリを端末で実行する権限を与えるため、開発用のプロファイルが必要になります。

Apple Developer Member Center に移動してログインします。
[Certificates, Identifiers and Profiles] に移動します。
左上のプルダウンメニューで、[iOS, tvOS, watchOS] が選択されていない場合はそれを選択し、次に [Profiles] に移動します。
[+] ボタンをクリックして、新しいプロファイルを作成します。
プロビジョニングプロファイルの種類として [iOS App Development] を選択し、[Continue] をクリックします。

プルダウンメニューで、使用するアプリ ID を選択し、[Continue] をクリックします。
前の手順で選択したアプリ ID の iOS 開発用証明書を選択し、[Continue] をクリックします。
プロビジョニングプロファイルに含める iOS デバイスを選択し、[Continue] をクリックします。テストに使用するデバイスをすべて選択するようにしてください。
このプロビジョニングプロファイルの名前（例: MessagingExampleProfile MessagingExampleProfile）を入力して [Generate] をクリックします。

[Download] をクリックして、プロビジョニングプロファイルを Mac に保存します。

プロビジョニングプロファイルのファイルをダブルクリックしてインストールします。

4. Firebase を iOS プロジェクトに追加する

Firebase プロジェクトを作成する

iOS アプリに Firebase を追加する前に、iOS アプリに接続するための Firebase プロジェクトを作成します。Firebase プロジェクトの詳細については、 Firebase プロジェクトについて理解するをご覧ください。

Firebase コンソールで [プロジェクトを追加] をクリックし、[プロジェクト名] を選択するか、新しいプロジェクト名を入力します。

既存の Google Cloud Platform（GCP）プロジェクトがある場合は、プルダウンメニューからプロジェクトを選択して、そのプロジェクトに Firebase リソースを追加できます。

（省略可）新しいプロジェクトを作成する場合は、プロジェクト ID を編集できます。

Firebase プロジェクトには一意の ID が自動的に割り当てられます。Firebase がプロジェクト ID を使用する仕組みについては、Firebase プロジェクトについて理解するをご覧ください。

[続行] をクリックします。
プロジェクトに対し Google アナリティクスを設定します。これにより、次の Firebase プロダクトを使用する際のエクスペリエンスを最適化できます。

Firebase Crashlytics
Firebase Predictions
Firebase Cloud Messaging
Firebase In-App Messaging
Firebase Remote Config
Firebase A/B Testing

アカウントの選択を求められたら、既存の Google アナリティクスアカウントを使用するか、新しいアカウントを作成します。新しいアカウントを作成する場合は、アナリティクスレポートのロケーションを選択し、プロジェクトのデータ共有設定と Google アナリティクスの規約に同意します。

[プロジェクトを作成]（既存の GCP プロジェクトを使用する場合は [Firebase を追加]）をクリックします。

Firebase プロジェクトのリソースが自動的にプロビジョニングされます。処理が完了すると、Firebase コンソールに Firebase プロジェクトの概要ページが表示されます。

アプリを Firebase に登録する

Firebase プロジェクトを作成したら、プロジェクトに iOS アプリを追加できます。

Firebase プロジェクトにアプリを追加する効果的な手法、考慮事項（複数のビルドバリアントの扱い方など）の詳細については、Firebase プロジェクトについて理解するをご覧ください。

Firebase コンソールに移動します。
プロジェクトの概要ページの中央にある iOS アイコンをクリックして、設定ワークフローを起動します。

すでに Firebase プロジェクトにアプリを追加している場合は、[アプリを追加] をクリックするとプラットフォームのオプションが表示されます。

アプリのバンドル ID を [iOS バンドル ID] フィールドに入力します。
（省略可）その他のアプリ情報（アプリのニックネーム と App Store ID ）を入力します。
[アプリの登録] をクリックします。

Firebase 構成ファイルを追加する

[GoogleService-Info.plist をダウンロード] をクリックして、Firebase iOS 構成ファイル（GoogleService-Info.plist）を取得します。
構成ファイルを Xcode プロジェクトのルートに移動します。メッセージが表示されたら、構成ファイルをすべてのターゲットに追加するオプションを選択します。

プロジェクトに複数のバンドル ID がある場合は、Firebase コンソールで各バンドル ID を登録済みアプリに関連付けて、各アプリで独自の GoogleService-Info.plist ファイルを設定できるようにする必要があります。

XCode を閉じます。

アプリに Firebase SDK を追加する

Firebase ライブラリのインストールには CocoaPods を使用することをおすすめします。ただし、CocoaPods を使用せずに、SDK フレームワークを直接統合するか、Swift Package Manager ベータ版を使用する方法もあります。

Podfile がない場合は作成します。クイックスタートサンプルを使用している場合は、Xcode プロジェクトと（ポッドが含まれる）Podfile がすでに存在しています。

$ cd MessagingExample
$ pod init

アプリで使用したい Firebase Pod を Podfile に追加します。

サポートされている Firebase プロダクトを iOS アプリに追加できます。

クイックスタートサンプルでは、Google アナリティクスと Firebase Cloud Messaging SDK が追加されています。

# Add the Firebase pod for Google Analytics
pod 'Firebase/Analytics'

# Add the pod for Firebase Cloud Messaging
pod 'Firebase/Messaging'

Pod をインストールし、.xcworkspace ファイルを開いて Xcode でプロジェクトを確認します。

$ pod install

MessagingExample.xcworkspace を開き、Firebase コンソールで [Next] をクリックします。

アプリで Firebase を初期化する

Firebase 初期化コードをアプリケーションに追加する必要があります。

Firebase モジュールをインポートして、共有インスタンスを構成します（クイックスタートサンプルでは、Firebase モジュールはすでにインポートされています）。

Firebase モジュールを UIApplicationDelegate にインポートします。

AppDelegate.swift

import UIKit
import Firebase // Add this line

FirebaseApp 共有インスタンスを構成します。通常はアプリの application:didFinishLaunchingWithOptions: メソッドで行います。

AppDelegate.swift

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
  FirebaseApp.configure() // Add this line
  return true
}

Firebase コンソールで [Next] をクリックします。
Firebase SDK がアプリに追加されます。[Continue to console] をクリックします。

5. FCM クライアントを構成する

APNs 認証キーをアップロードする

APNs 認証キーを Firebase にアップロードします。

Firebase コンソールのプロジェクト内で歯車アイコンを選択し、[プロジェクトの設定]、[Cloud Messaging] タブの順に選択します。

[Apple app configuration] の下の [APNs authentication key] で [アップロード] ボタンをクリックして、開発用認証キー、本番環境用認証キー、またはその両方をアップロードします。少なくとも 1 つは入力してください。

キーを保存した場所に移動し、キーを選択して [開く] をクリックします。キーのキー ID（Apple Developer Member Center の [Certificates, Identifiers & Profiles] で確認できます）を追加し、[アップロード] をクリックします。

リモート通知に登録する

起動時またはアプリケーションフローの必要な時点で、リモート通知にアプリを登録します。

クイックスタートサンプルでは、registerForRemoteNotifications はすでに追加されています。

AppDelegate.swift

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
  FirebaseApp.configure()
  // [START register for remote notifications]
  if #available(iOS 10.0, *) {
    // For iOS 10 display notification (sent via APNS)
    UNUserNotificationCenter.current().delegate = self
        
    let authOptions: UNAuthorizationOptions = [.alert, .badge, .sound]
    UNUserNotificationCenter.current().requestAuthorization(options: authOptions, completionHandler: {_, _ in })
  } else {
    let settings: UIUserNotificationSettings = UIUserNotificationSettings(types: [.alert, .badge, .sound], categories: nil)
    application.registerUserNotificationSettings(settings)
  }

  application.registerForRemoteNotifications()
  // [END register for remote notifications]
  return true
}

AppDelegate.swift の末尾に次の行を追加して、UNUserNotificationCenter のデリゲートプロパティを割り当てます。

AppDelegate.swift

@available(iOS 10, *)
extension AppDelegate : UNUserNotificationCenterDelegate {

  // Receive displayed notifications for iOS 10 devices.
  func userNotificationCenter(_ center: UNUserNotificationCenter,
                              willPresent notification: UNNotification,
    withCompletionHandler completionHandler: @escaping (UNNotificationPresentationOptions) -> Void) {
    let userInfo = notification.request.content.userInfo

    // Print full message.
    print(userInfo)

    // Change this to your preferred presentation option
    completionHandler([[.alert, .sound]])
  }

  func userNotificationCenter(_ center: UNUserNotificationCenter,
                              didReceive response: UNNotificationResponse,
                              withCompletionHandler completionHandler: @escaping () -> Void) {
    let userInfo = response.notification.request.content.userInfo

    // Print full message.
    print(userInfo)

    completionHandler()
  }
}

メッセージングデリゲートを設定する

登録トークンを受信するには、メッセージングデリゲートプロトコルを実装し、[FIRApp configure] の呼び出し後に FIRMessaging の delegate プロパティを設定します。たとえば、アプリケーションデリゲートがメッセージングデリゲートプロトコルに準拠している場合は、application:didFinishLaunchingWithOptions: のデリゲートをそれ自体に設定できます（クイックスタートサンプルでは、すでに設定されています）。

AppDelegate.swift

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
  FirebaseApp.configure()
  Messaging.messaging().delegate = self // Add this line
  // [START register for remote notifications]
  if #available(iOS 10.0, *) {
    // For iOS 10 display notification (sent via APNS)
    UNUserNotificationCenter.current().delegate = self
        
    let authOptions: UNAuthorizationOptions = [.alert, .badge, .sound]
    UNUserNotificationCenter.current().requestAuthorization(options: authOptions, completionHandler: {_, _ in })
  } else {
    let settings: UIUserNotificationSettings = UIUserNotificationSettings(types: [.alert, .badge, .sound], categories: nil)
    application.registerUserNotificationSettings(settings)
  }

  application.registerForRemoteNotifications()
  // [END register for remote notifications]
  return true
}

AppDelegate.swift の末尾に次の行を追加して、FIRMessaging のデリゲートプロパティを割り当てます。

AppDelegate.swift

extension AppDelegate : MessagingDelegate {
  func messaging(_ messaging: Messaging, didReceiveRegistrationToken fcmToken: String?) {
    print("Firebase registration token: \(String(describing: fcmToken))")
    
    let dataDict:[String: String] = ["token": fcmToken ?? ""]
    NotificationCenter.default.post(name: Notification.Name("FCMToken"), object: nil, userInfo: dataDict)
  }
}

機能を追加する

アプリ ID を作成するセクションでプッシュ通知機能を追加しましたが、次の手順で XCode にもこの機能を追加する必要があります（以下の手順は XCode 12.3 で行います）。

ナビゲータ領域でプロジェクト名をクリックします。
[Signing &Capabilities] をクリックします。
[+ Capability] をクリックします。

[Background Modes] をダブルクリックします。
もう一度 [+ Capability] をクリックします。
[Push Notifications] をダブルクリックします。
[Background Modes] セクションで [Remote notifications] をオンにします。

6. 通知メッセージの送信

次の手順でテストメッセージを送信できます。

対象デバイスでアプリをインストールして実行します。リモート通知受信権限に対するリクエストを承認する必要があります。
XCode ログで登録トークンを取得します。

アプリがデバイスのバックグラウンドで動作していることを確認します。
[Notifications Composer] を開き、[新しい通知] を選択します。
通知テキストを入力します。
[Send test message] を選択します。
[FCM 登録トークンを追加] というラベルの付いたフィールドで、ステップ 2 で取得した登録トークンを入力します。
[テスト] をクリックします。

[テスト] をクリックすると、アプリをバックグラウンドで実行しているターゲットクライアントデバイスの通知センターに通知が届きます。

アプリへのメッセージ配信については、FCM レポートダッシュボードをご覧ください。このダッシュボードには、iOS と Android デバイスで送信および開封されたメッセージの数が記録されています。

7. 完了

おめでとうございます。テストメッセージを送信できました。

FCM には、トピック登録など、他にも多くの機能と構成があります。

詳細については、公式デベロッパードキュメントをご覧ください。

次のステップ

以下の Codelab をご覧ください。

Kotlin での Android の高度な機能 01.2:Android Firebase Cloud Messaging

参考資料

Firebase Cloud Messaging の公式ドキュメント

iOS アプリにプッシュ通知を追加する

1. はじめに

仕組み

FCM アーキテクチャの概要

作成するアプリの概要

学習内容

必要なもの

2. 設定方法

サンプルコードをダウンロードする

新しいアプリを作成する

3. APNs の構成

認証キーを作成する

アプリ ID を作成する

プロファイルを作成する

4. Firebase を iOS プロジェクトに追加する

Firebase プロジェクトを作成する

アプリを Firebase に登録する

Firebase 構成ファイルを追加する

アプリに Firebase SDK を追加する

アプリで Firebase を初期化する

AppDelegate.swift

AppDelegate.swift

5. FCM クライアントを構成する

APNs 認証キーをアップロードする

リモート通知に登録する

AppDelegate.swift

AppDelegate.swift

メッセージング デリゲートを設定する

AppDelegate.swift

AppDelegate.swift

機能を追加する

6. 通知メッセージの送信

7. 完了

次のステップ

参考資料

メッセージングデリゲートを設定する