Protokol HTTP Firebase Cloud Messaging

Parameter ini menetapkan penerima pesan.

Nilainya dapat berupa token pendaftaran perangkat, kunci notifikasi grup perangkat, atau topik tunggal (diawali dengan /topics/). Untuk mengirim ke beberapa topik, gunakan parameter condition.

Parameter ini menentukan penerima pesan multicast, yakni pesan yang dikirim ke lebih dari satu token pendaftaran.

Nilainya harus berupa array token pendaftaran yang akan menjadi tujuan pengiriman pesan multicast. Array harus memuat minimal 1 dan maksimal 1.000 token pendaftaran. Untuk mengirim pesan ke satu perangkat, gunakan parameter to.

Pesan multicast hanya diperbolehkan menggunakan format HTTP JSON.

Parameter ini menetapkan ekspresi logis kondisi yang menentukan target pesan.

Kondisi yang didukung: Topik, yang diformat sebagai "'yourTopic' in topic". Nilai ini tidak peka huruf besar/kecil.

Operator yang didukung: &&, ||. Maksimum dua operator per pesan topik yang didukung.

Parameter ini tidak digunakan lagi. Sebaliknya, gunakan to untuk menentukan penerima pesan. Untuk mengetahui informasi lebih lanjut mengenai cara mengirimkan pesan ke beberapa perangkat, baca dokumentasi untuk platform Anda.

Parameter ini mengidentifikasi grup pesan (misalnya, dengan collapse_key: "Updates Available") yang dapat diciutkan, sehingga hanya pesan terakhir yang akan dikirim ketika pengiriman dapat dilanjutkan. Hal ini dimaksudkan untuk mencegah pengiriman terlalu banyak pesan yang sama ketika perangkat kembali online atau aktif.

Perlu diperhatikan bahwa urutan pesan yang akan dikirim tidak dijamin.

Catatan: Maksimum 4 kunci penciutan berbeda diizinkan pada waktu tertentu. Artinya, FCM dapat menyimpan empat pesan berbeda secara bersamaan per aplikasi klien. Jika Anda melebihi jumlah ini, tidak ada jaminan manakah dari empat kunci penciutan ini yang akan disimpan oleh FCM.

Menetapkan prioritas pesan. Nilai yang valid adalah "normal" dan "high". Di platform Apple, hal ini sesuai dengan prioritas APN 5 dan 10.

Secara default, pesan notifikasi dikirim dengan prioritas tinggi dan pesan data dikirim dengan prioritas normal. Prioritas normal mengoptimalkan konsumsi baterai aplikasi klien dan sebaiknya digunakan kecuali jika diperlukan pengiriman dengan segera. Untuk pesan dengan prioritas normal, aplikasi dapat menerima pesan dengan penundaan yang tidak ditetapkan.

Jika dikirim dengan prioritas tinggi, pesan akan dikirim dengan segera dan aplikasi dapat menampilkan notifikasi.

Pada platform Apple, gunakan kolom ini untuk mewakili content-available dalam payload APN. Saat notifikasi atau pesan dikirim dan parameter ini disetel ke true, aplikasi klien yang tidak aktif akan diaktifkan, serta pesan akan dikirim melalui APN sebagai notifikasi diam dan tidak melalui FCM. Perhatikan bahwa notifikasi diam pada APN tidak dijamin akan dikirim, dan dapat bergantung pada faktor-faktor seperti apakah pengguna mengaktifkan Mode Daya Rendah atau tidak, menghentikan aplikasi secara paksa, dll. Pada Android, pesan data akan mengaktifkan aplikasi secara default. Pada Chrome, saat ini belum didukung.

Di platform Apple, gunakan kolom ini untuk mewakili mutable-content dalam payload APN. Jika notifikasi dikirim dan parameter ini ditetapkan ke true, isi notifikasi dapat dimodifikasi sebelum ditampilkan dengan menggunakan ekstensi aplikasi Notification Service. Parameter ini akan diabaikan untuk Android dan web.

Parameter ini menetapkan berapa lama (dalam detik) pesan harus disimpan dalam penyimpanan FCM jika perangkat sedang offline. Waktu aktif maksimum yang didukung adalah 4 minggu, dan nilai defaultnya adalah 4 minggu. Untuk informasi lebih lanjut, lihat Menetapkan masa aktif pesan.

Jika disetel ke true, parameter ini memungkinkan developer untuk menguji permintaan tanpa benar-benar mengirim pesan.

