Logo (RAIL) key/value pair group

Overview

A Logo (RAIL) key/value pair group defines how brand logos are applied within a rail.

Example extendedAttributes block

For a rail that has a Logo (RAIL) key/value pair group instance attached to it, the extendedAttributes block will look like this:

JSON

...
"extendedAttributes": [
  {
    "instance": "Amazon Prime logo rail",
    "type": "logo_configuration_rail",
    "blueprintId": "6f1ab674-55a4-4ed9-802f-1192635b3127"
  },
  {
    "reference": "87900d25-e4b3-4625-a804-07d41edaaf81",
    "instance": "Amazon Prime Image",
    "alt_text": "prime video",
    "type": "internal_image",
    "blueprintId": "7d603624-f11b-4e2c-b235-dacf14931612",
    "image_type": "logo"
  }
],
...

Note that:

The first block is for the Logo (RAIL) key/value pair group instance.
The value of the type field (logo_configuration_rail) tells the client that it needs to apply a logo to the rail (and not to the items within the rail).
The second is for a key/value pair group instance that specifies the image to use. This can be:
- "type": "internal_image" – an internal image. This has a reference field that contains the image ID. The client should use this ID in a call to ImageService to get the logo image. See Using ImageService to get an image by its ID.
  See Internal Image key/value pair group.
- "type": "external_image" – an external image. This has a url field that contains the URL of the image.
  See External Image key/value pair group.

Fields

The fields for the Logo (RAIL) key/value pair group are as follows:

Keys	Type	Values	Description
`instance`	String	N/A	The name of the instance of the KVP group
`type`	static	`logo_configuration_rail`	If the `type` field has a value of `logo_configuration_rail`, it means that the client should apply logo to the rail as a whole (and not to the individual items in the rail).
`blueprintId`	String	N/A	The blueprint ID for the KVP group that this is an instance of