- Print
Personalization
- Print
Personalization on the X1 Platform
Personalization features get users to their preferred content quickly.
Personalization Features
There are three forms of personalization that improve the user experience on the X1 Platform:
- Surfacing content that a user recently watched
- Showing content that is free to a user
- Recommending new content to a user
Personalization & Your X1 App
Personalization requires integrated asset metadata, and the following usage data information to be passed by the X1 Javascript API:
- Signed In Status - accountLink().signIn()
- Signed Out Status - accountLink().signout()
- Entitlement Status - accountLink().updatedEntitlements()
- Viewing Data/Watch History - accountLink().mediaEvent()
The descriptions provided and images shown in this document are of the current X1 Platform and are subject to change.
User Data Security and Privacy
All personalization features are subject to the User Privacy and Data Security Requirements.
Prior to sharing any viewing data, your X1 App must call userPreferences.setting() (using the key shareWatchHistoryStatus) to determine if the user has agreed to let you share usage data with the X1 Platform.
- If the value is true, share usage data. If the value is false, do not share usage data.
You must call userPreferences.setting() at least once per app session, prior to sharing any viewing data via accountLink.mediaEvent(), to ensure you always have the most recent value.
When you provide accountLink().mediaEvent(), it will enable the following features:
- Continue Watching
- Recent TV
- Recent Networks and Apps
- Next Episode
- Launchpad
- Free to Me (Free Movies, Free to Me Filter)
- Recommendations (People Also Watched, Because You Watched)
Recent content
Recent Content rows provide multiple avenues for a user to easily get back to their content.
Continue Watching
The Continue Watching row allows a user to quickly resume content.
In order to populate this row with content from your app, the app must invoke the accountLink().mediaEvent() method to indicate if a user has completed playing back an asset, or where within the asset the user left off.
Recent TV
The Recent TV row shows a series-by-series breakdown of a user’s most frequently watched tv shows.
In order to populate this row with content from your app, the app must invoke the accountLink().mediaEvent() method to indicate if a user has completed playing back an asset, or where within the asset the user left off.
Recent Networks and Apps
The Recent Networks and Apps row displays a user’s recently watched TV channels and apps for easy access.
This row is populated by the X1 Platform directly.
Next Episode
A button will appear on the X1 Platform entity page for your app’s content that lets a user resume playback of an episode where they left off or start the next episode in the series.
In order to populate the entity page the app must invoke the accountLink().mediaEvent() method to indicate if a user has completed playing back an episode, or where within the episode the user left off.
Launchpad
The Launchpad row on Flex allows users to quickly resume content.
In order to populate Launchpad, the app must invoke the accountLink().mediaEvent() method to indicate if a user has started playing back an episode, completed playing back an episode, or where within the episode the user left off.
Free to Me
Free to Me rows showcase content that is free to a user based on their entitlements and subscriptions.
Free Movies
The Free Movies row shows movies that a user is able to watch for free.
In order to include your content in the row, your app must provide entitlement status for your user via the accountLink().signIn(), accountLink().signOut(), and accountLink().updateEntitlements() methods.
Free to Me Filter
The X1 Platform allows customers to apply a “Free to Me” filter to any row.
In order to include your content in the filter, your app must provide entitlement status for your user via the accountLink().signIn(), accountLink().signOut(), and accountLink().updateEntitlements()methods.
Recommendations
Recommendations are a key way for customers to discover new content from the X1 catalogue.
People Also Watched
The “People Also Watched” row appears on an asset’s X1 Platform entity page and displays related content based on what other users have watched or searched for.
For the Recommendations algorithms to know what a user is watching, your app must provide subscriber watch history via the accountLink().mediaEvent() method.
Because You Watched
The Because You Watched row shows a user content that is similar to a recently watched TV show or Movie.
For the Recommendations algorithms to know what a user is watching, your app must provide subscriber watch history via the accountLink().mediaEvent() method.