このページは Cloud Translation API によって翻訳されました。

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 Transport Layer（ATL）
iOS デバイス向け Apple プッシュ通知サービス（APNs）
ウェブアプリ用のウェブ push プロトコル

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

作成するアプリの概要

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

学習内容

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

必要なもの

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] をクリックします。

プロダクト名を入力します（例:MessagingExample)
[Team] を選択します（チームを作成していない場合は、Apple Developer Account で設定します）。
組織 ID を入力します（例:com.your-name)
バンドル ID を入力します（例:com.your-name.MessagingExample の場合は、すべての iOS アプリで一意である必要があります）。
[インターフェース] プルダウンで [Storyboard] を選択します。
[Life Cycle] プルダウンで [UIKit App Delegate] を選択します。
[Language] で [Swift] を選択します。
[次へ] をクリックします。

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

3. APN の設定

認証キーを作成する

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

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

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

右上にある追加ボタン（+）をクリックします。

APNs 認証キーの説明を入力してください
[Key Services] で [APNs] チェックボックスをオンにして、[Continue] をクリックします。

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

アプリ ID を作成する

アプリ ID は、アプリを一意に識別する識別子です。慣例として、逆ドメインで表されます。

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

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

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

プロファイルを作成する

開発中にアプリをテストするには、開発用プロファイルが必要です。これにより、App Store でまだ公開されていないアプリをデバイスで実行できるようになります。

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

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

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

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

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

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

Firebase を iOS アプリに追加する前に、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（Pod を含む）はすでに存在します。

$ cd MessagingExample
$ pod init

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

サポートされている 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 コンソールで [次へ] をクリックします。

アプリで 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 コンソールで [次へ] をクリックします。
Firebase SDK がアプリに追加されます。[コンソールに進む] をクリックします。

5. FCM クライアントの構成

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

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

Firebase コンソールのプロジェクト内で歯車アイコンを選択し、[プロジェクトの設定]、[Cloud Messaging] タブの順に選択します。
[iOS アプリの構成] の [APNs 認証キー] で [アップロード] ボタンをクリックします。
キーを保存した場所に移動し、キーを選択して [開く] をクリックします。キーのキー ID（Apple Developer Member Center の [Certificates, Identifiers &Profiles] で確認できます）を追加し、[Upload] をクリックします。

リモート通知に登録する

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

クイックスタートサンプルでは、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 の delegate プロパティを割り当てます。

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 の delegate プロパティを割り当てます。

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 にあります）。

ナビゲータエリアでプロジェクト名をクリックします。
[署名と機能。
[+ Capability] をクリックします。

[Background Modes] をダブルクリックします。
もう一度 [+ Capability] をクリックします。
[Push Notifications] をダブルクリックします。
[バックグラウンドモード] セクションの [リモート通知] をオンにします。

6. 通知メッセージを送信する

テストメッセージを送信する手順は次のとおりです。

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

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

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

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

7. 完了

これで、テストメッセージが正常に送信されました。

FCM には、トピックサブスクリプションなど、他にも多くの関数や構成があります。

関心をお持ちの場合は、公式のデベロッパードキュメントをご確認ください。

次のステップ

これらの Codelab をご確認ください。

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

参考資料

Firebase Cloud Messaging 公式ドキュメント

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

1. はじめに

仕組み

FCM アーキテクチャの概要

作成するアプリの概要

学習内容

必要なもの

2. 設定方法

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

新しいアプリを作成する

3. APN の設定

認証キーを作成する

アプリ 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. 完了

次のステップ

参考資料

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