איך מתחילים להשתמש ב-Firebase Cloud Messaging באפליקציות לפלטפורמת Apple

במדריך הזה מוסבר איך להתחיל להשתמש ב-Firebase Cloud Messaging באפליקציות לקוח בפלטפורמת Apple (כמו iOS) כדי לשלוח הודעות בצורה מהימנה.

באפליקציות לקוח של Apple, אפשר לקבל התראה ומטען נתונים של עד 4,096 בייט דרך Firebase Cloud Messagingממשק APNs.

כדי לכתוב את קוד הלקוח ב-Objective-C או ב-Swift, מומלץ להשתמש ב-FIRMessaging API. בדוגמה להתחלה מהירה מופיע קוד לדוגמה בשתי השפות.

לפני שמתחילים, צריך להוסיף את Firebase לפרויקט Apple.

שינוי פונקציונליות של שיטה ב-Firebase Cloud Messaging

‫FCM SDK מבצע שינוי פונקציונליות של שיטה (method swizzling) בשני תחומים עיקריים: מיפוי של טוקן APNs למזהה ההתקנה של Firebase או לFCMטוקן הרישום, ואיסוף נתונים של Analytics במהלך הטיפול בקריאה חוזרת (callback) של הודעה במורד הזרם. מפתחים שלא רוצים להשתמש ב-swizzling יכולים להשבית אותו על ידי הוספת הדגל FirebaseAppDelegateProxyEnabled לקובץ Info.plist של האפליקציה והגדרת הערך הבוליאני NO. באזורים הרלוונטיים במדריכים מופיעות דוגמאות לקוד, עם ובלי הפעלה של שינוי פונקציונליות של שיטה.

העלאת מפתח האימות של APNs

מעלים את מפתח האימות של APNs ל-Firebase. אם עדיין אין לכם מפתח אימות של APNs, אתם צריכים ליצור אותו ב-Apple Developer Member Center.

1. במסוף Firebase, עוברים אל settings הגדרות > כללי. ואז לוחצים על הכרטיסייה העברת הודעות בענן.
2. בקטע APNs authentication key (מפתח אימות של APNs) שמתחת לקטע iOS app configuration (הגדרת אפליקציית iOS), לוחצים על Upload (העלאה) כדי להעלות את מפתח האימות של הסביבה לפיתוח, או את מפתח האימות של סביבת הייצור, או את שניהם. צריך להוסיף לפחות תמונה אחת.
3. מחפשים את המיקום שבו שמרתם את המפתח, בוחרים אותו ולוחצים על פתיחה. מוסיפים את מזהה המפתח (שזמין ב-Apple Developer Member Center) ולוחצים על העלאה.

הרשמה לקבלת התראות מרחוק

UNUserNotificationCenter.current().delegate = self

let authOptions: UNAuthorizationOptions = [.alert, .badge, .sound]
UNUserNotificationCenter.current().requestAuthorization(
  options: authOptions,
  completionHandler: { _, _ in }
)

application.registerForRemoteNotifications()
MigratedSnippets.swift

[UNUserNotificationCenter currentNotificationCenter].delegate = self;
UNAuthorizationOptions authOptions = UNAuthorizationOptionAlert |
    UNAuthorizationOptionSound | UNAuthorizationOptionBadge;
[[UNUserNotificationCenter currentNotificationCenter]
    requestAuthorizationWithOptions:authOptions
    completionHandler:^(BOOL granted, NSError * _Nullable error) {
      // ...
    }];

[application registerForRemoteNotifications];
ObjCMigratedSnippets.m

גישה למזהה ההתקנה ב-Firebase

כברירת מחדל, FCM SDK רושם את מופע האפליקציה ב- FCM ומחזיר מזהה התקנה של Firebase ‏ (FID) עבור מופע אפליקציית הלקוח בהפעלת האפליקציה. בדומה לטוקן המכשיר של APNs, ה-FID הזה מאפשר לכם לשלוח התראות ממוקדות לכל מופע ספציפי של האפליקציה שלכם.

בדומה לפלטפורמות של Apple שמספקות בדרך כלל טוקן מכשיר של APNs כשמפעילים את האפליקציה, FCM מספק מזהה FID לטירגוט התראות. ה-SDK של FCM מעביר את ה-FID באמצעות השיטה FIRMessagingDelegate's messaging:didReceiveRegistration:, עוקב אוטומטית אחרי שינויים ב-FID ומפעיל את השיטה עם FID חדש כשמזוהה שינוי. מומלץ לאחזר ולהעלות את ה-FID באופן קבוע, כי יכול להיות שהוא ישתנה אחרי ההפעלה הראשונית.

