Data object Recommendation
interface struct Recommendation
A recommendation that is shown to user on the device home screen.
Make sure that the strings displayed to the user are concise.
The UI only supports UTF-8 encoded short strings.
A size limit of 512KB (excluding the contentImage object) is enforced for each recommendation object.
Fields
title
string — Required
Content title for the recommendation.
text
string — Required
Description text for the recommendation.
contentImage
u8[] — Required
The PNG formatted image to display for this recommendation.
The addRecommendations method throws an InvalidArgumentError exception when called with incorrect image specifications.
This is a required field.
RecommendationManager supports images with the following specifications:
Aspect ratio: 16:9
Channels: 3 (BGR) with 8 bit/channel
Orientation: Landscape
Format: PNG
The image resolution depends on the screen resolution of the display device:
HDTV (720p): 256 * 144
HDTV (1080p): 384 * 216
4K UHD: 768 * 432
Title: Embedded within image
Transparency: No transparency
backgroundImageUri
string — Required
The URI that is used to retrieve the background image for the recommendation.
The image appears when the user hovers over the recommendation item.
contentUri
string — Required
The URI that is launched when the user clicks on the recommendation.
category
Category — Required
The target category for recommendation. This is a required field.
displayName
string — Required
A short app name that displays in the Launch menu.
The name appears when the user presses the menu button while a recommendation is selected.
displayActionOption
DisplayAction — Required
Determines the first context menu options displayed for this recommendation. This is a required field.
maturityRating
string — Required
Displays the rating below the title. Currently, supported values are as follows:
US Marketplace: G, PG, PG13, R, NC17, NR, TVY, TVY7, TVG, TVPG, TV14, TVMA
German Marketplace: FSK0, FSK6, FSK12, FSK16, FSK18
Great Britain Marketplace: BBFCPG, BBFC12, BBFC18, BBFCU
Japan Marketplace: EIRIN_G, EIRIN_PG12, EIRIN_R15, EIRIN_18
India Marketplace: ALL, 7+, 13+, 16+, 18+, NR
This is a required field.
customerAggregateRating
u8 — Required
Aggregate ratings from all customers, possible values range from 0 to 10.
customerRatingCount
i32 — Required
Number of customers who rated this content. If set to 0, content is considered unrated
runningTime
i32 — Required
Running time (when applicable) for the content in seconds. Live content can set this to 0
releaseYear
u16 — Required
Content release year. Example: 2016, 2015
isCaptionAvailable
bool — Required
Caption availability for this content.
false: Caption not available for content (default)
true: Caption available for content