Custom component blueprint configuration

Custom component blueprints enable you to add specific components to a rail, and configure them to meet your needs.

The custom component blueprints provided are:

Advertisement banner
Application
Feature banner
Pre-installed application

When adding or editing a custom component, you can use the information in the tables below for reference.

Advertisement Banner

An Advertisement Banner custom component is an externally served promotional banner integrated with third-party ad platforms. When clicked, it redirects users to external content, campaign landing pages, or app stores.

Field	Purpose	Values	Example usage and notes
Type	Defines the custom component type as Advertisement Banner.	advertisement_banner	An Advertisement Banner is a visually prominent content item intended for promotional purposes, typically featuring an image and an optional navigation action.
Client Context	An optional field that provides additional contextual hints (related to the component’s intended use) that may affect how the blueprint is rendered or how users interact with it.
Provider Ident	Uniquely identifies the advertisement provider serving the ad.		This field is crucial for distinguishing between different ad providers (e.g., Google Ad Manager, Amazon Publisher Services) and ensuring that different formats, tracking methods and content types for each provider are managed appropriately. Example values: `gam` (for Google Ad Manager) `aps` (for Amazon Publisher Services) `freewheel` (for Freewheel)
Ad Server URL	Specifies the URL from which the advertisement content is served.		This URL is provided by the ad server (e.g., Google Ad Manager, Amazon Publisher Services).
Refresh Interval	Defines the interval, in seconds, at which an advertisement or content should be refreshed or reloaded.	Valid Range: `0` to `86,400` (representing 0 seconds to 24 hours)	A value of `0` indicates that the ad or content should not be refreshed automatically, while values greater than `0` specify the time in seconds after which the ad or content will be refreshed. This is particularly useful for dynamic or rotating ads that need to update regularly to show fresh content or prevent stale creative from being shown. Example values: `0` (No refresh – the ad will remain static until explicitly refreshed by the client or user interaction) `60` (Refresh every 60 seconds) `300` (Refresh every 5 minutes)

Application

An Application custom component is a representation of a third-party application. It is typically used to highlight partner services or utility apps.

Field	Purpose	Example usage and notes
Type	Defines the custom component type as Application.	An Application custom component represents a third-party app (such as YouTube, Netflix, or Prime Video) that can be launched from the interface.
Title	The user-friendly display name of the application, that will be shown to the user in the appropriate UI element(s), such as in a rail or other content listings.
Client Context	N/A
Background Colour	Specifies a background colour for the Application tile.
Background Opacity	N/A
STB Android TV Package ID	Specifies the package ID used to reference the application on Android TV STBs.	Example: `com.amazon.amazonvideo.livingroom`
STB Linux ID	Specifies the identifier for referencing the application on Linux-based STBs.
Mobile Android Package ID	Specifies the package ID for referencing the application on Android mobile devices.	Example: `com.amazon.avod.thirdpartyclient`
Mobile iOS Bundle ID	Specifies the bundle ID for referencing the application on iOS devices.
Mobile iOS Store ID	Specifies the ID for redirecting to the app store in the scenario that the application is not installed on iOS devices.
Integrated Linux ID	Specifies the identifier for referencing the application on integrated Linux-based environments.

Feature Banner

A Feature Banner custom component is a prominent visual banner used to promote key content or campaigns. When clicked by the user, it navigates to a curated discovery or campaign page.

Field	Purpose	Values	Example usage and notes
Type	Defines the custom component type as Feature Banner.	feature_banner	A Feature Banner custom component is a visually prominent content item intended for promotional purposes, typically featuring an image and an optional navigation action.
Client Context	N/A
Action	N/A
Template ID	Specifies the template to navigate to when the feature banner is selected.		Only relevant when Action is set to `template_navigation`.

Pre-installed Application

A Pre-installed Application custom component is a third-party application that is preloaded on the device. It serves as a persistent entry point for platform or partner services.

Field	Purpose	Example usage and notes
Type	Defines the custom component type as Pre-installed Application.	A Pre-installed Application custom component represents a third-party app (such as YouTube, Netflix, or Prime Video) that can be launched from the interface.
Image Hosting Type	Indicates where images are being hosted for this application.
Title	Defines the user-friendly display name of the application that will be shown to the user in the appropriate UI element(s), such as in a rail or other content listings.	For localization, use the format `"i18n.title.<locale>"` in the `client_context` field to define translations for each locale.
Client Context	N/A
Background Colour	Specifies a background colour for the pre-installed application tile.
Background Opacity	Specifies the background opacity.
STB Android TV Package ID	Specifies the package ID used to reference the application on Android TV STBs.	Example: `com.amazon.amazonvideo.livingroom`
STB Linux ID	Specifies the identifier for referencing the application on Linux-based STBs.
Mobile Android Package ID	Specifies the package ID for referencing the application on Android mobile devices.	Example: `com.amazon.avod.thirdpartyclient`
Mobile iOS Bundle ID	Specifies the bundle ID for referencing the application on iOS devices.
Mobile iOS Store ID	Specifies the ID for redirecting to the app store in the scenario that the application is not installed on iOS devices.
Integrated Linux ID	Specifies the identifier for referencing the application on integrated Linux-based environments.