Pemberitahuan Pengguna

Notifikasi pengalaman adalah cara bagi pengguna yang berpartisipasi berusia 13 tahun ke atas untuk tetap terhubung dengan game favorit mereka melalui notifikasi yang cepat dan dipersonalisasi. Sebagai pengembang, Anda dapat menentukan jenis aktivitas dalam permainan yang paling penting untuk diberitahukan kepada pengguna Anda, serta mendefinisikan konten notifikasi.

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

Untuk informasi lebih lanjut tentang fitur, persyaratan kelayakan, pedoman penggunaan, dan API Mesin yang sesuai, lihat Panduan Pengalaman.

Implementasi

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

Untuk mengirim pemberitahuan pengalaman kepada pengguna:

1. Buat string pemberitahuan di Dasbor Pembuat (langkah ini harus dilakukan di Dasbor Pembuat; tidak ada API Open Cloud untuk itu).
2. Bentuk permintaan:

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

Kirim Pemberitahuan Pengalaman
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, sertakan parameter dalam string pemberitahuan. Kemudian sesuaikan parameter saat memanggil API. Misalnya, Anda dapat mendefinisikan string pemberitahuan sebagai:

Tambahkan parameter userId-friend dan points dalam skrip:

Sesuaikan Pemberitahuan Menggunakan Parameter
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"}
		}
	}
}'

Sertakan data peluncuran dan analitik

Untuk lebih meningkatkan pengalaman pengguna, Anda dapat menyertakan data peluncuran dalam pemberitahuan, berguna untuk skenario seperti merutekan pengguna ke lokasi koordinat atau mempersonalisasi pengalaman bergabung. Selain itu, Anda dapat menyertakan data analitik untuk mengelompokkan kinerja kategori pemberitahuan yang berbeda.

Sertakan Data Peluncuran dan Data Analitik
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"
	}
}'

Batasan dan pengiriman

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

Ada banyak alasan lain mengapa pemberitahuan mungkin tidak terkirim. Untuk informasi lebih lanjut, lihat Sistem Pengiriman dalam panduan Mesin.