Engine-Klasse
RecommendationService
*Dieser Inhalt wurde mit KI (Beta) übersetzt und kann Fehler enthalten. Um diese Seite auf Englisch zu sehen, klicke hier.
Zusammenfassung
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-Referenz
Methoden
GenerateItemListAsync
RecommendationService:GenerateItemListAsync(generateRecommendationItemListRequest:Dictionary):RecommendationPages
Parameter
Rückgaben
Code-Beispiele
Erstelle eine Liste empfohlenen Artikel
local RecommendationService = game:GetService("RecommendationService")
-- Definiere die Anfrage zur Erstellung einer Empfehlungs-Liste
local request: GenerateRecommendationItemListRequest = {
ConfigName = "MaximizeEngagement",
LocationId = "Lobby",
PageSize = 10
-- HINWEIS: Kommentiere aus und setze CustomContexts.UserId für Server-Skript.
-- Es ist nicht nötig, dies für das lokale Skript zu setzen.
-- CustomContexts = {
-- ["UserId"] = tostring(player.UserId),
-- }
}
-- Rufe GenerateItemListAsync auf, um die Empfehlungsseiten zu erhalten
local success, recommendationPages = pcall(function()
return RecommendationService:GenerateItemListAsync(request)
end)GetRecommendationItemAsync
Parameter
Rückgaben
Code-Beispiele
Ein einzelnes Empfehlungsobjekt erhalten
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("Erfolgreich das Objekt abgerufen: " .. item.ItemId)
print(" ReferenzId: " .. item.ReferenceId)
-- Die TracingId wird leer sein, wenn ein einzelnes Objekt direkt abgerufen wird
if item.Creator then
print(" ErstellerId: " .. tostring(item.Creator.CreatorId))
end
if item.CustomTags then
print(" Benutzerdefinierte Tags: ")
for _, customTag in ipairs(item.CustomTags) do
print(" " .. customTag)
end
end
else
warn("Fehler beim Abrufen des Objekts: " .. itemId .. ". Fehler: " .. tostring(item))
end
end
-- Beispielnutzung (benötigt eine gültige itemId)
-- getItem("some-item-id")LogActionEvent
RecommendationService:LogActionEvent(
actionType:Enum.RecommendationActionType, itemId:string, tracingId:string, actionEventDetails:Dictionary
):()
Parameter
| Standardwert: "nil" |
Rückgaben
()
Code-Beispiele
Protokollierung einer Benutzeraktion
local RecommendationService = game:GetService("RecommendationService")
local function logLike(itemId, tracingId)
local detail: RecommendationActionEventDetails = {
ReactionType = "Gefällt mir",
Weight = 1.0
}
RecommendationService:LogActionEvent(Enum.RecommendationActionType.AddReaction, itemId, tracingId, detail)
print("Protokollierte 'Gefällt mir'-Aktion für Artikel: " .. itemId)
end
-- Beispiel-Nutzung (benötigt eine gültige itemId und tracingId von GenerateItemListAsync)
-- logLike("item-id", "tracing-id")LogImpressionEvent
RecommendationService:LogImpressionEvent(
impressionType:Enum.RecommendationImpressionType, itemId:string, tracingId:string, impressionEventDetails:Dictionary
):()
Parameter
| Standardwert: "nil" |
Rückgaben
()
Code-Beispiele
Einen Benutzereindruck protokollieren
local RecommendationService = game:GetService("RecommendationService")
local function logView(itemId, tracingId)
local detail: RecommendationImpressionEventDetails = {
Duration = 5, -- Benutzer hat 5 Sekunden angesehen
ItemPosition = 1,
DepartureIntent = Enum.RecommendationDepartureIntent.Neutral
}
RecommendationService:LogImpressionEvent(Enum.RecommendationImpressionType.View, itemId, tracingId, detail)
print("'View'-Eindruck für Element protokolliert: " .. itemId)
end
-- Beispielnutzung (erfordert eine gültige itemId und tracingId von GenerateItemListAsync)
-- logView("some-item-id", "some-tracing-id")LogPreferenceEvent
RecommendationService:LogPreferenceEvent(
preferenceType:Enum.RecommendationPreferenceType, targetType:Enum.RecommendationPreferenceTargetType, targetId:string, tracingId:string, itemId:string
):()
Parameter
Rückgaben
()
RegisterItemAsync
RecommendationService:RegisterItemAsync(
Parameter
Rückgaben
Code-Beispiele
Ein neues Item registrieren
local RecommendationService = game:GetService("RecommendationService")
local storage = game:GetService("ReplicatedStorage")
-- Angenommen, eine RemoteFunction namens 'RegisterItemRemote' existiert 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:de-de", "seasonal:summer"},
Attributes = {
{
AssetId = 123,
Description = "Testvideo",
TrimStartTime = 0,
TrimEndTime = 10.5
}
}
}
local success, response = pcall(function()
return RecommendationService:RegisterItemAsync(player, request)
end)
if success and response then
print("Item erfolgreich registriert. ItemId: " .. response.ItemId)
return response.ItemId
else
warn("Fehler beim Registrieren des Items. Fehler: " .. tostring(response))
return nil
end
endRemoveItemAsync
Parameter
Rückgaben
()
Code-Beispiele
Element entfernen
local RecommendationService = game:GetService("RecommendationService")
local function removeItem(itemId)
local success, err = pcall(function()
return RecommendationService:RemoveItemAsync(itemId)
end)
if success then
print("Element erfolgreich entfernt: " .. itemId)
else
warn("Fehler beim Entfernen des Elements: " .. itemId .. ". Fehler: " .. tostring(err))
end
endUpdateItemAsync
Parameter
Rückgaben
()
Code-Beispiele
Ein Element aktualisieren
local RecommendationService = game:GetService("RecommendationService")
local function updateItem(itemId)
-- Nur die Felder einfügen, die Sie aktualisieren möchten
local request: UpdateRecommendationItemRequest = {
ItemId = itemId,
Visibility = Enum.RecommendationItemVisibility.Private,
-- HINWEIS: Die gesamte CustomTags-Liste wird durch diese neue Liste ersetzt
CustomTags = {"aktualisiertes-tag"}
}
local success, err = pcall(function()
return RecommendationService:UpdateItemAsync(request)
end)
if success then
print("Element erfolgreich aktualisiert: " .. itemId)
else
warn("Fehler bei der Aktualisierung des Elements: " .. itemId .. ". Fehler: " .. tostring(err))
end
end
-- Beispielverwendung
-- updateItem("some-item-id-to-update")