iOS クライアント アプリの場合、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 を iOS プロジェクトに追加する
他の Firebase 機能をアプリですでに有効にしている場合、このセクションで説明しているタスクはすでに完了している可能性があります。FCM の場合には、APNs 認証キーをアップロードしてリモート通知に登録する必要があります。
前提条件
以下をインストールします。
- Xcode 12.2 以降
- CocoaPods 1.10.0 以降
プロジェクトが次の要件を満たしていることを確認します。
- プロジェクトのターゲットは iOS 10 以降に設定してください。
アプリを実行する物理的な iOS デバイスを設定し、次のタスクを完了します。
- Apple Developer アカウントの Apple Push Notification Authentication Key を取得します。
- プッシュ通知を XCode の [App] > [Capabilities] で有効にします。
- Google アカウントを使用して Firebase にログインします。
Xcode プロジェクトがない場合、Firebase プロダクトを試してみるだけであれば、クイックスタート サンプルをダウンロードしてお使いいただけます。
Firebase プロジェクトを作成する
iOS アプリに Firebase を追加する前に、iOS アプリに接続するための 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 ファイルを設定できるようにする必要があります。
アプリに Firebase SDK を追加する
Firebase ライブラリのインストールには CocoaPods を使用することをおすすめします。ただし、CocoaPods を使用せずに、SDK フレームワークを直接統合するか、Swift Package Manager を使用する方法もあります。
クイックスタート サンプルのいずれかを使用していますか？使用している場合は、Xcode プロジェクトと Podfile（ポッドを含む）はすでに存在しますが、Firebase 構成ファイルを追加して、それらのポッドをインストールする必要があります。
Podfile がない場合は作成します。
cd your-project-directory
pod init
アプリで使用したい Firebase Pod を Podfile に追加します。
サポートされている Firebase プロダクトを iOS アプリに追加できます。
Firebase Cloud Messaging のエクスペリエンスを最適化するために、プロジェクトで Google アナリティクスを有効にすることをおすすめします。また、アナリティクスの設定の一環として、アナリティクス用 Firebase SDK をアプリに追加する必要があります。
アナリティクスが有効な場合
# Add the Firebase pod for Google Analytics pod 'Firebase/Analytics' # For Analytics without IDFA collection capability, use this pod instead # pod ‘Firebase/AnalyticsWithoutAdIdSupport’ # Add the pod for Firebase Cloud Messaging pod 'Firebase/Messaging'
デバイスレベルの広告識別子である IDFA について詳しくは、Apple のユーザーのプライバシーとデータの使用と、App Tracking Transparency に関するドキュメントをご覧ください。
アナリティクスが無効な場合
# Add the pod for Firebase Cloud Messaging pod 'Firebase/Messaging'
ポッドをインストールし、
.xcworkspaceファイルを開いて Xcode でプロジェクトを確認します。pod install
open your-project.xcworkspace
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()
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];
登録トークンにアクセスする
デフォルトでは、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 回ずつ呼び出されます。このメソッドが呼び出されるタイミングで、以下を実行できます。
- 登録トークンが新規の場合、そのトークンをアプリケーション サーバーに送信します。
- 登録トークンをトピックに登録します。これは新規登録の場合、またはユーザーがアプリを再インストールした場合にのみ必要です。
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.
}
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.
}
別の方法として、デリゲート メソッドを提供する代わりに、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;
この値をいったん設定すると、アプリを再起動しても維持されます。
次のステップ
iOS クライアントの設定を行うと、メッセージ処理やその他の高度な動作をアプリに追加できるようになります。詳細については、以下のガイドをご覧ください。