Android Channels API key/value pair group

Overview

An Android Channels API key/value pair group serves as a marker indicating that the content for this rail should be sourced dynamically using the Android Channels API rather than being predefined within the back-end.

Example extendedAttributes block

For a rail that has a Android Channels API key/value pair group instance attached to it, the extendedAttributes block will look like this:

JSON

...
"extendedAttributes": [
  {
    "identifier": "android_channels",
    "client_context": [
      "android_channels"
    ],
    "instance": "Android Channels API",
    "stb_androidtv_package_id": "",
    "channel_rail_filter": "",
    "type": "clientside",
    "blueprintId": "20ca6759-8332-45ad-b7e6-7e47141e1878"
  }
],
...

Fields

The fields for the Android Channels API key/value pair group are as follows:

Keys	Type	Values	Description
`identifier`		`android_channels`	Identifies this as an Android Channels key/value pair group
`client_context`			N/A
`instance`	String	N/A	The name of the instance of the KVP group
`stb_androidtv_package_id`	string		This field specifies the package name of the Android app associated with the set-top box (STB) that is calling the Android Channels API. The package name is a unique identifier for the app on the Android platform, ensuring that the correct app is referenced when interacting with the API. For example, for Amazon Prime Video on Android TV, the package name would be `com.amazon.amazonvideo.livingroom`.
`channel_rail_filter`
`type`	static	`android_channels_api`	The `type` field defines the category of KVP group. The android_channels_api type serves as a marker indicating that the content for this rail should be sourced dynamically using the Android Channels API rather than being predefined within the back-end. The Android Channels API is part of the Android TV home screen experience, allowing apps to create and manage custom content channels (rails) that integrate seamlessly with the launcher. While the layout and structure of the rail can still be configured within the blueprint, the actual content population is controlled by the client through API calls. This enables flexible, real-time updates to live TV, on-demand content, or personalised recommendations, aligning with the Android TV user experience.
`blueprintId`	String	N/A	The blueprint ID for the KVP group that this is an instance of