Learn
Engine Class
RecommendationService
Not Creatable
Service

Summary
Methods
GenerateItemListAsync(generateRecommendationItemListRequest: Dictionary):RecommendationPages
LogActionEvent(actionType: Enum.RecommendationActionType,itemId: string,tracingId: string,actionEventDetails: Dictionary):()
LogImpressionEvent(impressionType: Enum.RecommendationImpressionType,itemId: string,tracingId: string,impressionEventDetails: Dictionary):()
RegisterItemAsync(player: Player,registerRecommendationItemsRequest: Dictionary):Dictionary
UpdateItemAsync(updateRecommendationItemRequest: Dictionary):()
Inherited Members

API Reference
Methods
GenerateItemListAsync
Yields
Capabilities: Basic
RecommendationService:GenerateItemListAsync(generateRecommendationItemListRequest:Dictionary):RecommendationPages
Parameters
generateRecommendationItemListRequest:Dictionary
Code Samples
Generate a list of recommended items
local RecommendationService = game:GetService("RecommendationService")
-- Define the request for generating a recommendation list
local request: GenerateRecommendationItemListRequest = {
ConfigName = "MaximizeEngagement",
LocationId = "Lobby",
PageSize = 10
-- NOTE: Uncomment and set CustomContexts.UserId for Server script.
-- No need to set for Local script.
-- CustomContexts = {
-- ["UserId"] = tostring(player.UserId),
-- }
}
-- Call GenerateItemListAsync to get the recommendation pages
local success, recommendationPages = pcall(function()
return RecommendationService:GenerateItemListAsync(request)
end)

GetRecommendationItemAsync
Yields
Capabilities: Basic
RecommendationService:GetRecommendationItemAsync(itemId:string):Dictionary
Parameters
itemId:string
Returns
Code Samples
Get a single recommendation item
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("Successfully retrieved item: " .. item.ItemId)
print(" ReferenceId: " .. item.ReferenceId)
-- The TracingId will be empty when fetching a single item directly
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("Failed to retrieve item: " .. itemId .. ". Error: " .. tostring(item))
end
end
-- Example usage (requires a valid itemId)
-- getItem("some-item-id")

LogActionEvent
Capabilities: Basic
RecommendationService:LogActionEvent(
actionType:Enum.RecommendationActionType, itemId:string, tracingId:string, actionEventDetails:Dictionary
):()
Parameters
itemId:string
tracingId:string
actionEventDetails:Dictionary
Default Value: "nil"
Returns
()
Code Samples
Logging a user action
local RecommendationService = game:GetService("RecommendationService")
local function logLike(itemId, tracingId)
local detail: RecommendationActionEventDetails = {
ReactionType = "Like",
Weight = 1.0
}
RecommendationService:LogActionEvent(Enum.RecommendationActionType.AddReaction, itemId, tracingId, detail)
print("Logged 'Like' action for item: " .. itemId)
end
-- Example usage (requires a valid itemId and tracingId from GenerateItemListAsync)
-- logLike("item-id", "tracing-id")

LogImpressionEvent
Capabilities: Basic
RecommendationService:LogImpressionEvent(
impressionType:Enum.RecommendationImpressionType, itemId:string, tracingId:string, impressionEventDetails:Dictionary
):()
Parameters
itemId:string
tracingId:string
impressionEventDetails:Dictionary
Default Value: "nil"
Returns
()
Code Samples
Log a user impression
local RecommendationService = game:GetService("RecommendationService")
local function logView(itemId, tracingId)
local detail: RecommendationImpressionEventDetails = {
Duration = 5, -- User viewed for 5 seconds
ItemPosition = 1,
DepartureIntent = Enum.RecommendationDepartureIntent.Neutral
}
RecommendationService:LogImpressionEvent(Enum.RecommendationImpressionType.View, itemId, tracingId, detail)
print("Logged 'View' impression for item: " .. itemId)
end
-- Example usage (requires a valid itemId and tracingId from GenerateItemListAsync)
-- logView("some-item-id", "some-tracing-id")

LogPreferenceEvent
Capabilities: Basic
RecommendationService:LogPreferenceEvent(
preferenceType:Enum.RecommendationPreferenceType, targetType:Enum.RecommendationPreferenceTargetType, targetId:string, tracingId:string, itemId:string
):()
Parameters
targetId:string
tracingId:string
itemId:string
Returns
()

RegisterItemAsync
Yields
Capabilities: Basic
RecommendationService:RegisterItemAsync(
player:Player, registerRecommendationItemsRequest:Dictionary
Parameters
player:Player
registerRecommendationItemsRequest:Dictionary
Returns
Code Samples
Register a new item
local RecommendationService = game:GetService("RecommendationService")
local storage = game:GetService("ReplicatedStorage")
-- Assume a RemoteFunction named 'RegisterItemRemote' exists in ReplicatedStorage
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 = "test video",
TrimStartTime = 0,
TrimEndTime = 10.5
}
}
}
local success, response = pcall(function()
return RecommendationService:RegisterItemAsync(player, request)
end)
if success and response then
print("Successfully registered item. ItemId: " .. response.ItemId)
return response.ItemId
else
warn("Failed to register item. Error: " .. tostring(response))
return nil
end
end

RemoveItemAsync
Yields
Capabilities: Basic
RecommendationService:RemoveItemAsync(itemId:string):()
Parameters
itemId:string
Returns
()
Code Samples
Remove an item
local RecommendationService = game:GetService("RecommendationService")
local function removeItem(itemId)
local success, err = pcall(function()
return RecommendationService:RemoveItemAsync(itemId)
end)
if success then
print("Successfully removed item: " .. itemId)
else
warn("Failed to remove item: " .. itemId .. ". Error: " .. tostring(err))
end
end

UpdateItemAsync
Yields
Capabilities: Basic
RecommendationService:UpdateItemAsync(updateRecommendationItemRequest:Dictionary):()
Parameters
updateRecommendationItemRequest:Dictionary
Returns
()
Code Samples
Update an item
local RecommendationService = game:GetService("RecommendationService")
local function updateItem(itemId)
-- Only include the fields you want to update
local request: UpdateRecommendationItemRequest = {
ItemId = itemId,
Visibility = Enum.RecommendationItemVisibility.Private,
-- NOTE: the whole CustomTags list will be replaced with this new list
CustomTags = {"updated-tag"}
}
local success, err = pcall(function()
return RecommendationService:UpdateItemAsync(request)
end)
if success then
print("Successfully updated item: " .. itemId)
else
warn("Failed to update item: " .. itemId .. ". Error: " .. tostring(err))
end
end
-- Example usage
-- updateItem("some-item-id-to-update")

©2026 Roblox Corporation. Roblox, the Roblox logo and Powering Imagination are among our registered and unregistered trademarks in the U.S. and other countries.