Nilai defaultnya adalah false.

Parameter ini menetapkan key-value pair kustom pada payload pesan.

Misalnya, dengan data:{"score":"3x1"}:

Pada platform Apple, jika pesan dikirim melalui APN, pesan tersebut mewakili kolom data kustom. Jika dikirim melalui FCM, pesan akan direpresentasikan sebagai kamus nilai kunci dalam AppDelegate application:didReceiveRemoteNotification:.

Pada Android, ini akan menghasilkan ekstra intent bernama score dengan nilai string 3x1.

Kunci tidak boleh berupa kata yang telah digunakan ("from" atau "message_type", atau kata apa pun yang dimulai dengan "google" atau "gcm"). Jangan gunakan kata apa pun yang didefinisikan dalam tabel ini (seperti collapse_key).

Nilai dalam jenis string direkomendasikan. Anda harus mengonversi nilai dalam objek atau jenis data non-string lainnya (misalnya, bilangan bulat atau boolean) menjadi string.

Judul notifikasi.

Kolom ini tidak ditampilkan di ponsel dan tablet.

Teks isi notifikasi.

Suara yang diputar saat perangkat menerima notifikasi.

String yang menentukan file suara dalam paket utama aplikasi klien atau dalam folder Library/Sounds di container data aplikasi. Lihat Library Developer iOS untuk informasi selengkapnya.

Nilai badge pada ikon aplikasi layar utama.

Jika tidak ditentukan, badge tidak diubah.

Jika disetel ke 0, badge dihapus.

Tindakan yang terkait dengan klik pengguna pada notifikasi.

Terkait dengan category dalam payload APN.

Subjudul notifikasi.

Kunci ke string isi di dalam resource string aplikasi yang akan digunakan untuk melokalkan teks isi ke bahasa pengguna saat ini.

Terkait dengan loc-key dalam payload APN.

Baca Referensi Kunci Payload dan Melokalkan Isi Notifikasi Jarak Jauh untuk mengetahui informasi selengkapnya.

Nilai string variabel yang akan digunakan sebagai pengganti penentu format dalam body_loc_key untuk melokalkan teks isi ke bahasa pengguna saat ini.

Terkait dengan loc-args dalam payload APN.

Baca Referensi Kunci Payload dan Melokalkan Isi Notifikasi Jarak Jauh untuk mengetahui informasi selengkapnya.

Kunci untuk string judul di dalam resource string aplikasi yang akan digunakan untuk melokalkan teks judul ke bahasa pengguna saat ini.

Terkait dengan title-loc-key dalam payload APN.

Baca Referensi Kunci Payload dan Melokalkan Isi Notifikasi Jarak Jauh untuk mengetahui informasi selengkapnya.

Nilai string variabel yang akan digunakan sebagai pengganti penentu format dalam title_loc_key untuk melokalkan teks judul ke bahasa pengguna saat ini.

Terkait dengan title-loc-args dalam payload APN.

Baca Referensi Kunci Payload dan Melokalkan Isi Notifikasi Jarak Jauh untuk mengetahui informasi selengkapnya.

Judul notifikasi.

Teks isi notifikasi.

ID saluran notifikasi (baru di Android O).

Aplikasi harus membuat saluran dengan ID saluran ini sebelum menerima notifikasi apa pun dengan ID saluran ini.

Jika Anda tidak mengirim ID saluran ini pada permintaan, atau jika ID saluran yang disediakan belum dibuat oleh aplikasi, FCM akan menggunakan ID saluran yang ditentukan dalam manifes aplikasi.

Ikon notifikasi.

Menyetel ikon notifikasi ke myicon untuk resource drawable myicon. Jika Anda tidak mengirim kunci ini dalam permintaan, maka FCM akan menampilkan ikon peluncur yang ditentukan dalam manifes aplikasi.

Suara yang diputar saat perangkat menerima notifikasi.

Mendukung "default" atau nama file resource suara yang dipaketkan dalam aplikasi. File suara harus berada di /res/raw/.

ID yang digunakan untuk mengganti notifikasi yang ada di panel samping notifikasi.

Jika tidak ditentukan, setiap permintaan akan membuat notifikasi baru.

Jika ditentukan dan notifikasi dengan tag yang sama telah ditampilkan, notifikasi yang baru akan menggantikan notifikasi lama di panel samping notifikasi.

Warna ikon notifikasi, dinyatakan dalam format #rrggbb.

Tindakan yang terkait dengan klik pengguna pada notifikasi.

