実は似たような記事を以前にも投稿しましたが、今回はメッセージを送付する際のHTTP構文についてです。
というのも、送信メッセージやタイトルを変えるだけならまだしも、パラメータを変更したり、追加・削除するときに毎回調べていたので、いい加減自分のためにまとめようと思ったからです。
そのため、この記事は私的重要ポイントのみをまとめてあります。
ご了承ください。
ちなみに、以前の記事はこちら。
【PHP】FireBase Cloud Messagingを利用したプッシュ通知をPHPから送る方法 – 株式会社シーポイントラボ｜浜松のシステム開発会社
https://cpoint-lab.co.jp/article/201810/【php】fireBase-cloud-messagingを利用したプッシュ通知をphpから送る/
さて、まず Firebase の公式サイトのHTTP プロトコルについてのページがこちら。
Firebase Cloud Messaging の HTTP プロトコル｜Firebase
https://firebase.google.com/docs/cloud-messaging/http-server-ref?authuser=0
このページですら毎回検索して探すので、こうしてまとめたかったというのが主ですね。
次に、各項目について。
送信先を指定するパラメータ to について、その具体的な指定値です。
| 指定値 | 対象 |
| /topics/all | 全端末に送信 |
| /topics/android | Android端末にのみ送信 |
| /topics/ios | iOS端末にのみ送信 |
| /topics/[トピック名] | 特定のトピックに登録されている端末にのみ送信 |
| [デバイストークン] | 特定の端末 |
こちらに関しては、特に説明不要かと思います。
送信先を指定したい場合、こちらの to の値を変更しますが、例が載っていなかったので、よく使いそうなもののみを抜粋しました。
次は dry_run というパラメータです。
こちらは未指定の場合のデフォルトは false になっています。
このパラメータを true にすると、実際にプッシュ通知を送らずに、レスポンス結果を取得することができます。
送信のテスト時に使うパラメータですね。
あとは、badge という、ホーム画面のアイコンにバッヂを追加するためのパラメータです。
こちらにバッヂの値を指定すると、プッシュ通知を受信した時にバッヂが追加されます。
なお、0 を指定すると、バッヂは削除されます。
よく使うのはこのあたりでしょうか。
他にも、Androidのみの設定で icon というパラメータでプッシュ用のアイコン画像を指定できます。
これがないと、アイコンが白い四角形になってしまい非常に味気ないので、Android アプリに通知を送る際は指定したほうが良さそうです。
以上、FCM でメッセージを送付する際のHTTP構文についてでした。
なお、レスポンスデータについては、上で挙げた Firebase の公式サイトのHTTP プロトコルについてのページの下の方に載っているので、こちらも参考にしてください。
