Application custom component

Overview

An application custom component represents a third-party app (such as YouTube, Netflix, or Prime Video) that can be launched from the interface. In this case, the image to be used is specified as an internal or external image, as the image cannot be retried from the application package (as it may not be installed).

Note that no application custom component instances are defined.

Example configurationProperties block

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

JSON

...
"configurationProperties": {
  "instance": "Amazon Prime Video",
  "mobile_ios_store_id": "545519333",
  "integrated_linux_id": "",
  "stb_androidtv_package_id": "com.amazon.amazonvideo.livingroom",
  "type": "application",
  "title": "Amazon Prime Video",
  "background_colour": "#00A8E1",
  "stb_linux_id": "",
  "mobile_android_package_id": "com.amazon.avod.thirdpartyclient",
  "mobile_ios_bundle_id": "com.amazon.aiv.AIVPlayer"
},
...

An application custom component within a rail should also have a key/value pair section (represented by an extendedAttributes block) that specifies the display image to be used.

This will be either:

An internal image – see Internal Image key/value pair group
An external image – see External Image key/value pair group

Fields

The following table lists the fields for an 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		The ID for redirecting to the app store in the scenario that the application is not installed on iOS devices.
`integrated_linux_id`	string		The identifier for referencing the application on integrated Linux-based environments.
`stb_androidtv_package_id`	string		The package ID used to reference the application on Android TV STBs. Example: `com.amazon.amazonvideo.livingroom`
`type`	static	`application`	Defines the type of the rail item. An `application` represents a third-party app (such as YouTube, Netflix, or Prime Video) that can be launched from the interface.
`title`	string		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_colour`	hex colour		Specifies a background colour for the application tile.
`stb_linux_id`	string		The identifier for referencing the application on Linux-based STBs.
`mobile_android_package_id`	string		The package ID for referencing the application on Android mobile devices. Example: `com.amazon.avod.thirdpartyclient`
`mobile_ios_bundle_id`	string		The bundle ID for referencing the application on iOS devices.