הפעלת הרשמה באמצעות מזהה התקנה של Firebase

כדי להפעיל את הרישום של מופע האפליקציה ב-FCM באמצעות מזהה ההתקנה (FID) של Firebase, מוסיפים את דגל המטא-נתונים הבא לקובץ Info.plist, ולא לקובץ GoogleService-Info.plist:

FirebaseMessagingInstallationIdEnabled = YES

הגדרת הרשאת גישה לשליחת הודעות

כדי לקבל FIDs, מטמיעים את פרוטוקול שליחת ההודעות של delegate וקובעים את המאפיין delegate של FIRMessaging אחרי שמתקשרים אל [FIRApp configure]. לדוגמה, אם נציג האפליקציה תואם לפרוטוקול של נציג ההודעות, אפשר להגדיר את הנציג ב-application:didFinishLaunchingWithOptions: לעצמו.

Messaging.messaging().delegate = self

[FIRMessaging messaging].delegate = self;

הטמעה של השיטה didReceiveRegistration

אחרי שההרשמה מסתיימת, המערכת משתמשת ב-FID כדי לטרגט מופעים של האפליקציה. כדי לקבל את ה-FID בזמן ההרשמה, מטמיעים את ה-method‏ messaging:didReceiveRegistration:. השיטה הזו מופעלת בדרך כלל פעם אחת בכל הפעלה של האפליקציה, עם ה-FID. כשמפעילים את ה-method הזה, אפשר לבצע את הפעולות הבאות:

• אם לא שלחתם את ה-FID לשרת שלכם, או אם שלחתם אותו לאחרונה, שלחו אותו לשרת האפליקציה.
• אם המינוי חדש או שהמשתמש התקין מחדש את האפליקציה, צריך לרשום את ה-FID לנושאים.

func messaging(_ messaging: Messaging, didReceiveRegistration installationId: String?) {
  print("Firebase Installation ID: \(String(describing: installationId))")
  // Note: This callback is fired at each app startup.

  if let installationId = installationId {
    // Send the Firebase Installation ID to your app server.
    sendRegistrationToServer(installationId)
  }
}
    

- (void)messaging:(FIRMessaging *)messaging didReceiveRegistration:(nullable NSString *)installationId {
  NSLog(@"Firebase Installation ID: %@", installationId);
  // Note: This callback is fired at each app startup.

  if (installationId != nil) {
    // Send the Firebase Installation ID to your app server.
    [self sendRegistrationToServer:installationId];
  }
}
    

רישום ידני כשההפעלה האוטומטית מושבתת

אם השבתתם את ההפעלה האוטומטית, ה-SDK‏ FCM לא ירשום אוטומטית את מופע האפליקציה ב-FCM בזמן הפעלת האפליקציה. כדי להפעיל את הרישום ואת המסירה של ה-FID דרך השיטה messaging:didReceiveRegistration:, צריך לבצע קריאה ל-register בהפעלת האפליקציה:

// Trigger manual registration if auto-initialization is turned off.
Messaging.messaging().register { error in
    if let error = error {
        // Handle the error
        print("Failed registering: \(error)")
        return
    }
    // Registration was successful. FID is delivered through the messaging:didReceiveRegistration: method.
    print("Successfully registered.")
}
    

// Trigger manual registration if auto-initialization is turned off.
[[FIRMessaging messaging] registerWithCompletion:^(NSError * _Nullable error) {
    if (error) {
        // Handle the error
        NSLog(@"Failed registering: %@", error);
        return;
    }
    // Registration was successful. FID is delivered through the messaging:didReceiveRegistration: method.
    NSLog(@"Successfully registered.");
}];
    

השבתת החלפה: מיפוי של טוקן APNs ו-FID

אם השבתתם את שינוי פונקציונליות של שיטה או שאתם מפתחים אפליקציית SwiftUI, אתם צריכים למפות באופן מפורש את טוקן ה-APNs למספרי ההתקנה של Firebase (FID). מטמיעים את השיטה application(_:didRegisterForRemoteNotificationsWithDeviceToken:) כדי לאחזר את טוקן ה-APNs, ואז מגדירים את המאפיין apnsToken של Messaging:

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

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

אחרי שה-FID נרשם, אפשר לגשת אליו ולהאזין לאירועי רענון באמצעות אותן שיטות שבהן משתמשים כשה-swizzling מופעל.

גישה לטוקן הרישום

כברירת מחדל, FCM SDK יוצר טוקן רישום למופע של אפליקציית הלקוח בזמן הפעלת האפליקציה. בדומה לטוקן המכשיר של APNs, הטוקן הזה מאפשר לכם לשלוח התראות ממוקדות לכל מופע ספציפי של האפליקציה.