Jika ditentukan, aktivitas dengan filter intent yang cocok akan diluncurkan ketika pengguna mengklik notifikasi.

Kunci untuk string isi di dalam resource string aplikasi yang akan digunakan untuk melokalkan teks isi ke bahasa pengguna saat ini.

Lihat Resource String untuk informasi lebih lanjut.

Nilai string variabel yang akan digunakan sebagai pengganti penentu format dalam body_loc_key untuk melokalkan teks isi ke bahasa pengguna saat ini.

Lihat Pengaturan Format dan Gaya untuk informasi lebih lanjut.

Kunci untuk string judul di dalam resource string aplikasi yang akan digunakan untuk melokalkan teks judul ke bahasa pengguna saat ini.

Lihat Resource String untuk informasi lebih lanjut.

Nilai string variabel yang akan digunakan sebagai pengganti penentu format dalam title_loc_key untuk melokalkan teks judul ke bahasa pengguna saat ini.

Lihat Pengaturan Format dan Gaya untuk informasi lebih lanjut.

Judul notifikasi.

Teks isi notifikasi.

URL yang akan digunakan untuk ikon notifikasi.

Tindakan yang terkait dengan klik pengguna pada notifikasi.

Untuk semua nilai URL, HTTPS diwajibkan.

Parameter ini menetapkan aplikasi klien (token pendaftaran) yang menerima pesan.

Pengiriman pesan multicast (mengirim ke lebih dari 1 token pendaftaran) hanya diizinkan menggunakan format HTTP JSON.

Parameter ini menetapkan key-value pair payload pesan. Tidak ada batas jumlah pada parameter nilai kunci, tetapi ada batas ukuran pesan total sebesar 4.096 byte.

Misalnya, pada Android, "data.score"."3x1" akan menghasilkan ekstra intent bernama score dengan nilai string 3x1.

Kunci tidak boleh berupa kata yang telah digunakan ("from" atau "message_type", atau kata apa pun yang dimulai dengan "google" atau "gcm"). Jangan gunakan kata apa pun yang didefinisikan dalam tabel ini (seperti collapse_key).

• message_id: String yang menetapkan ID unik untuk setiap pesan yang berhasil diproses.
• error: String yang menetapkan kesalahan yang terjadi ketika memproses pesan untuk penerima. Kemungkinan nilai dapat dilihat di tabel 9.

• Jika aplikasi klien membatalkan pendaftaran di FCM.
• Jika pendaftaran aplikasi klien dibatalkan secara otomatis, yang bisa terjadi jika pengguna meng-uninstal aplikasi. Misalnya, pada iOS, jika Layanan Masukan APN melaporkan token APN sebagai tidak valid.
• Jika masa berlaku token pendaftaran habis (misalnya, Google mungkin memutuskan untuk memperbarui token pendaftaran, atau masa berlaku token APN habis untuk perangkat iOS).
• Jika aplikasi klien diupdate tetapi versi yang baru belum dikonfigurasi untuk menerima pesan.

• Header otorisasi tidak ada atau memiliki sintaksis tidak valid dalam permintaan HTTP.
• Project Firebase yang mencakup kunci server yang ditentukan adalah project yang salah.
• Hanya kunci server lama — permintaan berasal dari server yang tidak termasuk dalam daftar aman pada IP kunci Server.

Server tidak bisa memproses permintaan secara tepat waktu. Coba lagi permintaan yang sama, tetapi Anda harus:

• Mematuhi header Retry-After jika dimasukkan dalam respons dari Server Koneksi FCM.
• Menerapkan back-off eksponensial dalam mekanisme percobaan ulang. (misalnya, jika Anda menunggu 1 detik sebelum percobaan pertama, tunggu minimal 2 detik sebelum percobaan berikutnya, kemudian 4 detik dan seterusnya). Jika Anda mengirim beberapa pesan, tunda setiap pesan secara terpisah dengan jumlah acak tambahan agar tidak mengeluarkan permintaan baru untuk semua pesan secara bersamaan.

Pengirim yang menyebabkan masalah berisiko dimasukkan ke daftar hitam.

Rasio pesan terhadap perangkat tertentu terlalu tinggi. Jika aplikasi Apple mengirim pesan dengan jumlah yang melebihi batas APN, pesan error ini mungkin akan ditampilkan.

Kurangi jumlah pesan yang dikirim ke perangkat ini dan gunakan backoff eksponensial untuk mencoba mengirimkan pesan lagi.