Skip to content

RecommendationService

Not yet Class Services NotCreatable Service

A service that provides an interface for you to manage and display personalized content recommendations.

Not implemented yet

This class exists in the current Roblox API but is not implemented in Nova yet. Scripts that reference it will fail at runtime.

0 Nova members ยท 14 modern Roblox members not implemented yet

Description

RecommendationService provides an interface for you to manage and display personalized content recommendations. It supports creating, retrieving, updating, and deleting recommendation items, as well as generating lists of recommended content for users. Additionally, it includes functionality for logging user interactions, such as views and actions, to help refine and improve recommendation quality. Once set up, you can monitor analytics in the Creator Dashboard under the Engagement section for an experience.

Inheritance

Object โ†’ Instance โ†’ RecommendationService

Methods

Member Signature Summary
GenerateItemListAsync RecommendationService:GenerateItemListAsync(generateRecommendationItemListRequest: Dictionary): RecommendationPages Returns a paginated list of personalized recommendation items for the specified request configuration.
GetRecommendationItemAsync RecommendationService:GetRecommendationItemAsync(itemId: string): Dictionary Retrieves a single registered recommendation item by its ItemId.
LogActionEvent RecommendationService:LogActionEvent(actionType: RecommendationActionType, itemId: string, tracingId: string, actionEventDetails: Dictionary = nil): null Logs a user action, such as a reaction or play, taken on a recommended item.
LogImpressionEvent RecommendationService:LogImpressionEvent(impressionType: RecommendationImpressionType, itemId: string, tracingId: string, impressionEventDetails: Dictionary = nil): null Logs an impression event, such as a user viewing a recommended item.
LogPreferenceEvent RecommendationService:LogPreferenceEvent(preferenceType: RecommendationPreferenceType, targetType: RecommendationPreferenceTargetType, targetId: string, tracingId: string, itemId: string): null Logs a user preference signal, such as follow or mute, toward a user, universe, or custom content tag.
RegisterItemAsync RecommendationService:RegisterItemAsync(player: Player, registerRecommendationItemsRequest: Dictionary): Dictionary Registers a new item on the server so it can be included in recommendations, returning the generated ItemId and ReferenceId.
RemoveItemAsync RecommendationService:RemoveItemAsync(itemId: string): null Removes a registered item from the recommendation system by its ItemId.
UpdateItemAsync RecommendationService:UpdateItemAsync(updateRecommendationItemRequest: Dictionary): null Updates the mutable attributes of an existing recommendation item.

Roblox reference: RecommendationService

Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.