בדומה לאופן שבו פלטפורמות של Apple מספקות בדרך כלל טוקן מכשיר של APNs בהפעלת האפליקציה,‏ FCM מספק טוקן רישום באמצעות השיטה FIRMessagingDelegate's messaging:didReceiveRegistrationToken:. ‫FCM SDK מאחזר אסימון חדש או קיים במהלך ההפעלה הראשונית של האפליקציה, ובכל פעם שהאסימון מתעדכן או נפסל. בכל המקרים, ה-FCM SDK קורא ל-messaging:didReceiveRegistrationToken: עם טוקן תקין.

יכול להיות שהאסימון של הרישום ישתנה במקרים הבאים:

• האפליקציה משוחזרת במכשיר חדש
• המשתמש מסיר את האפליקציה ומתקין אותה מחדש
• המשתמש מוחק את נתוני האפליקציה.

הגדרת הרשאת גישה לשליחת הודעות

כדי לקבל טוקנים של רישום, צריך להטמיע את פרוטוקול שליחת ההודעות של נציג ולהגדיר את המאפיין FIRMessaging של delegate אחרי הקריאה ל-[FIRApp configure]. לדוגמה, אם נציג האפליקציה תואם לפרוטוקול של נציג ההודעות, אפשר להגדיר את הנציג ב-application:didFinishLaunchingWithOptions: לעצמו.

Messaging.messaging().delegate = self

[FIRMessaging messaging].delegate = self;

אחזור טוקן הרישום הנוכחי

אסימוני הרישום מועברים באמצעות השיטה messaging:didReceiveRegistrationToken:. השיטה הזו נקראת בדרך כלל פעם אחת לכל הפעלה של האפליקציה עם טוקן רישום. כשמפעילים את ה-method הזו, זה הזמן האידיאלי:

• אם אסימון הרישום חדש, שולחים אותו לשרת האפליקציה.
• להירשם למינוי לנושאים באמצעות טוקן הרישום. הדרישה הזו רלוונטית רק למנויים חדשים או למצבים שבהם המשתמש התקין מחדש את האפליקציה.

אפשר לאחזר את הטוקן ישירות באמצעות token(completion:). אם אחזור האסימון נכשל מסיבה כלשהי, תוחזר שגיאה שאינה null.

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

[[FIRMessaging messaging] tokenWithCompletion:^(NSString * _Nullable token, NSError * _Nullable error) {
  if (error != nil) {
    NSLog(@"Error fetching the remote FCM registration token: %@", error);
  } else {
    NSLog(@"Remote FCM registration token: %@", token);
    NSString* message =
      [NSString stringWithFormat:@"FCM registration token: %@", token];
    // display message
    NSLog(@"%@", message);
  }
}];

אפשר להשתמש בשיטה הזו בכל שלב כדי לגשת לאסימון במקום לאחסן אותו.

מעקב אחרי רענון טוקן

כדי לקבל התראה בכל פעם שהטוקן מתעדכן, צריך לספק נציג שתואם לפרוטוקול הנציג של העברת הודעות. בדוגמה הבאה אפשר לראות איך רושמים את הנציג ומוסיפים את שיטת הנציג המתאימה:

func messaging(_ messaging: Messaging, didReceiveRegistrationToken fcmToken: String?) {
  print("Firebase registration token: \(String(describing: fcmToken))")
  // TODO: If necessary send token to application server.
  // Note: This callback is fired at each app startup and whenever a new token is generated.
}
MigratedSnippets.swift

- (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.
}
ObjCMigratedSnippets.m

אפשרות אחרת היא להאזין לאירוע NSNotification בשם kFIRMessagingRegistrationTokenRefreshNotification במקום לספק שיטת נציג. מאפיין הטוקן תמיד מכיל את ערך הטוקן הנוכחי.

השבתת החלפה: מיפוי של טוקן APNs וטוקן רישום

אם השבתתם את שינוי פונקציונליות של שיטה או שאתם מפתחים אפליקציית SwiftUI, תצטרכו למפות באופן מפורש את אסימון הרישום של APNs אל FCMאסימון הרישום. מטמיעים את ה-method‏ application(_:didRegisterForRemoteNotificationsWithDeviceToken:) כדי לאחזר את טוקן ה-APNs, ואז מגדירים את המאפיין apnsToken של Messaging:

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

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

אחרי שנוצר אסימון הרישום FCM, אפשר לגשת אליו ולהאזין לאירועי רענון באמצעות אותן שיטות שבהן משתמשים כשהאפשרות swizzling מופעלת.

מניעת אתחול אוטומטי

