iOS で Firebase Cloud Messaging クライアントアプリを設定する

iOS クライアントアプリの場合、次の 2 通りの補完的な用途で Firebase Cloud Messaging を実装できます。

Firebase Cloud Messaging APNs インターフェースを介して最大 4 KB の基本的なプッシュメッセージを受信する。
フォアグラウンドで動作しているアプリで、メッセージをアップストリームに送信するか、最大 4 KB のデータペイロードをダウンストリームで受信する。

Objective-C または Swift でクライアントコードを記述するには、FIRMessaging API を使用することをおすすめします。クイックスタートサンプルでは両方の言語のサンプルコードをご覧いただけます。

Firebase Cloud Messaging でのメソッドの実装入れ替え

FCM SDK は、FCM 登録トークンに対する APNs トークンのマッピングと、ダウンストリームメッセージのコールバック処理中のアナリティクスデータの取得という 2 つの主要領域で、メソッドの実装入れ替えを行います。入れ替えを使用しない場合、アプリの Info.plist ファイルにフラグ FirebaseAppDelegateProxyEnabled を追加し、これを NO（ブール値）に設定することによって、入れ替えを無効にできます。このガイドの関連領域には、メソッドの実装入れ替えを有効にした場合としない場合の両方のサンプルコードが記されています。

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

このセクションで説明しているタスクは、他の Firebase 機能をアプリですでに有効にしている場合は完了している可能性があります。FCM の場合には、APNs 認証キーをアップロードしてリモート通知に登録する必要があります。

前提条件

Xcode 10.1 以降をインストールします。
CocoaPods 1.4.0 以降をインストールします。
Xcode でプロジェクトを開きます。
- プロジェクトのターゲットは iOS 8 以降に設定してください。
- Swift プロジェクトには Swift 3.0 以降を使用してください。
アプリを実行する物理 iOS デバイスまたは iOS シミュレータを設定します。
- Cloud Messaging を使用する場合は、以下のものが必要となります。
  - 物理 iOS デバイス
  - Apple Developer アカウントの Apple Push Notification Authentication Key
  - Xcode で [App] > [Capabilities] でプッシュ通知を有効にする
- その他のすべての Firebase プロダクトで、物理 iOS デバイスと iOS シミュレータのいずれかを使用できます。
Google アカウントを使用して Firebase にログインします。

Xcode プロジェクトをまだ用意していない場合、Firebase プロダクトを試すだけであれば、クイックスタートサンプルをダウンロードしてご利用いただけます。

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

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

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

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

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

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

Firebase プロジェクトのリソースがプロビジョニングされた後にプロジェクト ID を変更することはできません。
特定の識別子を使用するには、この設定手順でプロジェクト ID を編集する必要があります。
[続行] をクリックします。

（省略可）プロジェクトの Google アナリティクスを設定します。これにより、次の Firebase プロダクトを使用して最適なエクスペリエンスを実現できます。

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

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

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

Firebase を使用してアプリを登録する

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

Firebase プロジェクトにアプリを追加するベストプラクティス、考慮事項（複数のビルドバリエーションの扱い方など）の詳細については、Firebase プロジェクトについて理解するをご覧ください。

Firebase コンソールの [Project Overview] ページの中央にある iOS アイコンをクリックして設定ワークフローを起動します。

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

アプリが実際に使用している ID を入力してください。アプリを Firebase プロジェクトに登録した後で、この値を追加または変更することはできません。
- このバンドル ID を探すには、XCode でアプリを開き、最上位の Runner ディレクトリの [General] タブにアクセスします。[Bundle Identifier] フィールドの値が iOS バンドル ID です（例: com.yourcompany.yourproject）。
（省略可）設定ワークフローの指示に従って他のアプリ情報を入力します。
- アプリのニックネーム: 内部用の簡易的な ID であり、Firebase コンソールでのみ表示されます。
- App Store ID: Firebase Dynamic Links ではユーザーを App Store ページにリダイレクトするために使用され、Google アナリティクスではコンバージョンイベントを Google 広告にインポートするために使用されます。まだアプリに App Store ID が割り当てられてない場合は、後でプロジェクト設定で ID を追加できます。
[アプリの登録] をクリックします。

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

