Apple プラットフォームで Firebase Cloud Messaging クライアントアプリを設定する

Apple クライアントアプリの場合、Firebase Cloud Messaging APNs インターフェースを介して最大 4,000 バイトの通知とデータペイロードを受信できます。

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

APNs によるプッシュ通知の送信を有効にするには、次の準備が必要になります。

Apple Developer アカウントの Apple Push Notification Authentication Key。Firebase Cloud Messaging はこのトークンを使用して、アプリ ID で識別されるアプリケーションにプッシュ通知を送信します。
プッシュ通知が有効であるアプリ ID のプロビジョニングプロファイル。また、開発中にアプリをテストする場合、App Store にまだ公開されていないアプリをデバイスで実行する権限を与えるため、開発用のプロビジョニングプロファイルも必要になります。

どちらも Apple Developer Member Center で作成します。

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

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

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

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

前提条件

以下をインストールします。
- Xcode 12.5 以降
プロジェクトが次の要件を満たしていることを確認します。
- 以下のバージョンまたはそれ以降をターゲットにする必要があります。
  - iOS 10
  - macOS 10.12
  - tvOS 12
  - watchOS 6

アプリを実行する物理的な Apple デバイスを設定し、次のタスクを完了します。
- Apple Developer アカウントの Apple Push Notification Authentication Key を取得します。
- プッシュ通知を XCode の [App] > [Capabilities] で有効にします。

Google アカウントを使用して Firebase にログインします。

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

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

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

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

Firebase コンソールで [プロジェクトを追加] をクリックします。
- Firebase リソースを既存の Google Cloud プロジェクトに追加するには、そのプロジェクト名を入力するか、プルダウンメニューから選択します。
- 新しいプロジェクトを作成するには、目的のプロジェクト名を入力します。必要に応じて、プロジェクト名の下に表示されるプロジェクト ID を編集することもできます。
  
  指定した名前に基づいて Firebase プロジェクトの一意の ID が生成されます。このプロジェクト ID を編集したい場合は、この時点で行う必要があります。プロジェクトのリソースがプロビジョニングされた後でプロジェクト ID を変更することはできません。Firebase がプロジェクト ID を使用する仕組みについては、Firebase プロジェクトについて理解するをご覧ください。
Firebase の利用規約が表示されたら、内容を読み、同意します。
[続行] をクリックします。

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

既存の Google アナリティクスアカウントを選択するか、新しいアカウントを作成します。

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

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

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

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

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

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

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

すでに Firebase プロジェクトにアプリを追加している場合は、[アプリを追加] をクリックするとプラットフォームのオプションが表示されます。
アプリのバンドル ID を [バンドル ID] フィールドに入力します。
バンドル ID とは何ですか？どこで確認できますか？
- バンドル ID は、Apple のエコシステム内でアプリケーションを一意に識別するものです。
- バンドル ID を確認する: Xcode でプロジェクトを開き、プロジェクトナビゲータで最上位のアプリを選択し、[General] タブを選択します。
  
  [Bundle Identifier] フィールドの値がバンドル ID です（例: com.yourcompany.yourproject）。
- バンドル ID の値は大文字と小文字が区別されます。Firebase プロジェクトに登録すると、該当の Firebase アプリのバンドル ID は変更できなくなることに注意してください。
アプリが実際に使用しているバンドル ID を入力してください。バンドル ID の値は大文字と小文字が区別されます。Firebase プロジェクトに登録された後、この Firebase Apple アプリのバンドル ID は変更できません。
（省略可）その他のアプリ情報（アプリのニックネームと App Store ID）を入力します。
Firebase 内でアプリのニックネームと App Store ID はどのように使用されますか？
- アプリのニックネーム: 内部用の簡易的な ID であり、Firebase コンソールでのみ表示されます。
- App Store ID: Firebase Dynamic Links ではユーザーを App Store ページにリダイレクトするために使用され、Google アナリティクスではコンバージョンイベントを Google 広告にインポートするために使用されます。まだアプリに App Store ID が割り当てられてない場合は、後でプロジェクトの設定で ID を追加できます。
[アプリの登録] をクリックします。

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