כשנוצרת הרשמה של FCM, הספרייה מעלה את המזהה ואת נתוני ההגדרה ל-Firebase. אם אתם רוצים לקבל קודם הסכמה מפורשת מהמשתמשים, אתם יכולים להשבית את FCM כדי למנוע רישום אוטומטי בזמן ההגדרה. כדי לעשות את זה, מוסיפים ערך מטא-נתונים ל-Info.plist (לא ל-GoogleService-Info.plist):

FirebaseMessagingAutoInitEnabled = NO

כדי להפעיל מחדש את FCM, אפשר לבצע קריאה בזמן ריצה:

Messaging.messaging().autoInitEnabled = true

[FIRMessaging messaging].autoInitEnabled = YES;

הערך הזה נשמר גם אחרי הפעלה מחדש של האפליקציה.

הגדרת התוסף של שירות ההתראות

כדי לשלוח התראות שכוללות תמונות למכשירי אפל, צריך להוסיף תוסף של שירות התראות. התוסף הזה מאפשר למכשירים להציג תמונות שנשלחות במטען הייעודי (payload) של ההתראה. אם אתם לא מתכננים לשלוח תמונות בהתראות, אתם יכולים לדלג על השלב הזה.

כדי להוסיף תוסף שירות, מבצעים את משימות ההגדרה הנדרשות לשינוי והצגה של התראות ב-APNs, ואז מוסיפים את ה-API של העזר לתוסף FCM ב-NotificationService.m. במילים אחרות, במקום להשלים את הקריאה החוזרת עם self.contentHandler(self.bestAttemptContent);, משלימים אותה עם FIRMessaging extensionHelper כמו שמוצג:

@interface NotificationService () <NSURLSessionDelegate>
@property(nonatomic) void (^contentHandler)(UNNotificationContent *contentToDeliver);
@property(nonatomic) UNMutableNotificationContent *bestAttemptContent;
@end

‫@implementation NotificationService

- (void)didReceiveNotificationRequest:(UNNotificationRequest *)request withContentHandler:(void (^)(UNNotificationContent * _Nonnull))contentHandler {
    self.contentHandler = contentHandler;
self.bestAttemptContent = [request.content mutableCopy];

    // Modify the notification content here as you want
self.bestAttemptContent.title = [NSString stringWithFormat:@"%@ [modified]",
self.bestAttemptContent.title];

  // Call FIRMessaging extension helper API.
  [[FIRMessaging extensionHelper] populateNotificationContent:self.bestAttemptContent
withContentHandler:contentHandler];

}
...

שליחת הודעת התראה

1. מתקינים את האפליקציה במכשיר היעד ומריצים אותה. במכשירי Apple, מאשרים את הבקשה להרשאה לקבלת התראות מרחוק.

2. בודקים שהאפליקציה פועלת ברקע במכשיר.

3. במסוף Firebase, עוברים אל DevOps & Engagement > Messaging.

4. יוצרים קמפיין.

   • אם זו ההודעה הראשונה שלכם:

     1. לוחצים על יצירת הקמפיין הראשון.

     2. בוחרים באפשרות Firebase Notification messages (הודעות התראה של Firebase) ואז באפשרות Create (יצירה).

   • אם יצרתם בעבר קמפיינים:

     1. בכרטיסייה קמפיינים, לוחצים על קמפיין חדש.

     2. לוחצים על התראות.

5. מזינים את הטקסט של ההודעה.

6. בחלונית השמאלית, לוחצים על שליחת הודעת בדיקה.

7. בשדה עם התווית Add a Firebase Installation ID or FCM registration token (הוספת מזהה התקנה של Firebase או טוקן רישום), מזינים את טוקן הרישום.

8. בוחרים באפשרות בדיקה.

אחרי שבוחרים באפשרות Test (בדיקה), ההתראה אמורה להתקבל במכשיר הלקוח שמטרגט, כשהאפליקציה פועלת ברקע.

כדי לקבל תובנות לגבי מסירת הודעות לאפליקציה, עוברים אל לוח הבקרה של דוחות הודעות > DevOps & Engagement במסוף Firebase. בלוח הבקרה הזה מתועד מספר ההודעות שנשלחו ונפתחו במכשירי Apple ובמכשירי Android, לצד נתונים לגבי 'חשיפות' (התראות שהמשתמשים ראו) באפליקציות ל-Android.

השלבים הבאים

אחרי שתסיימו את שלבי ההגדרה, תוכלו להשתמש באחת מהאפשרויות הבאות כדי להתקדם עם FCM בפלטפורמות של אפל:

• שליחת הודעות למכשירים
• קבלת הודעות באפליקציה של אפל
• שליחת הודעות לנושאים