Advertisement banner custom component

Overview

An advertisement banner custom component is a visually prominent content item intended for promotional purposes, typically featuring an image and an optional navigation action.

Note that no pre-defined advertisement banner custom component instances are defined.

Example configurationProperties block

For a rail section that represents an advertisement banner custom component, the configurationProperties block will look like this:

JSON

...
"configurationProperties": {
  "instance": "Ad Banner",
  "refresh_interval": "300",
  "ad_server_url": "https://pubads.g.doubleclick.net/gampad/ads",
  "type": "advertisement_banner"
},
...

Fields

The following table lists the fields for an advertisement banner custom component:

Keys	Type	Values	Description
`instance`	String	N/A	The name of the instance of the custom component
`refresh_interval`	numeric	N/A	The interval, in seconds, at which the advertisement should be refreshed or reloaded. The value can range from 0 to 86400 seconds (24 hours). A value of `0` indicates that the ad or content should not be refreshed automatically, while values greater than `0` specify the time in seconds after which the ad will be refreshed. This is particularly useful for dynamic or rotating ads that need to update regularly to show fresh content or prevent stale creative from being shown. Valid range: `0` to `86400` (representing 0 seconds to 24 hours) Example values: `0` (no refresh – the ad will remain static until explicitly refreshed by the client or user interaction) `60` (refresh every 60 seconds) `300` (refresh every 5 minutes)
`ad_server_url`	string	N/A	The URL from which the advertisement content is served. This URL is provided by the ad server (e.g., Google Ad Manager, Amazon Publisher Services) and is used by the client to retrieve the advertisement and related assets (such as images, videos, or interactive elements). It may also include tracking information for impression and click tracking, as well as other parameters necessary for rendering the ad correctly. This URL serves as the endpoint for fetching the ad creative and other relevant details (e.g., targeting parameters, ad placement information) and ensures that the client connects to the appropriate ad server for content delivery.
`type`	static	`advertisement_banner`	Defines the type of the rail item. An `advertisement_banner` is a visually prominent content item intended for promotional purposes, typically featuring an image and an optional navigation action.