[GoogleService-Info.plist をダウンロード] をクリックして、Firebase iOS 構成ファイル（GoogleService-Info.plist）を取得します。
- Firebase iOS 構成ファイルはいつでも再ダウンロードできます。
- 構成ファイルに (2) のような文字が追加されていないことを確認してください。
構成ファイルを Xcode プロジェクトのルートに移動します。メッセージが表示されたら、構成ファイルをすべてのターゲットに追加するオプションを選択します。

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

アプリに Firebase SDK を追加する

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

いずれかのクイックスタートサンプルを使用する場合、Xcode プロジェクトと（ポッドが含まれる）Podfile がすでに存在していても、Firebase 構成ファイルを追加してポッドをインストールする必要があります。

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

Podfile がない場合は作成します。
```
cd your-project-directory
```
```
pod init
```
アプリで使用したい Firebase ポッドを Podfile に追加します。

Firebase Cloud Messaging のエクスペリエンスを最適化するために、プロジェクトで Google アナリティクスを有効にすることをおすすめします。Google アナリティクスの設定の一環として、Google アナリティクス用の Firebase SDK をアプリに追加する必要があります。
アナリティクスが有効な場合
```
# Add the Firebase pod for Google Analytics
pod 'Firebase/Analytics'

# Add the pod for Firebase Cloud Messaging
pod 'Firebase/Messaging'
```
アナリティクスが無効な場合
```
# Add the pod for Firebase Cloud Messaging
pod 'Firebase/Messaging'
```
ポッドをインストールし、.xcworkspace ファイルを開いて Xcode でプロジェクトを確認します。
```
pod install
```
```
open your-project.xcworkspace
```

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

APNs 認証キーを Firebase にアップロードします。APNs 認証キーがない場合は、FCM での APNs の構成に関する説明をご覧ください。

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

アプリで Firebase を初期化する

Firebase 初期化コードをアプリケーションに追加する必要があります。Firebase モジュールをインポートして、次に示すように共有インスタンスを構成します。

UIApplicationDelegate で Firebase モジュールをインポートします。
Swift
```
import Firebase
```
Objective-C
```
@import Firebase;
```
FirebaseApp 共有インスタンスを構成します。通常はアプリの application:didFinishLaunchingWithOptions: メソッドで行います。
Swift
```
// Use Firebase library to configure APIs
FirebaseApp.configure()
```
Objective-C
```
// Use Firebase library to configure APIs
[FIRApp configure];
```

リモート通知に登録する

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

Swift

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()
AppDelegate.swift

Objective-C

if ([UNUserNotificationCenter class] != nil) {
  // iOS 10 or later
  // For iOS 10 display notification (sent via APNS)
  [UNUserNotificationCenter currentNotificationCenter].delegate = self;
  UNAuthorizationOptions authOptions = UNAuthorizationOptionAlert |
      UNAuthorizationOptionSound | UNAuthorizationOptionBadge;
  [[UNUserNotificationCenter currentNotificationCenter]
      requestAuthorizationWithOptions:authOptions
      completionHandler:^(BOOL granted, NSError * _Nullable error) {
        // ...
      }];
} else {
  // iOS 10 notifications aren't available; fall back to iOS 8-9 notifications.
  UIUserNotificationType allNotificationTypes =
  (UIUserNotificationTypeSound | UIUserNotificationTypeAlert | UIUserNotificationTypeBadge);
  UIUserNotificationSettings *settings =
  [UIUserNotificationSettings settingsForTypes:allNotificationTypes categories:nil];
  [application registerUserNotificationSettings:settings];
}

[application registerForRemoteNotifications];AppDelegate.m

