Понимание доставки сообщений

 {
  "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 предоставляют информацию о результатах запросов сообщений. Все категории являются взаимоисключающими. Они могут ответить на такие вопросы, как «Доставляются ли мои сообщения?» и «Что вызывает потерю сообщений?».

For example, a high value for the droppedTooManyPendingMessages field could signal that app instances are receiving volumes of non-collapsible messages exceeding FCM 's limit of 100 pending messages. To mitigate this, make sure your app handles calls to onDeletedMessages , and consider sending collapsible messages. Similarly, high percentages for droppedDeviceInactive could be a signal to update registration tokens on your server, removing stale tokens and unsubscribing them from topics. See Manage FCM registration tokens for best practices in this area.

Процент выполнения доставки

The fields in the DeliveryPerformancePercents object provide information about messages that were successfully delivered. It can answer questions such as "Were my messages delayed?" and "Why are messages delayed?" For example, a high value for delayedMessageThrottled would clearly indicate that you are exceeding per-device maximum limits , and should adjust the rate at which you are sending messages.

Процентное соотношение анализа сообщений

This object provides additional information about all message sends. The priorityLowered field expresses the percentage of accepted messages that had priority lowered from HIGH to NORMAL . If this value is high, try sending fewer high priority messages or ensure that you always display a notification when a high priority message is sent. See our documentation on message priority for more info

Чем эти данные отличаются от данных, экспортированных в BigQuery?

Экспорт данных из BigQuery предоставляет журналы отдельных сообщений, отражающие их принятие бэкэндом FCM и доставку в SDK на устройстве (шаги 2 и 4 архитектуры FCM ). Эти данные полезны для проверки того, были ли приняты и доставлены отдельные сообщения. Подробнее об экспорте данных из BigQuery читайте в следующем разделе.

By contrast, the Firebase Cloud Messaging Data API provides aggregated details about what happens specifically in the Android Transport Layer (or Step 3 of the FCM Architecture ). This data specifically provides insight into the delivery of messages from FCM backends to the Android SDK. It's particularly useful for showing trends as to why messages were delayed or dropped during this transport.

В некоторых случаях возможно, что два набора данных не будут точно совпадать по следующим причинам:

• Сводные метрики отражают лишь часть всех сообщений.
• Сводные показатели округлены.
• Мы не публикуем показатели, не соответствующие установленному уровню конфиденциальности.
• Часть результатов обработки сообщений отсутствует из-за оптимизации способов управления большим объемом трафика.

Ограничения API

Сводные временные шкалы данных

The API will return 7 days of historical data; however, data returned by this API will be delayed by up to 5 days. For example, on January 20th, the data for January 9th - January 15th would be available, but not for January 16th or later. Additionally, the data is provided at best effort. In the event of a data outage, FCM will work to fix forward and won't backfill the data after the issue is fixed. In larger outages, the data could be unavailable for a week or more.

Покрытие данных

Метрики, предоставляемые API данных Firebase Cloud Messaging, призваны дать представление об общих тенденциях доставки сообщений. Однако они не обеспечивают 100% охвата всех сценариев обмена сообщениями. Следующие сценарии представляют собой известные результаты, не отраженные в метриках.

Устаревшие сообщения

Если время жизни (TTL) истекает после окончания указанной даты в журнале, сообщение не будет считаться отброшенным как droppedTtlExpired в эту дату.

Сообщения на неактивные устройства

Сообщения, отправленные на неактивные устройства, могут отображаться или не отображаться в наборе данных в зависимости от выбранного пути передачи данных. Это может привести к ошибкам в подсчете в полях droppedDeviceInactive и pending .

Сообщения на устройства с определенными пользовательскими настройками.

В соответствии с предпочтениями пользователей, отключивших сбор информации об использовании и диагностике на своих устройствах, их сообщения не будут учитываться в нашем подсчете.

Округление и минимальные значения

Компания FCM намеренно округляет и исключает данные, где объемы недостаточно велики.

экспорт данных BigQuery

Вы можете экспортировать данные сообщений в BigQuery для дальнейшего анализа. BigQuery позволяет анализировать данные с помощью BigQuery SQL, экспортировать их в другой облачный провайдер или использовать данные для ваших собственных моделей машинного обучения. Экспорт в BigQuery включает все доступные данные для сообщений, независимо от типа сообщения или от того, отправлено ли сообщение через API или через редактор уведомлений.

Для сообщений, отправляемых на устройства со следующими минимальными версиями FCM SDK, у вас есть дополнительная возможность включить экспорт данных о доставке сообщений для вашего приложения:

• Android 20.1.0 или выше.
• iOS 8.6.0 или выше
• Firebase Web SDK 12.14.0 или выше

Для начала свяжите свой проект с BigQuery с помощью консоли Firebase :

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;