object
A recommendation that is shown to user on device home screen. This can either be a
- Recommendation type object supporting content image byte array
- Recommendation2 type object supporting content image URI Please ensure that the strings displayed to the user are concise and are UTF-8 encoded as short strings can be fully shown on the UI and Omnikit supports only UTF-8 encoding. A size limit of 512KB (excluding the contentImage) is enforced for each recommendation object.
Type declaration
backgroundImageUri
backgroundImageUri:URL
URI that will be used to retrieve the background image for the recommendation
category
category:Category
Category the recommendation should go to. This is a required field.
contentImage
contentImage:number[]
Image (PNG) to be displayed for this recommendation, recommendations without images
or incorrect specs will not be displayed. This is a required field.
Use the following specifications for the image:
Aspect ratio: 16:9
Channels : 3 (BGR) with 8 bit/channel
Orientation : Landscape
Format : PNG
Depending on display the image resolution should be :
HDTV (720p) : 256 _ 144
. HDTV (1080p): 384 _ 216
4K UHD : 768 * 432
Title: Embedded within image
Transparency: No transparency
contentUri
contentUri:URL
URI that will be launched when the user clicks on the recommendation
customerAggregateRating
customerAggregateRating:number
Customer aggregate rating, possible values range from 0 to 10.
customerRatingCount
customerRatingCount:number
Number of customers rated this content.
displayActionOption
displayActionOption:DisplayAction
Determines the first context menu options displayed for each recommendation. This is a required field.
displayName
displayName:string
A shorter app name displayed in the Launch menu (which appears when you press
the menu button while a recommendation is selected).
isCaptionAvailable
isCaptionAvailable:boolean
Caption availability of content
false: Caption not available for content (default)
true: Caption available for content
maturityRating
maturityRating:string
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.
releaseYear
releaseYear:number
Content release year. Example: 2016, 2015
runningTime
runningTime:number
Running time (in minutes) for the content, when applicable.
text
text:string
Description text for the recommendation.
title
title:string
Content title for the recommendation.
