Key/value pair group blueprint configuration

Key/value pair groups are common configuration elements that you can use to extend the definition of a strip. When adding or creating a key/value pair group, you can refer to the configuration information on this page.

The key/value pair group blueprints provided are:

Android Channels API
Client Side Processing
External Image
Internal Image
Logo (Content)
Logo (RAIL)

Android Channels API

Settings that map content to Android TV’s native channel system, enabling integration to surface content on the launcher or home screen.

Field	Purpose	Example usage and notes
Type	Defines the key/value pair group type as Android Channels API.	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 backend. The Android Channels API is part of the Android TV home screen experience, allowing apps to create and manage custom content channels 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 personalized recommendations, aligning with the Android TV user experience.
Client Context	N/A
STB Android TV Package ID	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. Example: For Amazon Prime Video on Android TV, the package name would be `com.amazon.amazonvideo.livingroom`
Channel Rail Filter	N/A

Client Side Processing

Indicates that the rail requires bespoke processing.

Field	Purpose	Values
Type	Serves as a marker indicating that the rail requires bespoke processing either in addition to, or instead of, that of a standard rail.	clientside
Identifier	Used to distinguish between different variations of the same Type and apply the appropriate processing, layout, or interaction patterns.
Client Context	N/A

External Image

References image assets that are hosted externally.

Field	Purpose	Values	Description	Example usage and notes
Type	Defines the key/value pair group type as External Image.	external_image	Indicates that this is a group containing information for images accessed via externally hosted URLs rather than being stored within the platform’s internal image service
Image Type	Specifies the category of image being defined within the group. This helps differentiate between various visual elements used within the UI.	logo	Represents a logo, typically used as a small, recognizable mark placed within the RAIL or on content tiles.
		banner	Represents a wider branding element, often spanning across sections of the screen RAIL to provide stronger brand association.
		background	Represents a full-background image, used to set the overall visual theme behind the RAIL’s content.
Brand	N/A
URL	Specifies the direct URL to an externally hosted image.		This is the default image for the Image Type.
Scale Factor			Values other than 0 mean the client must provide the specified level of scaling on the image
Alt Text	Provides alternative text that describes the image.		Clear, concise, and relevant text that enables users to understand what the image represents.	Used to assist visually impaired users who rely on screen readers, such as TalkBack. Ensures accessibility by providing a meaningful description of the image's content or purpose.
Client Context	N/A

Internal Image

References image assets that are hosted internally.

Field	Purpose	Values	Description	Example usage and notes
Type	Defines the key/value pair group type as Internal Image.	internal_image	Indicates that this is a group containing information for images accessed via the platform’s internal image service.
Image Type	Specifies the category of image being defined within the group. This helps differentiate between various visual elements used within the app user interface.	logo	Represents a logo, typically used as a small, recognizable mark placed within the rail or on content tiles.
		banner	Represents a wider branding element, often spanning across sections of the rail to provide stronger brand association.
		background	Represents a full-background image, used to set the overall visual theme behind the rail’s content.
Reference	The reference to an internal image stored within the platform’s image service.			This is the default image for the Image Type.
Alt Text	Provides alternative text that describes the image.		Clear, concise, and relevant text that enables users to understand what the image represents.	Used to assist visually impaired users who rely on screen readers, such as TalkBack. Ensures accessibility by providing a meaningful description of the image's content or purpose.
Client Context	N/A

Logo (Content)

Used to label content items with partner logos or thematic identifiers.

Field	Purpose	Values
Type	Sets the key/value pair group type as Logo (Content), defining how brand logos are applied within a content item.	logo_configuration_tile
Logo Tile Position	N/A
Logo Tile Offset X	N/A
Logo Tile Offset Y	N/A
Logo Tile Opacity	N/A

Logo (RAIL)

Used to label curated rails with partner logos or thematic identifiers.

Field	Purpose	Values
Type	Sets the key/value pair group type as Logo (RAIL), defining how brand logos are applied within a rail.	logo_configuration_rail
Logo Rail Position	N/A
Logo Rail Offset X	N/A
Logo Rail Offset Y	N/A
Logo Rail Opacity	N/A