Banner X Ad Reference

Requested items

String

Description

Required or Optional

SlotId

The banner slot requested in the context. The slots are defined in the content standards. Content standards are provided by retailers.

Required

slotIds

This contains any requested SlotId in the context. There can be one or many.

Required

Returned items

String

Description

backgroundColour

The background colour of the banner, HEX values only.

backgroundImage

The Id of the Background Image of the banner.

backgroundImagePosition

Defines the position type of the Background Image.

bannerText

The text displayed in the banner.

bannerTextColour

The banner text colour, HEX values only.

citrusAdId

The id of the ad.

citrusCampaignName

The campaign name of the ad.

citrusContentStandardId

The content standard id related to the slot.

citrusExpiry

The expiry of the ad.

citrusSlotId

The id of the specific slot for the banner.

ctaFlag

This defines if a CTA is shown or not.

ctaLink

This is the url forwarded from the CTA. This is like linkUrl for banners.

ctaText

The text within the CTA.

ctaTextAccessibility

Accessibility text of the CTA for screen reader users.

headingText

Heading text for screen reader users.

heroImageAltText

Alternative text for the hero image in the rare event it does not display.

heroImage

The Id of the Hero Image of the Banner.

secondaryBackgroundImage

The Id of the Secondary Background Image.

secondaryBackgroundImagePosition

Defines the position type of the Secondary Background Image.

secondaryHeroImageAltText

Alternative text for the Secondary Hero Image in the rare event it does not display.

secondaryHeroImage

The Id of the Secondary Hero Image.

secondaryHeroMode

Defines the display mode of the secondary hero image.

tags

This field returns any third party tags entered by the advertiser in their campaign.