Firebaseコンソールで通知ごとのCloudMessagingレポートを確認できるようにする

tl;dr

• Firebase CloudMessagingのペイロードに "analytics_label": "2020_SummerCampaign_1" のような計測用ラベルを追加する
• FirebaseコンソールのCloudMessagingレポートから、該当ラベルでフィルターした送信数、受信数、表示回数、開かれた回数を確認できる

AnalyticsLabelを追加する

Firebase CloudMessaging（以降FCMと略す）のHTTP v1 API経由でPush通知を送信する際にAnalyticsLabelを設定することで、Push通知の受信数、表示回数、開封回数を集計できるようになります。

fcmOptions.analyticsLabel

example.json

{
  "name": "Hello Shiny Summer",
  "data": { },
  "notification": { },
  "android": { },
  "webpush": { },
  "apns": { },
  "fcm_options": {
    "analytics_label": "2020_SummerCampaign_1"
  },
}

プラットフォームによって異なるAnalyticsLabelを指定したい場合は、 FcmOptions の代わりにそれぞれ AndroidFcmOptions, WebpushFcmOptions, ApnsFcmOptions でAnalyticsLabelを指定することができます。

制限事項

• ラベルの命名ルール: ^[a-zA-Z0-9-_.~%]{1,50}$
  • 半角英数字（大文字小文字）と記号 -, _, ., ~, % が使用可能
  • 最短1文字から最長50文字まで
• 1日あたり最大100種類まで指定可能
  • 100種類目以降はレポートに集計されない

参考

Adding analytics labels to messages - https://firebase.google.com/docs/cloud-messaging/understand-delivery?hl=en#adding-analytics-labels-to-messages

REST Resource: projects.messages - https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages