Pre-installed application custom component

Overview

A pre-defined application custom component represents a third-party app (such as YouTube, Netflix, or Prime Video) that can be launched from the interface. Clients must retrieve branding resources from the preinstalled application.

Note that no pre-defined pre-installed application custom component instances are defined.

Example configurationProperties block

For a rail section that represents a pre-installed application custom component, the configurationProperties block will look like this:

JSON

...
"configurationProperties": {
  "instance": "Netflix",
  "mobile_ios_store_id": "363590051",
  "integrated_linux_id": "",
  "stb_androidtv_package_id": "com.netflix.ninja",
  "image_hosting_type": "pia",
  "type": "preinstalled_application",
  "title": "Netflix",
  "background_opacity": "1",
  "background_colour": "#E50914",
  "stb_linux_id": "",
  "mobile_android_package_id": "com.netflix.mediaclient",
  "mobile_ios_bundle_id": "com.netflix.Netflix"
},
...

Fields

The following table lists the fields for a pre-installed application custom component.

Keys	Type	Values	Description
`instance`	String	N/A	The name of the instance of the custom component
`mobile_ios_store_id`	string	N/A	The ID for redirecting to the app store in the scenario that the application is not installed on iOS devices
`integrated_linux_id`	string	N/A	The identifier for referencing the application on integrated Linux-based environments
`stb_androidtv_package_id`	string	N/A	The package ID used to reference the application on Android TV STBs. Example: `com.amazon.amazonvideo.livingroom`
`image_hosting_type`	static	`pia`	The `image_hosting_type` field indicates to the client where images are being hosted for this application. The `pia` value indicates that the client is expected to retrieve branding resources from the installed package.
`type`	static	`preinstalled_application`	Defines the type of the rail item. A `preinstalled_application` represents a third-party app (such as YouTube, Netflix, or Prime Video) that can be launched from the interface. Clients must retrieve branding resources from the preinstalled application.
`title`	string	N/A	The `title` field represents the user-friendly display name of the application. This is the name that will be shown to the user in the appropriate UI element(s), such as in a RAIL or other content listings. For localisation, use the format `"i18n.title.{locale}"` in the `client_context` field to define translations for each locale. The `client_context` array should include entries like `"i18n.title.en_GB": "Spotify"` and `"i18n.title.ja_JP": "スポティファイ"`, allowing the title to be displayed correctly across different regions and languages.
`background_opacity`	numeric decimal (0 to 1)	N/A	Specifies the background opacity
`background_colour`	hex colour	N/A	Specifies a background colour for the application tile
`stb_linux_id`	string	N/A	The identifier for referencing the application on Linux-based STBs.
`mobile_android_package_id`	string	N/A	The package ID for referencing the application on Android mobile devices. Example: `com.amazon.avod.thirdpartyclient`
`mobile_ios_bundle_id`	string	N/A	The bundle ID for referencing the application on iOS devices