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

 {
  "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
    }
  }

Как интерпретировать метрики

Delivery data outlines the percentage of messages that fit each of the following metrics. It is possible that a single message fits multiple metrics. Due to limitations in how we collect the data and the level of granularity at which we aggregated the metrics, some message outcomes are not represented in the metrics at all, so the percentages below will not sum to 100%.

Подсчет принятых сообщений

The only count included in the dataset is the count of messages that were accepted by FCM for delivery to Android devices. All percentages use this value as the denominator. Keep in mind that this count won't include messages targeted to users who have disabled the collection of usage and diagnostic information on their devices.

Процент результатов сообщения

The fields included in the MessageOutcomePercents object provide information on the outcomes of message requests. The categories are all mutually exclusive. It can answer questions such as "Are my messages being delivered?" and "What is causing messages to be dropped?"

Например, высокое значение поля droppedTooManyPendingMessages может сигнализировать о том, что экземпляры приложения получают объемы несворачиваемых сообщений, превышающие лимит FCM в 100 ожидающих сообщений. Чтобы это предотвратить, убедитесь, что ваше приложение обрабатывает вызовы onDeletedMessages , и рассмотрите возможность отправки сворачиваемых сообщений. Аналогично, высокие значения поля droppedDeviceInactive могут сигнализировать о необходимости обновления токенов регистрации на вашем сервере, удаления устаревших токенов и отмены подписки на них. См. раздел «Управление токенами регистрации FCM для получения рекомендаций по этой теме.

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

Поля объекта DeliveryPerformancePercents предоставляют информацию об успешно доставленных сообщениях. Они могут ответить на такие вопросы, как «Были ли мои сообщения задержаны?» и «Почему сообщения задерживаются?». Например, высокое значение параметра delayedMessageThrottled явно указывает на превышение максимальных лимитов для каждого устройства , и следует скорректировать скорость отправки сообщений.

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

Этот объект предоставляет дополнительную информацию обо всех отправленных сообщениях. Поле priorityLowered показывает процент принятых сообщений, приоритет которых был понижен с HIGH до NORMAL . Если это значение высокое, попробуйте отправлять меньше сообщений с высоким приоритетом или убедитесь, что вы всегда отображаете уведомление при отправке сообщения с высоким приоритетом. Дополнительную информацию см. в нашей документации по приоритетам сообщений.

How does this data differ from data exported to BigQuery?

The BigQuery export provides individual message logs about message acceptance by the FCM backend and message delivery in the SDK on the device (Steps 2 and 4 of the FCM Architecture ). This data is useful for ensuring individual messages were accepted and delivered. Read more about BigQuery data export in the next section.

В отличие от этого, API данных Firebase Cloud Messaging предоставляет агрегированные сведения о том, что происходит конкретно на транспортном уровне Android (или на шаге 3 архитектуры FCM ). Эти данные позволяют получить представление о доставке сообщений от бэкэндов FCM к Android SDK. Они особенно полезны для выявления тенденций, объясняющих, почему сообщения задерживались или отбрасывались во время этой передачи.

In some cases, it is possible that the two data sets might not match precisely due to the following:

• The aggregated metrics only sample a portion of all messages
• Сводные показатели округлены.
• We don't present metrics below a privacy threshold
• A portion of message outcomes are missing due to optimizations in how we manage the large volume of traffic.

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

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

API возвращает исторические данные за 7 дней; однако данные, возвращаемые этим API, могут быть задержаны на срок до 5 дней. Например, 20 января данные за период с 9 по 15 января будут доступны, но данные за 16 января и позже будут недоступны. Кроме того, данные предоставляются по мере возможности. В случае сбоя в предоставлении данных FCM будет работать над устранением проблемы и не будет заполнять данные после ее решения. При более масштабных сбоях данные могут быть недоступны в течение недели или более.

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

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

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

If the Time To Live (TTL) expires after the end of the given log date, the message won't be counted as droppedTtlExpired on this date.

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

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

Messages to devices with certain user preferences

Users who have disabled the collection of usage and diagnostic information on their devices won't have their messages included in our counting, in keeping with their preferences.

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

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

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

You can export your message data into BigQuery for further analysis. BigQuery lets you analyze the data using BigQuery SQL, export it to another cloud provider, or use the data for your custom ML models. An export to BigQuery includes all available data for messages, regardless of message type or whether the message is sent using the API or the Notifications composer.

For messages sent to devices with the following FCM SDK minimum versions, you have the additional option to enable the export of message delivery data for your app:

• Android 20.1.0 или выше.
• iOS 8.6.0 или выше
• Firebase Web SDK 9.0.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;