Notifikasi pengguna

Pemberitahuan pengalaman adalah cara bagi pengguna yang memilih pengguna berusia 13+ tahun untuk tetap mengikuti pengalaman favorit mereka melalui pemberitahuan tepat waktu dan personalisasi.Sebagai pengembang, Anda dapat menentukan jenis aktivitas dalam pengalaman mana yang paling penting untuk memberi tahu pengguna Anda, serta menentukan konten pemberitahuan.

Setelah mereka menerima notifikasi, pengguna dapat bergabung dengan pengalaman langsung melalui tombol Bergabung dan muncul sesuai dengan data peluncuran Anda.

Untuk informasi lebih lanjut tentang fitur, persyaratan kelayakan, panduan penggunaan, dan Engine APIyang sesuai, lihat panduan Pengalaman.

Implementasi

Sumber daya Notifikasi Pengguna memungkinkan Anda mengirim pemberitahuan pengalaman kepada pengguna.Sebelum menggunakannya, Anda harus menghasilkan kunci API atau mengkonfigurasi OAuth 2.0 untuk aplikasi Anda.Contoh di halaman ini menggunakan kunci API.

Untuk mengirim pemberitahuan pengalaman kepada pengguna:

1. Buat string pemberitahuan di Dashboard Pencipta.Langkah ini harus dilakukan di Dasbor Kreator; tidak ada API Cloud Terbuka untuk itu.
2. Bentuk permintaan:

   1. Salin kunci API ke header permintaan x-api-key .
   2. Salin ID string notifikasi sebagai nilai properti payload.message_id.
   3. Atur payload.type ke "MOMENT" .
   4. Tetapkan source.universe untuk menjadi URL sumber daya alam semesta "universes/${UniverseID}" .

Kirim pemberitahuan notifikasi
curl --location 'https://apis.roblox.com/cloud/v2/users/${UserId}/notifications' \
--header 'x-api-key: ${ApiKey}' \
--header 'Content-Type: application/json' \
--data '{
	"source": {
		"universe": "universes/${UniverseID}"
	},
	"payload": {
		"message_id": "${AssetID}",
		"type": "MOMENT"
	}
}'

Contoh respons yang mengembalikan ID pemberitahuan di bidang id:

{
  "path": "users/505306092/notifications/6ca4d981-36fa-4255-82a1-14d95c116889",
  "id": "6ca4d981-36fa-4255-82a1-14d95c116889"
}

Sesuaikan pemberitahuan menggunakan parameter

Untuk menyesuaikan pemberitahuan untuk setiap penerima, termasuk parameter dalam string pemberitahuan.Kemudian kustomisasi parameter saat memanggil API.Sebagai contoh, Anda dapat mendefinisikan string pemberitahuan sebagai:

Tambahkan parameter userId-friend dan points dalam skrip:

Sesuaikan Notifikasi Menggunakan Parafrasa
curl --location 'https://apis.roblox.com/cloud/v2/users/${UserId}/notifications' \
--header 'x-api-key: ${ApiKey}' \
--header 'Content-Type: application/json' \
--data '{
	"source": {
		"universe": "universes/${UniverseID}"
	},
	"payload": {
		"message_id": "${AssetID}",
		"type": "MOMENT",
		"parameters": {
			"userId-friend": {"int64_value": 3702832553},
			"points": {"string_value": "5"}
		}
	}
}'

Termasuk data peluncuran dan analisis

Untuk meningkatkan pengalaman pengguna lebih lanjut, Anda dapat menyertakan data peluncuran dalam pemberitahuan, berguna untuk skenario seperti merute pengguna ke lokasi koordinat atau menyesuaikan pengalaman bergabung.Selain itu, Anda dapat menyertakan data analisis untuk membagi kinerja kategori notifikasi yang berbeda.

Terdiri dari Data Peluncuran dan Data Analisis
curl --location 'https://apis.roblox.com/cloud/v2/users/${UserId}/notifications' \
--header 'x-api-key: ${ApiKey}' \
--header 'Content-Type: application/json' \
--data '{
	"source": {
		"universe": "universes/${UniverseID}"
	},
	"payload": {
		"message_id": "${AssetID}",
		"type": "MOMENT"
	},
	"join_experience": {
		"launch_data": "Test_Launch_Data"
	},
	"analytics_data": {
		"category": "Test_Analytics_Category"
	}
}'

Batas tingkat dan pengiriman

Setiap pengguna dapat menerima satu pemberitahuan per hari dari pengalaman tertentu, dan Anda menerima umpan balas transparan saat batas pembatasan throttle pengguna tercapai.

Ada banyak alasan lain mengapa pemberitahuan mungkin tidak dikirim. Untuk informasi lebih lanjut, lihat Sistem pengiriman di panduan Mesin.