體驗通知是讓已選擇加入的年齡13歲以上用戶透過及時的個性化通知來跟上他們最喜愛遊戲的一種方式。作為開發者,您可以決定哪些遊戲內活動最重要,以便通知用戶,以及定義通知內容。


在收到通知後,使用者可以透過 加入 按鈕直接加入體驗,並根據您的 啟動數據 進行重生。
有關功能、資格要求、使用指南及相應的 Engine API 的詳細信息,請參見 體驗指南。
實作
UserNotification 資源讓您可以向使用者發送體驗通知。在使用之前,您必須 生成 API 密鑰 或 配置 OAuth 2.0 供您的應用使用。本頁面上的示例使用 API 密鑰。
要向使用者發送體驗通知:
- 組成請求:
- 將 API 密鑰複製到 x-api-key 請求標頭中。
- 將通知字符串資產 ID 複製為 payload.message_id 屬性的值。
- 將 payload.type 設定為 "MOMENT"。
- 將 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} 分的高分紀錄!是時候升級了?
在腳本中添加 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": "測試啟動數據"
},
"analytics_data": {
"category": "測試分析類別"
}
}'速率限制和交付
每位使用者每天可以從特定體驗收取 一 條通知,當使用者達到流量限制時,您會收到透明的反饋。
還有許多其他原因可能導致通知未能送達。欲了解更多信息,請參見 Engine 指南中的 交付系統。