Logo (Content) key/value pair group | NAGRAVISION Documentation Portal

Overview

A Logo (Content) key/value pair group defines how brand logos are applied to the items within a rail.

Example extendedAttributes block

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

JSON

...
"extendedAttributes": [
  {
    "instance": "Amazon Prime logo contents",
    "logo_tile_position": "top_right",
    "type": "logo_configuration_tile",
    "blueprintId": "ef6daa30-e73d-443b-9dc4-6cef8a047d86"
  },
  {
    "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_tile) tells the client that it needs to apply a logo to the items in the rail (and not to the rail as a whole).
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 (Content) key/value pair group are as follows:

Keys	Type	Values	Description
`instance`	String	N/A	The name of the instance of the KVP group
`logo_tile_position`	enum	`center,` `top_left,` `top_right,` `bottom_left,` `bottom_right`	The `logo_tile_position` field specifies the position of the brand logo within the content tile. You can select one of the following options: `center`: the logo is placed at the center of the content tile. `top_left`: the logo is placed as an overlay in the top-left corner of the content tile. `top_right`: the logo is placed as an overlay in the top-right corner of the content tile. `bottom_left`: the logo is placed as an overlay in the bottom-left corner of the content tile. `bottom_right`: the logo is placed as an overlay in the bottom-right corner of the content tile.
`type`	static	`logo_configuration_tile`	The `type` field categorizes this blueprint as logo branding, defining how brand logos are applied to the items within a rail.
`blueprintId`	String	N/A	The blueprint ID for the KVP group that this is an instance of