Classe de moteur
RecommendationService
*Ce contenu est traduit en utilisant l'IA (Beta) et peut contenir des erreurs. Pour consulter cette page en anglais, clique ici.
Résumé
Méthodes
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):() |
Référence API
Méthodes
GenerateItemListAsync
RecommendationService:GenerateItemListAsync(generateRecommendationItemListRequest:Dictionary):RecommendationPages
Paramètres
Retours
Échantillons de code
Générer une liste d'objets recommandés
local RecommendationService = game:GetService("RecommendationService")
-- Définir la demande pour générer une liste de recommandations
local request: GenerateRecommendationItemListRequest = {
ConfigName = "MaximizeEngagement",
LocationId = "Lobby",
PageSize = 10
-- REMARQUE : Décommentez et définissez CustomContexts.UserId pour le script serveur.
-- Pas besoin de le définir pour le script local.
-- CustomContexts = {
-- ["UserId"] = tostring(player.UserId),
-- }
}
-- Appeler GenerateItemListAsync pour obtenir les pages de recommandations
local success, recommendationPages = pcall(function()
return RecommendationService:GenerateItemListAsync(request)
end)GetRecommendationItemAsync
Paramètres
Retours
Échantillons de code
Obtenir un élément de recommandation unique
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("Élément récupéré avec succès : " .. item.ItemId)
print(" ReferenceId : " .. item.ReferenceId)
-- Le TracingId sera vide lors de la récupération d'un seul élément directement
if item.Creator then
print(" CreatorId : " .. tostring(item.Creator.CreatorId))
end
if item.CustomTags then
print(" Étiquettes personnalisées : ")
for _, customTag in ipairs(item.CustomTags) do
print(" " .. customTag)
end
end
else
warn("Échec de la récupération de l'élément : " .. itemId .. ". Erreur : " .. tostring(item))
end
end
-- Exemple d'utilisation (nécessite un itemId valide)
-- getItem("some-item-id")LogActionEvent
RecommendationService:LogActionEvent(
actionType:Enum.RecommendationActionType, itemId:string, tracingId:string, actionEventDetails:Dictionary
):()
Paramètres
| Valeur par défaut : "nil" |
Retours
()
Échantillons de code
Enregistrement d'une action utilisateur
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("Action 'Like' enregistrée pour l'élément : " .. itemId)
end
-- Exemple d'utilisation (requiert un itemId et un tracingId valides de GenerateItemListAsync)
-- logLike("item-id", "tracing-id")LogImpressionEvent
RecommendationService:LogImpressionEvent(
impressionType:Enum.RecommendationImpressionType, itemId:string, tracingId:string, impressionEventDetails:Dictionary
):()
Paramètres
| Valeur par défaut : "nil" |
Retours
()
Échantillons de code
Enregistrer l'impression d'un utilisateur
local RecommendationService = game:GetService("RecommendationService")
local function logView(itemId, tracingId)
local detail: RecommendationImpressionEventDetails = {
Duration = 5, -- L'utilisateur a vu pendant 5 secondes
ItemPosition = 1,
DepartureIntent = Enum.RecommendationDepartureIntent.Neutral
}
RecommendationService:LogImpressionEvent(Enum.RecommendationImpressionType.View, itemId, tracingId, detail)
print("Impression de 'Vue' enregistrée pour l'article : " .. itemId)
end
-- Exemple d'utilisation (nécessite un itemId valide et un tracingId de GenerateItemListAsync)
-- logView("some-item-id", "some-tracing-id")LogPreferenceEvent
RecommendationService:LogPreferenceEvent(
preferenceType:Enum.RecommendationPreferenceType, targetType:Enum.RecommendationPreferenceTargetType, targetId:string, tracingId:string, itemId:string
):()
Paramètres
Retours
()
RegisterItemAsync
RecommendationService:RegisterItemAsync(
Paramètres
Retours
Échantillons de code
Enregistrer un nouvel élément
local RecommendationService = game:GetService("RecommendationService")
local storage = game:GetService("ReplicatedStorage")
-- Supposons qu'une RemoteFunction nommée 'RegisterItemRemote' existe dans 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 = "vidéo de test",
TrimStartTime = 0,
TrimEndTime = 10.5
}
}
}
local success, response = pcall(function()
return RecommendationService:RegisterItemAsync(player, request)
end)
if success and response then
print("Élément enregistré avec succès. ItemId: " .. response.ItemId)
return response.ItemId
else
warn("Échec de l'enregistrement de l'élément. Erreur: " .. tostring(response))
return nil
end
endRemoveItemAsync
Paramètres
Retours
()
Échantillons de code
Supprimer un élément
local RecommendationService = game:GetService("RecommendationService")
local function removeItem(itemId)
local success, err = pcall(function()
return RecommendationService:RemoveItemAsync(itemId)
end)
if success then
print("Élément supprimé avec succès : " .. itemId)
else
warn("Échec de la suppression de l'élément : " .. itemId .. ". Erreur : " .. tostring(err))
end
endUpdateItemAsync
Paramètres
Retours
()
Échantillons de code
Mettre à jour un élément
local RecommendationService = game:GetService("RecommendationService")
local function updateItem(itemId)
-- Inclure uniquement les champs que vous souhaitez mettre à jour
local request: UpdateRecommendationItemRequest = {
ItemId = itemId,
Visibility = Enum.RecommendationItemVisibility.Private,
-- REMARQUE : toute la liste CustomTags sera remplacée par cette nouvelle liste
CustomTags = {"updated-tag"}
}
local success, err = pcall(function()
return RecommendationService:UpdateItemAsync(request)
end)
if success then
print("Élément mis à jour avec succès : " .. itemId)
else
warn("Échec de la mise à jour de l'élément : " .. itemId .. ". Erreur : " .. tostring(err))
end
end
-- Exemple d'utilisation
-- updateItem("some-item-id-to-update")