[GoogleService-Info.plist をダウンロード] をクリックして、Firebase Apple プラットフォーム構成ファイル（GoogleService-Info.plist）を取得します。
この構成ファイルについて知っておくべきことは何ですか？
- Firebase 構成ファイルには、プロジェクト用の機密ではない一意の識別子が含まれています。この構成ファイルの詳細については、Firebase プロジェクトについて理解するをご覧ください。
- Firebase 構成ファイルはいつでも再ダウンロードできます。
- 構成ファイル名に (2) などの文字が追加されていないことを確認します。
構成ファイルを Xcode プロジェクトのルートに移動します。メッセージが表示されたら、構成ファイルをすべてのターゲットに追加するオプションを選択します。

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

アプリに Firebase SDK を追加する

Swift Package Manager を使用して Firebase の依存関係のインストールと管理を行います。

Xcode でアプリプロジェクトを開いたまま、[File（ファイル）] > [Swift Packages（Swift パッケージ）] > [Add Package Dependency（パッケージの依存関係を追加）] の順に移動します。
プロンプトが表示されたら、Firebase Apple プラットフォーム SDK リポジトリを追加します。

  https://github.com/firebase/firebase-ios-sdk

Firebase Cloud Messaging ライブラリを選択します。
Firebase Cloud Messaging でのエクスペリエンスを最適化するために、Firebase プロジェクトで Google アナリティクスを有効にして、Google アナリティクス用の Firebase SDK をアプリに追加することをおすすめします。ライブラリで IDFA の収集を行う / 行わないを選択できます。
上記の作業が完了すると、Xcode は依存関係の解決とバックグラウンドでのダウンロードを自動的に開始します。

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

APNs 認証キーを Firebase にアップロードします。まだ APNs 認証キーを用意していない場合は、Apple Developer Member Center で作成してください。

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

アプリで Firebase を初期化する

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

Firebase モジュールを UIApplicationDelegate にインポートします。
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

UNUserNotificationCenter の delegate プロパティと FIRMessaging の delegate プロパティを割り当てる必要があります。たとえば iOS アプリでは、アプリのデリゲートの applicationWillFinishLaunchingWithOptions: メソッドまたは applicationDidFinishLaunchingWithOptions: メソッドでこのプロパティを割り当てます。

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

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

Apple プラットフォームが通常、アプリ起動時に 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 回ずつ呼び出されます。このメソッドが呼び出されるタイミングで、以下を実行できます。

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

token(completion:) を使用して直接トークンを取得できます。なんらかの形でトークンの取得に失敗すると、null 以外のエラーが返されます。

Swift

Messaging.messaging().token { token, error in
  if let error = error {
    print("Error fetching FCM registration token: \(error)")
  } else if let token = token {
    print("FCM registration token: \(token)")
    self.fcmRegTokenMessage.text  = "Remote FCM registration token: \(token)"
  }
}

Objective-C

[[FIRMessaging messaging] tokenWithCompletion:^(NSString *token, NSError *error) {
  if (error != nil) {
    NSLog(@"Error getting FCM registration token: %@", error);
  } else {
    NSLog(@"FCM registration token: %@", token);
    self.fcmRegTokenMessage.text = token;
  }
}];

このメソッドを使用することで、トークンを保管せずに、いつでもトークンにアクセスできます。

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

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

Swift

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
  )
  // 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: Data) {
  Messaging.messaging().apnsToken = deviceToken
}

Objective-C

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

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

自動初期化を禁止する

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

FirebaseMessagingAutoInitEnabled = NO

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

Swift

Messaging.messaging().autoInitEnabled = true

Objective-C

[FIRMessaging messaging].autoInitEnabled = YES;

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

次のステップ

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

Apple プラットフォームで Firebase Cloud Messaging クライアント アプリを設定する

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

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

前提条件

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

自動初期化を禁止する

Swift

Objective-C

次のステップ

Apple プラットフォームで Firebase Cloud Messaging クライアントアプリを設定する

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