PromotionalBanner key/value pair group

Overview

A PromotionalBanner key/value pair group is a visually prominent content item intended for promotional purposes, typically featuring an image and an optional navigation action.

Example extendedAttributes block

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

JSON

...
"extendedAttributes": [
  {
    "instance": "Big event promo banner",
    "type": "promo_banner",
    "blueprintId": "e0898555-9fa9-470e-991a-4812b648b338",
    "url": "https://operator.com/big_event"
  },
  {
    "reference": "f15ba14a-a855-4710-b2cc-8a04bbc5d3e3",
    "instance": "Big event banner",
    "alt_text": "Big event",
    "type": "internal_image",
    "blueprintId": "7d603624-f11b-4e2c-b235-dacf14931612",
    "image_type": "background"
  }
],
...

Note that:

The first block is for the PromotionalBanner key/value pair group instance.
The value of the type field (promo_banner) tells the client that this is a promotional banner.
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 banner 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 PromotionalBanner 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	`promo_banner`	Defines the type of the rail item. A `promo_banner` is a visually prominent content item intended for promotional purposes, typically featuring an image and an optional navigation action.
`blueprintId`	String	N/A	The blueprint ID for the KVP group that this is an instance of
`url`	string		The URL to direct the user to on interaction