Thông báo của người dùng

Thông báo trải nghiệm là một cách để chọn lựa chọn người dùng tuổi 13+ duy trì các trải nghiệm yêu thích của họ thông qua các thông báo cá nhân hóa thời gian thích hợp.Với tư cách là nhà phát triển, bạn có thể xác định các loại hoạt động trong kinh nghiệm nào là quan trọng nhất để thông báo cho người dùng của bạn, cũng như xác định nội dung thông báo.

Sau khi nhận được thông báo, người dùng có thể tham gia trực tiếp vào trải nghiệm thông qua nút Tham gia và xuất hiện theo dữ liệu phóng ra của bạn .

Để biết thêm thông tin về các tính năng, yêu cầu đủ điều kiện, hướng dẫn sử dụng và API Động cơ tương ứng, hãy xem hướng dẫn Trải nghiệm.

Thực hiện

Tài nguyên Thông báo người dùng cho phép bạn gửi thông báo trải nghiệm cho người dùng.Trước khi sử dụng nó, bạn phải tạo một chìa khóa API hoặc cấu hình OAuth 2.0 cho ứng dụng của bạn.Ví dụ trên trang này sử dụng chìa khóa API.

Để gửi thông báo trải nghiệm cho một người dùng:

1. Tạo một chuỗi thông báo trong Bảng điều khiển Nhà sáng tạo.Bước này phải được thực hiện trong Bảng điều khiển Nhà sáng tạo; không có Open Cloud API cho nó.
2. Hình thành yêu cầu:

   1. Sao chép chìa khóa API vào tiêu đề yêu cầu x-api-key.
   2. Sao chép ID chuỗi thông báo như giá trị của thuộc tính payload.message_id.
   3. Set payload.type đến "MOMENT".
   4. Set source.universe để trở thành URL tài nguyên vũ trụ "universes/${UniverseID}" .

Gửi thông báo trải nghiệm
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"
	}
}'

Ví dụ phản hồi trả về ID thông báo trong trường id:

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

Tùy chỉnh thông báo bằng cách sử dụng tham số

Để tùy chỉnh thông báo cho mỗi người nhận, bao gồm tham số trong chuỗi thông báo .Sau đó tùy chỉnh các tham số khi gọi API.Ví dụ, bạn có thể xác định chuỗi thông báo như:

Thêm các tham số userId-friend và points trong kịch bản:

Tùy chỉnh thông báo bằng cách sử dụng tham số
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"}
		}
	}
}'

Bao gồm dữ liệu khởi động và phân tích

Để cải thiện thêm trải nghiệm người dùng, bạn có thể bao gồm dữ liệu khởi động trong thông báo, hữu ích cho các tình huống như chuyển hướng người dùng đến vị trí phối hợp hoặc tùy chỉnh trải nghiệm tham gia.Ngoài ra, bạn có thể bao gồm dữ liệu phân tích để phân đoạn hiệu suất của các loại thông báo khác nhau.

Bao gồm dữ liệu khởi chạy và dữ liệu phân tích
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"
	}
}'

Giới hạn tỷ lệ và giao hàng

Mỗi người dùng có thể nhận được một thông báo mỗi ngày từ một trải nghiệm nhất định, và bạn nhận được phản hồi minh bạch khi giới hạn tốc độ của người dùng đạt đến.

Có nhiều lý do khác có thể khiến thông báo không được gửi. Để biết thêm thông tin, xem Hệ thống giao hàng trong hướng dẫn Động cơ.