使用者通知

體驗通知 是一種方法，13+用戶可以通過及時、個人化的通知來保持他們最喜歡的體驗。作為開發人員，您可以決定哪些體驗活動對於通知您的用戶最重要，並

體驗通知系統包括以追蹤中功能：

• 可以自訂參數的通知 — 完全自訂通知訊息 參數 ，例如：

  • 你的黃金鴨蛋孵化了！
  • Allie @LaterSk8er1 剛剛在東京巡演軌道上創造了你的紀錄！是時候報仇了嗎？

• 發射資料 — 包含可以閱取 發射資料 的可選 Player:GetJoinData() ，可以通過 0>Class.Player:GetJoinData()0> 當通知接收人加入時。這可能會涉及將用戶路由到坐標位置或自訂他們的加入體驗。

• 分析支援 — 跟蹤您可以觸及的觀眾和通知的性能在 創作者面板 中。

接收通知後，使用者可以直接透過 加入 按鈕加入體驗，並依照您的 發射資料 生成。

有關功能、資格要求、使用指南和對應的引擎 API 的更多信息，請參閱 體驗指南。

實施

使用者通知資源讓你向使用者發送體驗通知。在使用它之前，您必須 生成 API 鑰匙 或 配置 OAuth 2.0 以獲得您的App用程式。這個頁面上的範例使用 API 鑰匙。

要向使用者發送體驗通知：

1. 在 創作者面板 創建通知字串。此步驟必須在創作者後台中執行；沒有開放雲端 API 可用。
2. 形成請邀請：

   1. 複製 API 鑰匙到 x-api-key 請求頭。
   2. 複製通知字串資產 ID 作為 payload.message_id 屬性的值。
   3. 將 payload.type 設為 "MOMENT" 。
   4. 將 source.universe 設為宇宙資源 URL "universes/${UniverseID}" 。

傳送體驗通知
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"
	}
}'

返回通知 ID 的例子回應在 id 字段中：

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

使用參數自訂通知

要為每個收件人自訂通知，請在 通知字串 中包含 參數。然後在呼叫 API 時自訂參數。例如，您可以定義通知字串為：

在腳指令碼中添加 userId-friend 和 points 參數：

使用參數自訂通知
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"}
		}
	}
}'

包括發射和分析數據

為進一步提高使用者體驗，您可以在通知中包含 啟動資料 ，這對於路由使用者到坐標位置或個人化加入體驗非常有用。此外，您可以包含 分析 數據來區分不同類別通知的性能。

包括發射資料和分析資料
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"
	}
}'

速率限制和交付

每位使用者可以從指定體驗每天收到 一個 通知，當使用者的速度限制達到時，您會收到透明的回饋。

還有許多其他原因可能導致通知未能交付。如需了解更多信息，請參閱交付系統指南中。