iOS 10 以降を実行しているデバイスの場合、UNUserNotificationCenter の delegate プロパティと FIRMessaging の delegate プロパティを割り当てる必要があります。たとえば iOS アプリでは、アプリのデリゲートの applicationWillFinishLaunchingWithOptions: メソッドまたは applicationDidFinishLaunchingWithOptions: メソッドでこのプロパティを割り当てます。

登録トークンにアクセスする

デフォルトでは、FCM SDK はアプリの起動時にクライアントアプリのインスタンスの登録トークンを生成します。APNs デバイストークンの場合と同様に、このトークンを使用すると、ターゲットとする通知をアプリの特定のインスタンスに送信できます。

iOS が通常、アプリ起動時に APNs デバイストークンを配信するのと同じ方法で、FCM は FIRMessagingDelegate の messaging:didReceiveRegistrationToken: メソッドによって登録トークンを提供します。FCM SDK は、アプリの初期起動時ならびにトークンが更新または無効化されるたびに、新規または既存のトークンを取得します。いずれの場合も、FCM SDK は有効なトークンを使用して messaging:didReceiveRegistrationToken: を呼び出します。

登録トークンは次のような場合に変更されることがあります。

アプリが新しいデバイスで復元される場合
ユーザーがアプリをアンインストール / 再インストールする場合
ユーザーがアプリのデータを消去する場合

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

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

Swift

Messaging.messaging().delegate = self

Objective-C

[FIRMessaging messaging].delegate = self;

現在の登録トークンを取得する

登録トークンは、メソッド messaging:didReceiveRegistrationToken: を使用して配信されます。このメソッドは通常、登録トークンを使用してアプリが起動するごとに 1 回ずつ呼び出されます。このメソッドが呼び出されるタイミングで、以下を実行できます。

登録トークンが新規の場合、そのトークンをアプリケーションサーバーに送信します。
登録トークンをトピックに登録します。これは新規登録の場合、またはユーザーがアプリを再インストールした場合にのみ必要です。

instanceIDWithHandler: を使用して直接トークンを取得できます。このコールバックによって返される InstanceIDResult にトークンが含まれています。なんらかの形で InstanceID の取得に失敗した場合、null 以外のエラーが返されます。

Swift

InstanceID.instanceID().instanceID { (result, error) in
  if let error = error {
    print("Error fetching remote instance ID: \(error)")
  } else if let result = result {
    print("Remote instance ID token: \(result.token)")
    self.instanceIDTokenMessage.text  = "Remote InstanceID token: \(result.token)"
  }
}

Objective-C

[[FIRInstanceID instanceID] instanceIDWithHandler:^(FIRInstanceIDResult * _Nullable result,
                                                    NSError * _Nullable error) {
  if (error != nil) {
    NSLog(@"Error fetching remote instance ID: %@", error);
  } else {
    NSLog(@"Remote instance ID token: %@", result.token);
    NSString* message =
      [NSString stringWithFormat:@"Remote InstanceID token: %@", result.token];
    self.instanceIDTokenMessage.text = message;
  }
}];

通常、トークンはローカルで使用可能になっているため、このメソッドはネットワーク接続を開きません。このメソッドを使用することで、トークンを保管せずに、いつでもトークンにアクセスできます。

.getToken(authorizedEntity,scope) は、複数の送信者を有効にする必要がない限り呼び出さないでください。instanceIDWithHandler: を代わりに使用してください。

トークン更新のモニタリング

トークンが更新されるたびに通知を受けるには、メッセージングデリゲートプロトコルに準拠するデリゲートを指定します。次の例では、デリゲートを登録し、適切なデリゲートメソッドを追加します。

Swift

func messaging(_ messaging: Messaging, didReceiveRegistrationToken fcmToken: String) {
  print("Firebase registration token: \(fcmToken)")

  let dataDict:[String: String] = ["token": fcmToken]
  NotificationCenter.default.post(name: Notification.Name("FCMToken"), object: nil, userInfo: dataDict)
  // TODO: If necessary send token to application server.
  // Note: This callback is fired at each app startup and whenever a new token is generated.
}AppDelegate.swift

