הסבר על מסירת הודעות

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

ב-FCM יש גם שלושה סוגי כלים שיעזרו לכם לקבל תובנות לגבי הערכה רחבה של הצלחת ההודעות והאסטרטגיה:

• Firebase דוחות מסירה של הודעות במסוף
• מדדים מצטברים של מסירת Android SDK מ-Firebase Cloud Messaging Data API
• ייצוא נתונים מקיף ל-Google BigQuery

כדי לייצא נתונים אל BigQuery ואל הכרטיסייה דוחות במסוף Firebase, צריך להפעיל את Google Analytics. אפשר להפעיל את Google Analytics בsettings הגדרות > בכרטיסייה שילובים במסוף Firebase. נתוני משלוח מצטברים לא מחייבים את Google Analytics כדי לפעול.

חשוב לזכור שדיווח על הרבה מהנתונים הסטטיסטיים בדף הזה מתעכב עד 24 שעות בגלל עיבוד באצווה של נתוני Analytics.

דוחות מסירת הודעות

במסוף Firebase, עוברים אל DevOps & Engagement (פיתוח אפליקציות ואינטראקציה עם משתמשים) > Messaging (העברת הודעות) > הכרטיסייה Reports (דוחות) כדי לראות את הנתונים הבאים לגבי הודעות שנשלחו לערכות SDK של FCM בפלטפורמות Android או Apple, כולל הודעות שנשלחו באמצעות הכלי ליצירת הודעות ו-API של FCM:

• נשלח – הודעת הנתונים או הודעת ההתראה הוכנסה לתור למסירה או הועברה בהצלחה לשירות של צד שלישי כמו APNs למסירה. שימו לב: יכול להיות שיהיה עיכוב של כמה שעות בנתוני השליחה. מידע נוסף זמין במאמר בנושא משך החיים של הודעה.
• התקבלה (זמין רק במכשירי Android) – הודעת הנתונים או הודעת ההתראה התקבלו באפליקציה. הנתונים האלה זמינים אם במכשיר Android המקבל מותקן FCM SDK בגרסה 18.0.1 ומעלה.
• חשיפות (זמין רק להודעות התראה במכשירי Android) – ההתראה על הצגת המודעה הוצגה במכשיר בזמן שהאפליקציה פעלה ברקע.
• פתיחות – המשתמש פתח את הודעת ההתראה. הנתונים האלה מדווחים רק לגבי התראות שהתקבלו כשהאפליקציה פועלת ברקע.

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

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

• פלטפורמה (iOS או Android)
• אפליקציה
• תוויות מותאמות אישית של ניתוח נתונים

הוספת תוויות של Analytics להודעות

הוספת תוויות להודעות שימושית מאוד לניתוח בהתאמה אישית, ומאפשרת לסנן את נתוני המסירה לפי תוויות או לפי קבוצות של תוויות. אפשר להוסיף תווית לכל הודעה שנשלחת באמצעות HTTP v1 API על ידי הגדרת השדה fcmOptions.analyticsLabel באובייקט message או בשדות AndroidFcmOptions או ApnsFcmOptions הספציפיים לפלטפורמה.

תוויות Analytics הן מחרוזות טקסט בפורמט ^[a-zA-Z0-9-_.~%]{1,50}$. התוויות יכולות לכלול אותיות קטנות וגדולות, מספרים ואת הסמלים הבאים:

• -
• ~
• %

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

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

נתוני משלוח מצטברים באמצעות FCM Data API

ממשק ה-API של נתונים של העברת הודעות בענן ב-Firebase מאפשר לכם לאחזר מידע שיכול לעזור לכם להבין את התוצאות של בקשות להודעות שמטורגטות לאפליקציות ל-Android. ממשק ה-API מספק נתונים מצטברים מכל מכשירי Android שמופעל בהם איסוף נתונים בפרויקט. הנתונים כוללים פרטים על אחוז ההודעות שנמסרו ללא עיכוב, וגם על מספר ההודעות שעוכבו או נמחקו בשכבת התעבורה של Android. ניתוח הנתונים האלה יכול לחשוף מגמות רחבות בשליחת ההודעות ולעזור לכם למצוא דרכים יעילות לשפר את הביצועים של בקשות השליחה. מידע על זמינות טווחי התאריכים בדוחות מופיע במאמר בנושא ציר זמן של נתונים מצטברים.

