Engine-klasse
RecommendationService
*Deze inhoud is vertaald met behulp van AI (bèta) en kan fouten bevatten. Klik hier om deze pagina in het Engels te bekijken.
Samenvatting
Methoden
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-referentie
Methoden
GenerateItemListAsync
RecommendationService:GenerateItemListAsync(generateRecommendationItemListRequest:Dictionary):RecommendationPages
Parameters
Teruggaves
Codevoorbeelden
Genereer een lijst met aanbevolen items
local RecommendationService = game:GetService("RecommendationService")
-- Definieer het verzoek voor het genereren van een aanbevelingslijst
local request: GenerateRecommendationItemListRequest = {
ConfigName = "MaximizeEngagement",
LocationId = "Lobby",
PageSize = 10
-- OPMERKING: Verwijder de opmerkingen en stel CustomContexts.UserId in voor Server-script.
-- Niet nodig om in te stellen voor Local-script.
-- CustomContexts = {
-- ["UserId"] = tostring(player.UserId),
-- }
}
-- Roep GenerateItemListAsync aan om de aanbevelingspagina's te krijgen
local success, recommendationPages = pcall(function()
return RecommendationService:GenerateItemListAsync(request)
end)GetRecommendationItemAsync
Parameters
Teruggaves
Codevoorbeelden
Krijg een enkel aanbevelingsitem
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 succesvol opgehaald: " .. item.ItemId)
print(" ReferenceId: " .. item.ReferenceId)
-- De TracingId is leeg bij het ophalen van een enkel item direct
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("Mislukt om item op te halen: " .. itemId .. ". Fout: " .. tostring(item))
end
end
-- Voorbeeldgebruik (vereist een geldige itemId)
-- getItem("some-item-id")LogActionEvent
RecommendationService:LogActionEvent(
actionType:Enum.RecommendationActionType, itemId:string, tracingId:string, actionEventDetails:Dictionary
):()
Parameters
| Standaardwaarde: nil |
Teruggaves
()
Codevoorbeelden
Een gebruikersactie loggen
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("'Like' actie gelogd voor item: " .. itemId)
end
-- Voorbeeldgebruik (vereist een geldige itemId en tracingId van GenerateItemListAsync)
-- logLike("item-id", "tracing-id")LogImpressionEvent
RecommendationService:LogImpressionEvent(
impressionType:Enum.RecommendationImpressionType, itemId:string, tracingId:string, impressionEventDetails:Dictionary
):()
Parameters
| Standaardwaarde: nil |
Teruggaves
()
Codevoorbeelden
Log een gebruikersindruk
local RecommendationService = game:GetService("RecommendationService")
local function logView(itemId, tracingId)
local detail: RecommendationImpressionEventDetails = {
Duration = 5, -- Gebruiker heeft 5 seconden bekeken
ItemPosition = 1,
DepartureIntent = Enum.RecommendationDepartureIntent.Neutral
}
RecommendationService:LogImpressionEvent(Enum.RecommendationImpressionType.View, itemId, tracingId, detail)
print("'View' indruk gelogd voor item: " .. itemId)
end
-- Voorbeeldgebruik (vereist een geldige itemId en tracingId van GenerateItemListAsync)
-- logView("some-item-id", "some-tracing-id")LogPreferenceEvent
RecommendationService:LogPreferenceEvent(
preferenceType:Enum.RecommendationPreferenceType, targetType:Enum.RecommendationPreferenceTargetType, targetId:string, tracingId:string, itemId:string
):()
Parameters
Teruggaves
()
RegisterItemAsync
RecommendationService:RegisterItemAsync(
Parameters
Teruggaves
Codevoorbeelden
Registreer een nieuw item
local RecommendationService = game:GetService("RecommendationService")
local storage = game:GetService("ReplicatedStorage")
-- Neem aan dat er een RemoteFunction genaamd 'RegisterItemRemote' bestaat 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-nl", "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("Item succesvol geregistreerd. ItemId: " .. response.ItemId)
return response.ItemId
else
warn("Registratie van item mislukt. Fout: " .. tostring(response))
return nil
end
endRemoveItemAsync
Parameters
Teruggaves
()
Codevoorbeelden
Verwijder een item
local RecommendationService = game:GetService("RecommendationService")
local function removeItem(itemId)
local success, err = pcall(function()
return RecommendationService:RemoveItemAsync(itemId)
end)
if success then
print("Item succesvol verwijderd: " .. itemId)
else
warn("Verwijderen van item mislukt: " .. itemId .. ". Fout: " .. tostring(err))
end
endUpdateItemAsync
Parameters
Teruggaves
()
Codevoorbeelden
Een item bijwerken
local RecommendationService = game:GetService("RecommendationService")
local function updateItem(itemId)
-- Alleen de velden opnemen die je wilt bijwerken
local request: UpdateRecommendationItemRequest = {
ItemId = itemId,
Visibility = Enum.RecommendationItemVisibility.Private,
-- OPMERKING: de hele CustomTags-lijst wordt vervangen door deze nieuwe lijst
CustomTags = {"updated-tag"}
}
local success, err = pcall(function()
return RecommendationService:UpdateItemAsync(request)
end)
if success then
print("Item succesvol bijgewerkt: " .. itemId)
else
warn("Bijwerken van item mislukt: " .. itemId .. ". Fout: " .. tostring(err))
end
end
-- Voorbeeldgebruik
-- updateItem("some-item-id-to-update")