Objective-C

- (void)messaging:(FIRMessaging *)messaging didReceiveRegistrationToken:(NSString *)fcmToken {
    NSLog(@"FCM registration token: %@", fcmToken);
    // Notify about received token.
    NSDictionary *dataDict = [NSDictionary dictionaryWithObject:fcmToken forKey:@"token"];
    [[NSNotificationCenter defaultCenter] postNotificationName:
     @"FCMToken" object:nil userInfo:dataDict];
    // TODO: If necessary send token to application server.
    // Note: This callback is fired at each app startup and whenever a new token is generated.
}AppDelegate.m

別の方法として、デリゲートメソッドを提供する代わりに、kFIRMessagingRegistrationTokenRefreshNotification という名前の NSNotification をリッスンできます。トークンプロパティの値は常に現在のトークン値です。

実装入れ替えが無効な場合の APNs トークンと登録トークンとのマッピング

メソッドの実装入れ替えを無効にした場合は、明示的に APNs トークンを FCM 登録トークンにマッピングする必要があります。メソッド didRegisterForRemoteNotificationsWithDeviceToken をオーバーライドして APNs トークンを取得してから、FIRMessaging の APNSToken プロパティを設定します。

Swift

func application(application: UIApplication,
                 didRegisterForRemoteNotificationsWithDeviceToken deviceToken: NSData) {
  Messaging.messaging().apnsToken = deviceToken
}

Objective-C

// With "FirebaseAppDelegateProxyEnabled": NO
- (void)application:(UIApplication *)application
    didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {
    [FIRMessaging messaging].APNSToken = deviceToken;
}

FCM 登録トークンが生成されると、実装入れ替えを有効にしたときと同じメソッドを使用してトークンにアクセスし、更新イベントをリッスンできます。

既存のユーザー APNs トークンのインポート

FCM クライアントアプリにオンボードする既存のユーザーベースがある場合、インスタンス ID で提供される batchImport API を使用します。この API によって、既存の iOS APNs トークンを FCM に一括インポートして、新しい有効な登録トークンにマッピングできます。

自動初期化を禁止する

FCM では FCM 内で登録トークンとして使用されるインスタンス ID が生成されます。インスタンス ID が生成されると、ライブラリによりその ID と構成データが Firebase にアップロードされます。インスタンス ID を使用する前に明示的にオプトインする場合は、構成時に FCM を無効にして生成を禁止できます。禁止するには、（GoogleService-Info.plist ではなく）Info.plist にメタデータ値を追加します。

FirebaseMessagingAutoInitEnabled = NO

FCM をもう一度有効にするには、ランタイムコールを実行します。

Swift

Messaging.messaging().autoInitEnabled = true

Objective-C

[FIRMessaging messaging].autoInitEnabled = YES;

この値をいったん設定すると、アプリを再起動しても維持されます。

次のステップ

iOS クライアントの設定を行うと、メッセージ処理やその他の高度な動作をアプリに追加できるようになります。詳細については、以下のガイドをご覧ください。

iOS で Firebase Cloud Messaging クライアント アプリを設定する

Firebase Cloud Messaging でのメソッドの実装入れ替え

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

前提条件

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

Firebase を使用してアプリを登録する

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

アプリに Firebase SDK を追加する

アナリティクスが有効な場合

アナリティクスが無効な場合

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

アプリで Firebase を初期化する

Swift

Objective-C

Swift

Objective-C

リモート通知に登録する

Swift

Objective-C

登録トークンにアクセスする

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

Swift

Objective-C

現在の登録トークンを取得する

Swift

Objective-C

トークン更新のモニタリング

Swift

Objective-C

実装入れ替えが無効な場合の APNs トークンと登録トークンとのマッピング

Swift

Objective-C

既存のユーザー APNs トークンのインポート

自動初期化を禁止する

Swift

Objective-C

次のステップ

iOS で Firebase Cloud Messaging クライアントアプリを設定する

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