ממשק ה-API מספק את כל הנתונים שזמינים לאפליקציה מסוימת. מידע נוסף זמין במאמרי העזרה של ה-API.

איך הנתונים מחולקים?

נתוני המסירה מחולקים לפי אפליקציה, תאריך ותווית ניתוח. קריאה ל-API תחזיר נתונים לכל שילוב של תאריך, אפליקציה ותווית ניתוח. לדוגמה, אובייקט JSON יחיד androidDeliveryData ייראה כך:

 {
  "appId": "1:23456789:android:a93a5mb1234efe56",
  "date": {
    "year": 2021,
    "month": 1,
    "day": 1
  },
  "analyticsLabel": "foo",
  "data": {
    "countMessagesAccepted": "314159",
    "messageOutcomePercents": {
      "delivered": 71,
      "pending": 15
    },
   "deliveryPerformancePercents": {
      "deliveredNoDelay": 45,
      "delayedDeviceOffline": 11
    }
  }

איך מפרשים את המדדים

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

מספר ההודעות שאושרו

הספירה היחידה שכלולה במערך הנתונים היא ספירת ההודעות שאושרו על ידי FCM למסירה למכשירי Android. כל האחוזים מחושבים על סמך הערך הזה כמכנה. חשוב לזכור שהספירה הזו לא כוללת הודעות שמיועדות למשתמשים שהשביתו במכשירים שלהם את איסוף המידע על דפוסי השימוש והביצועים.

אחוזים של תוצאות ההודעות

השדות שנכללים באובייקט MessageOutcomePercents מספקים מידע על התוצאות של בקשות להודעות. כל הקטגוריות הן בלעדיות ואין חפיפה ביניהן. הוא יכול לענות על שאלות כמו "האם ההודעות שלי נמסרות?" ו "מה גורם להודעות להיפסל?"

לדוגמה, ערך גבוה בשדה droppedTooManyPendingMessages יכול להצביע על כך שמופעים של אפליקציות מקבלים נפחים של הודעות שלא ניתן לכווץ שחורגים מהמגבלה של FCM של 100 הודעות בהמתנה. כדי למנוע את הבעיה הזו, צריך לוודא שהאפליקציה מטפלת בקריאות אל onDeletedMessages, ומומלץ לשלוח הודעות שניתן לכווץ. באופן דומה, אחוזים גבוהים של droppedDeviceInactive יכולים להצביע על כך שצריך לעדכן את אסימוני הרישום בשרת, להסיר אסימונים לא פעילים ולבטל את ההרשמה שלהם לנושאים. במאמר ניהול טוקנים של רישום FCM מפורטות שיטות מומלצות בנושא.

אחוזים של ביצועי משלוח

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

אחוזים בתובנות לגבי הודעות

האובייקט הזה מספק מידע נוסף על כל שליחת הודעה. השדה priorityLowered מייצג את אחוז ההודעות שהתקבלו והעדיפות שלהן הופחתה מ-HIGH ל-NORMAL. אם הערך הזה גבוה, כדאי לשלוח פחות הודעות בעדיפות גבוהה או לוודא שתמיד מוצגת התראה כשנשלחת הודעה בעדיפות גבוהה. מידע נוסף זמין במאמר בנושא עדיפות הודעות

מה ההבדל בין הנתונים האלה לבין הנתונים שמיוצאים ל-BigQuery?

ייצוא ל-BigQuery מספק יומנים של הודעות ספציפיות לגבי קבלת ההודעות על ידי ה-Backend של FCM ומסירת ההודעות ב-SDK במכשיר (שלבים 2 ו-4 בארכיטקטורה של FCM). הנתונים האלה שימושיים כדי לוודא שהודעות ספציפיות התקבלו ונמסרו. בקטע הבא מוסבר על ייצוא נתונים ב-BigQuery.

לעומת זאת, Firebase Cloud Messaging Data API מספק פרטים מצטברים על מה שקורה באופן ספציפי בשכבת התעבורה של Android (או בשלב 3 של ארכיטקטורת FCM). הנתונים האלה מספקים תובנות ספציפיות לגבי המסירה של הודעות מהשרתים העורפיים של FCM אל Android SDK. האפשרות הזו שימושית במיוחד כדי להראות מגמות לגבי הסיבות לעיכוב או להשמטה של הודעות במהלך ההעברה.

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

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

מגבלות של ה-API

ציר זמן של נתונים מצטברים

ה-API יחזיר נתונים היסטוריים של 7 ימים, אבל הנתונים שיוחזרו על ידי ה-API הזה יתעכבו עד 5 ימים. לדוגמה, ב-20 בינואר, הנתונים מ-9 בינואר עד 15 בינואר יהיו זמינים, אבל לא הנתונים מ-16 בינואר ואילך. בנוסף, אנחנו מספקים את הנתונים כמיטב יכולתנו. במקרה של הפסקת זמינות של נתונים, מערכת FCM תפעל כדי לתקן את הבעיה, ולא תמלא את הנתונים החסרים אחרי שהבעיה תיפתר. במקרים של הפסקות שירות נרחבות יותר, יכול להיות שהנתונים לא יהיו זמינים למשך שבוע או יותר.

כיסוי נתונים

המדדים שמוצגים ב-API של נתוני העברת הודעות בענן ב-Firebase נועדו לספק תובנות לגבי מגמות כלליות של מסירת הודעות. עם זאת, הם לא מספקים כיסוי מלא של כל תרחישי ההודעות. התרחישים הבאים הם תוצאות ידועות שלא משתקפות במדדים.

הודעות שפג תוקפן

אם אורך החיים (TTL) פג אחרי סוף התאריך שמופיע ביומן, ההודעה לא תיספר כ-droppedTtlExpired בתאריך הזה.

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

הודעות שנשלחות למכשירים לא פעילים עשויות להופיע במערך הנתונים או לא להופיע בו, בהתאם לנתיב הנתונים שהן עוברות. זה עלול להוביל לספירה שגויה בשדות droppedDeviceInactive ו-pending.

הודעות למכשירים עם העדפות משתמש מסוימות

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

עיגול וערכים מינימליים

מערכת FCM מעגלת בכוונה את הנתונים ומוציאה מהספירה נתונים שבהם נפח השימוש לא גדול מספיק.

ייצוא נתונים ל-BigQuery

אפשר לייצא את נתוני ההודעות ל-BigQuery כדי לבצע ניתוח נוסף. בעזרת BigQuery אפשר לנתח את הנתונים באמצעות BigQuery SQL, לייצא אותם לספק ענן אחר או להשתמש בהם במודלים מותאמים אישית של ML. ייצוא ל-BigQuery כולל את כל הנתונים שזמינים לגבי הודעות, ללא קשר לסוג ההודעה או לאופן השליחה שלה – באמצעות API או הכלי ליצירת הודעות.

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

• ‫Android מגרסה 20.1.0 ואילך.
• ‫iOS מגרסה 8.6.0 ואילך
• ‫Firebase Web SDK מגרסה 12.14.0 ואילך

כדי להתחיל, מקשרים את הפרויקט ל-BigQuery באמצעות מסוף Firebase:

1. בחר אחת מהאפשרויות הבאות:

   • עוברים אל DevOps & Engagement > Messaging > the Notifications composer, ואז לוחצים על Access BigQuery בתחתית הדף.

   • עוברים אל settings הגדרות > הכרטיסייה שילובים. אחר כך לוחצים על קישור בBigQuery.

     בדף הזה מוצגות FCM אפשרויות ייצוא לכל האפליקציות FCM שמופעלות בפרויקט.

2. פועלים לפי ההוראות במסך כדי להפעיל את BigQuery.

מידע נוסף זמין במאמר בנושא קישור Firebase ל-BigQuery.

כשמפעילים ייצוא של BigQuery ל-Cloud Messaging:

• ‫Firebase מייצא את הנתונים אל BigQuery. הערה: יכול להיות שיחלפו עד 48 שעות עד שהנתונים יתפשטו ויהיו זמינים לייצוא.

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

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

• ‫Firebase מגדיר סנכרונים קבועים של הנתונים מהפרויקט ב-Firebase אל BigQuery. פעולות הייצוא היומיות האלה מתחילות בשעה 4:00 לפי שעון החוף הפסיפי, ובדרך כלל מסתיימות תוך 24 שעות.

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

כדי להשבית את הייצוא של BigQuery, צריך לבטל את הקישור של הפרויקט במסוף Firebase.

הפעלה של ייצוא נתוני מסירת הודעות

// For alert notifications, call the API inside the service extension:
class NotificationService: UNNotificationServiceExtension {
  override func didReceive(_ request: UNNotificationRequest, withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void) {
    Messaging.serviceExtension().exportDeliveryMetrics(withMessageInfo:request.content.userInfo)
  }
}

// For alert notifications, call the API inside the service extension:
@implementation NotificationService
- (void)didReceiveNotificationRequest:(UNNotificationRequest *)request
                   withContentHandler:(void (^)(UNNotificationContent *_Nonnull))contentHandler {
  [[FIRMessaging extensionHelper] exportDeliveryMetricsToBigQueryWithMessageInfo:request.content.userInfo];
}
@end

// For background notifications, call the API inside the
// UIApplicationDelegate or NSApplicationDelegate method:
func application(_ application: UIApplication,
didReceiveRemoteNotification userInfo: [AnyHashable : Any]) {
  Messaging.serviceExtension().exportDeliveryMetricsToBigQuery(withMessageInfo:userInfo)
}

// For background notifications, call the API inside the
// UIApplicationDelegate or NSApplicationDelegate method:
@implementation AppDelegate
- (void)application:(UIApplication *)application
    didReceiveRemoteNotification:(NSDictionary *)userInfo
          fetchCompletionHandler:(void (^)(UIBackgroundFetchResult))completionHandler {
  [[FIRMessaging extensionHelper] exportDeliveryMetricsToBigQueryWithMessageInfo:userInfo];
}
@end

FirebaseMessaging.getInstance().setDeliveryMetricsExportToBigQuery(true);

<application>
  <meta-data android:name="delivery_metrics_exported_to_big_query_enabled"
      android:value="true" />
</application>

// userConsent holds the decision of the user to give big query export consent.
const userConsent = ...;

const messaging = getMessagingInSw(app);

experimentalSetDeliveryMetricsExportedToBigQueryEnabled(messaging, userConsent);

אילו נתונים מיוצאים ל-BigQuery?

שימו לב: טירגוט של טוקנים לא פעילים או של רישומים לא פעילים עלול לגרום לניפוח של חלק מהנתונים הסטטיסטיים האלה.

הסכימה של הטבלה המיוצאת היא:

מה אפשר לעשות עם הנתונים המיוצאים?

בקטעים הבאים מופיעות דוגמאות לשאילתות שאפשר להריץ ב-BigQuery על נתוני FCM שיוצאו.

מספר ההודעות שנשלחו לפי אפליקציה

SELECT app_name, COUNT(1)
FROM `project ID.firebase_messaging.data`
WHERE
  _PARTITIONTIME = TIMESTAMP('date as YYYY-MM-DD')
  AND event = 'MESSAGE_ACCEPTED'
  AND message_id != ''
GROUP BY 1;

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

SELECT COUNT(DISTINCT instance_id)
FROM `project ID.firebase_messaging.data`
WHERE
  _PARTITIONTIME = TIMESTAMP('date as YYYY-MM-DD')
  AND event = 'MESSAGE_ACCEPTED';

מספר הודעות ההתראה שנשלחו

SELECT COUNT(1)
FROM `project ID.firebase_messaging.data`
WHERE
  _PARTITIONTIME = TIMESTAMP('date as YYYY-MM-DD')
  AND event = 'MESSAGE_ACCEPTED'
  AND message_type = 'DISPLAY_NOTIFICATION';

ספירת הודעות נתונים שנשלחו

SELECT COUNT(1)
FROM `project ID.firebase_messaging.data`
WHERE
  _PARTITIONTIME = TIMESTAMP('date as YYYY-MM-DD')
  AND event = 'MESSAGE_ACCEPTED'
  AND message_type = 'DATA_MESSAGE';

ספירת ההודעות שנשלחו לנושא או לקמפיין

SELECT COUNT(1)
FROM `project ID.firebase_messaging.data`
WHERE
  _PARTITIONTIME = TIMESTAMP('date as YYYY-MM-DD')
  AND event = 'MESSAGE_ACCEPTED'
  AND bulk_id = your bulk id AND message_id != '';

כדי לעקוב אחרי אירועים של הודעה שנשלחה לנושא מסוים, משנים את השאילתה הזו ומחליפים את AND message_id != '' ב-AND message_id = <your message id>;.

חישוב משך הזמן של ההפצה לנושא או לקמפיין נתון

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

SELECT
  TIMESTAMP_DIFF(
    end_timestamp, start_timestamp, MILLISECOND
  ) AS fanout_duration_ms,
  end_timestamp,
  start_timestamp
FROM (
    SELECT MAX(event_timestamp) AS end_timestamp
    FROM `project ID.firebase_messaging.data`
    WHERE
      _PARTITIONTIME = TIMESTAMP('date as YYYY-MM-DD')
      AND event = 'MESSAGE_ACCEPTED'
      AND bulk_id = your bulk id
  ) sent
  CROSS JOIN (
    SELECT event_timestamp AS start_timestamp
    FROM `project ID.firebase_messaging.data`
    WHERE
      _PARTITIONTIME = TIMESTAMP('date as YYYY-MM-DD')
      AND event = 'MESSAGE_ACCEPTED'
      AND bulk_id = your bulk id
      AND message_type = 'TOPIC'
  ) initial_message;

אחוז ההודעות שנמסרו

SELECT
  messages_sent,
  messages_delivered,
  messages_delivered / messages_sent * 100 AS percent_delivered
FROM (
    SELECT COUNT(DISTINCT CONCAT(message_id, instance_id)) AS messages_sent
    FROM `project ID.firebase_messaging.data`
    WHERE
      _PARTITIONTIME = TIMESTAMP('date as YYYY-MM-DD')
      AND event = 'MESSAGE_ACCEPTED'
  ) sent
  CROSS JOIN (
    SELECT COUNT(DISTINCT CONCAT(message_id, instance_id)) AS messages_delivered
    FROM `project ID.firebase_messaging.data`
    WHERE
      _PARTITIONTIME = TIMESTAMP('date as YYYY-MM-DD')
      AND (event = 'MESSAGE_DELIVERED'
      AND message_id
      IN (
        SELECT message_id FROM `project ID.firebase_messaging.data`
        WHERE
          _PARTITIONTIME = TIMESTAMP('date as YYYY-MM-DD')
          AND event = 'MESSAGE_ACCEPTED'
        GROUP BY 1
      )
  ) delivered;

מעקב אחרי כל האירועים של מזהה הודעה ומזהה מופע מסוימים

SELECT *
FROM `project ID.firebase_messaging.data`
WHERE
    _PARTITIONTIME = TIMESTAMP('date as YYYY-MM-DD')
    AND message_id = 'your message id'
    AND instance_id = 'your instance id'
ORDER BY event_timestamp;

חישוב זמן האחזור של הודעה מסוימת ומזהה מכונה מסוים

SELECT
  TIMESTAMP_DIFF(
    MAX(delivered_time), MIN(accepted_time), MILLISECOND
  ) AS latency_ms
FROM (
    SELECT event_timestamp AS accepted_time
    FROM `project ID.firebase_messaging.data`
    WHERE
      _PARTITIONTIME = TIMESTAMP('date as YYYY-MM-DD')
      AND message_id = 'your message id'
      AND instance_id = 'your instance id'
      AND event = 'MESSAGE_ACCEPTED'
  ) sent
  CROSS JOIN (
    SELECT event_timestamp AS delivered_time
    FROM `project ID.firebase_messaging.data`
    WHERE
      _PARTITIONTIME = TIMESTAMP('date as YYYY-MM-DD') AND
      message_id = 'your message id' AND instance_id = 'your instance id'
      AND (event = 'MESSAGE_DELIVERED'
  ) delivered;