概要
方法
GenerateItemListAsync(generateRecommendationItemListRequest: Dictionary):RecommendationPages |
GetRecommendationItemAsync(itemId: string):Dictionary |
LogActionEvent(actionType: Enum.RecommendationActionType,itemId: string,tracingId: string,actionEventDetails: Dictionary):() |
LogImpressionEvent(impressionType: Enum.RecommendationImpressionType,itemId: string,tracingId: string,impressionEventDetails: Dictionary):() |
LogPreferenceEvent(preferenceType: Enum.RecommendationPreferenceType,targetType: Enum.RecommendationPreferenceTargetType,targetId: string,tracingId: string,itemId: string):() |
RegisterItemAsync(player: Player,registerRecommendationItemsRequest: Dictionary):Dictionary |
RemoveItemAsync(itemId: string):() |
UpdateItemAsync(updateRecommendationItemRequest: Dictionary):() |
API 參考
方法
GenerateItemListAsync
RecommendationService:GenerateItemListAsync(generateRecommendationItemListRequest:Dictionary):RecommendationPages
參數
範例程式碼
生成推薦物品清單
local RecommendationService = game:GetService("RecommendationService")
-- 定義生成推薦清單的請求
local request: GenerateRecommendationItemListRequest = {
ConfigName = "MaximizeEngagement",
LocationId = "Lobby",
PageSize = 10
-- 注意:取消註解並設定 CustomContexts.UserId 用於伺服器腳本。
-- 本地腳本不需要設定。
-- CustomContexts = {
-- ["UserId"] = tostring(player.UserId),
-- }
}
-- 呼叫 GenerateItemListAsync 獲取推薦頁面
local success, recommendationPages = pcall(function()
return RecommendationService:GenerateItemListAsync(request)
end)GetRecommendationItemAsync
參數
範例程式碼
獲取單個推薦項目
local RecommendationService = game:GetService("RecommendationService")
local function getItem(itemId)
local success, item = pcall(function()
return RecommendationService:GetRecommendationItemAsync(itemId)
end)
if success and item then
print("成功獲取項目: " .. item.ItemId)
print(" ReferenceId: " .. item.ReferenceId)
-- 在直接獲取單個項目時,TracingId 將為空
if item.Creator then
print(" CreatorId: " .. tostring(item.Creator.CreatorId))
end
if item.CustomTags then
print(" CustomTags: ")
for _, customTag in ipairs(item.CustomTags) do
print(" " .. customTag)
end
end
else
warn("無法獲取項目: " .. itemId .. ". 錯誤: " .. tostring(item))
end
end
-- 示例用法(需要有效的 itemId)
-- getItem("some-item-id")LogActionEvent
RecommendationService:LogActionEvent(
actionType:Enum.RecommendationActionType, itemId:string, tracingId:string, actionEventDetails:Dictionary
):()
參數
| 預設值:"nil" |
返回
()
範例程式碼
記錄用戶行為
local RecommendationService = game:GetService("RecommendationService")
local function logLike(itemId, tracingId)
local detail: RecommendationActionEventDetails = {
ReactionType = "喜歡",
Weight = 1.0
}
RecommendationService:LogActionEvent(Enum.RecommendationActionType.AddReaction, itemId, tracingId, detail)
print("已記錄 '喜歡' 行為,項目: " .. itemId)
end
-- 示例用法(需要有效的 itemId 和 tracingId 來自 GenerateItemListAsync)
-- logLike("item-id", "tracing-id")LogImpressionEvent
RecommendationService:LogImpressionEvent(
impressionType:Enum.RecommendationImpressionType, itemId:string, tracingId:string, impressionEventDetails:Dictionary
):()
參數
| 預設值:"nil" |
返回
()
範例程式碼
記錄使用者印象
local RecommendationService = game:GetService("RecommendationService")
local function logView(itemId, tracingId)
local detail: RecommendationImpressionEventDetails = {
Duration = 5, -- 使用者查看了 5 秒
ItemPosition = 1,
DepartureIntent = Enum.RecommendationDepartureIntent.Neutral
}
RecommendationService:LogImpressionEvent(Enum.RecommendationImpressionType.View, itemId, tracingId, detail)
print("已記錄 '查看' 印象的項目: " .. itemId)
end
-- 示範使用 (需要有效的 itemId 和 tracingId 由 GenerateItemListAsync 提供)
-- logView("some-item-id", "some-tracing-id")LogPreferenceEvent
RecommendationService:LogPreferenceEvent(
preferenceType:Enum.RecommendationPreferenceType, targetType:Enum.RecommendationPreferenceTargetType, targetId:string, tracingId:string, itemId:string
):()
參數
返回
()
RegisterItemAsync
RecommendationService:RegisterItemAsync(
參數
範例程式碼
註冊新物品
local RecommendationService = game:GetService("RecommendationService")
local storage = game:GetService("ReplicatedStorage")
-- 假設在 ReplicatedStorage 中存在一個名為 'RegisterItemRemote' 的 RemoteFunction
local registerItemRemote = storage.RegisterItemRemote
registerItemRemote.OnServerInvoke = function(player, refId)
local request: RegisterRecommendationItemRequest = {
ContentType = Enum.RecommendationItemContentType.Dynamic,
ReferenceId = refId,
Duration = 60,
Visibility = Enum.RecommendationItemVisibility.Public,
CustomTags = {"locale:en-us", "seasonal:summer"},
Attributes = {
{
AssetId = 123,
Description = "測試視頻",
TrimStartTime = 0,
TrimEndTime = 10.5
}
}
}
local success, response = pcall(function()
return RecommendationService:RegisterItemAsync(player, request)
end)
if success and response then
print("成功註冊物品。物品ID: " .. response.ItemId)
return response.ItemId
else
warn("註冊物品失敗。錯誤: " .. tostring(response))
return nil
end
endRemoveItemAsync
參數
返回
()
範例程式碼
移除項目
local RecommendationService = game:GetService("RecommendationService")
local function removeItem(itemId)
local success, err = pcall(function()
return RecommendationService:RemoveItemAsync(itemId)
end)
if success then
print("成功移除項目: " .. itemId)
else
warn("移除項目失敗: " .. itemId .. ". 錯誤: " .. tostring(err))
end
endUpdateItemAsync
參數
返回
()
範例程式碼
更新項目
local RecommendationService = game:GetService("RecommendationService")
local function updateItem(itemId)
-- 只包括你想要更新的字段
local request: UpdateRecommendationItemRequest = {
ItemId = itemId,
Visibility = Enum.RecommendationItemVisibility.Private,
-- 注意: 整個 CustomTags 列表將被這個新列表替換
CustomTags = {"updated-tag"}
}
local success, err = pcall(function()
return RecommendationService:UpdateItemAsync(request)
end)
if success then
print("成功更新項目: " .. itemId)
else
warn("無法更新項目: " .. itemId .. ". 錯誤: " .. tostring(err))
end
end
-- 示例用法
-- updateItem("some-item-id-to-update")