> For the complete documentation index, see [llms.txt](https://help.citrusad.com/retail-media-interface/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.citrusad.com/retail-media-interface/integration/references/banner-x-reference-1.md). # Banner X reference The below outlines the properties possible in a standard request as outlined in [Requesting ads](/retail-media-interface/integration/generating-ads/banner-x-responsive/requesting-banner-x-ads.md) for your request, and the response if you receive an ad. ## Requested items | String | Description | Required/optional | | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- | | `BannerSlotIds` | A json array of the banner slotIds being requested. | Required | | `catalogId` | Your product catalog identifier for your website. | Required | | `contentStandardId` | The content standard identifier for your website. | Required | | `customerId` | The unique identifier for the customer being served ads. | Optional | | `filterMode` | Optional way of defining the structure of your request. See [Ad generation filtering](/retail-media-interface/integration/data-api/api-overview/ad-generation-filtering-1.md) for more information. | Optional, preferred | | `maxNumberOfAds` | The maximum number of each banner slot you would like returned. | Required | | `options` |

Optional way of defining the structure of your request. See Ad generation filtering for more information.

This is also the object where you can request advertiser information in order to comply with local advertising legislation like Europe’s Digital Services Act .

| Optional, preferred | | `placement` | The unique placement you are requesting ads for. | Required | | `productFilters` | Any product filters relevant to your request. Such as a category, location, or size filter. | Required for category placements | | `searchTerm` | The search term entered by your customer into your website. | Required for search placements | | `sessionId` | The unique identifier of the customer's session. Used for attribution in standard integrations. Review [Integration workflow options](/retail-media-interface/integration/data-api/api-overview/integration-workflow-options-1.md)for more information. | Required in standard integrations | | `slotId` | This contains any requested SlotId in the context. There can be one or many. | Required | | `dtmCookieId` | Cookies created and stored by the website, used for tracking user behavior on the same domain. | Optional | | `audience` | Specifies specific audience segments that the shopper belongs to. Only relevant is using [Audience Targeting Option 3](/retail-media-interface/integration/data-api/audience-targeting-new/integration-option-3-sync-audiences-only.md) | Optional | ## Returned items | String | Description | Example value | | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ads.backgroundColour` | The background colour of the banner - HEX values only. | `6e6c6c` | | `ads.backgroundImage` | The image link of the banner background image. | `[]\() | | `ads.backgroundImagePosition` | This defines the position type of the background image. If no value, you will need to default to `leftaligned` . |

leftaligned
rightaligned
fill
repeating

| | `ads.bannerText` | The text displayed in the banner. May include HTML tags | `Double Fudge Ice Cream` | | `ads.bannerTextColour` | The banner text colour - HEX values only. Citrus does not send the `#`. | `1dc711` | | `ads.citrusAdId` |

The unique id of the ad.
This is unique to each request made to Epsilon Retail Media and cannot be cached.

| `shotgun_wIpZraEXcIu0daC5YMQewPil2S83NzE0MTA3` | | `ads.citrusCampaignName` | The campaign name of the ad. | `Epsilon-Example-Category-Banner-X-Ad-ae536b0d5c3ded28ea624ab4285facd6` | | `ads.citrusContentStandardId` | The content standard id related to the slot. | `8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c` | | `ads.citrusExpiry` | The expiry of the ad. This is the latest point in which a click can be reported to Epsilon Retail Media | `2021-06-01T23:48:16.573967987Z` | | `ads.citrusSlotId` | The id of the specific slot for the banner you have requested. | `Category_Top` | | `ads.contentStandardId` | The content standard id related to the slot. Duplicate of `citrusContentStandardId` | `8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c` | | `ads.ctaFlag` | This defines if a CTA is shown or not. |

true
false

| | `ads.ctaLink` | The url forwarded from the CTA (this is like linkUrl for banners). Only served if ctaFlag is `true` | ` | | `ads.ctaText` | The text within the CTA. | `Shop now` | | `ads.ctaTextAccessibility` | Accessibility text of the CTA for screen reader users. | `for Double Fudge Ice Cream` | | `ads.gtins` |

An array of up to 20 product codes selected from the campaign's advertised products.

Retailers may use this list to automate lister pages when the banner is clicked, or automate certain rendering functionality (roundels, pricing, secondary stock level checking).

| `[
"7714107",
"7163379",
"7733636",
"7733657",
"7733628"
],` | | `ads.headingText` | Heading text for screen reader users. | `Banner Advertisement for Fudge Double Ice Cream with a product image and shop now button` | | `ads.heroImageAltText` | Alternative text for the hero image in the rare event it doesn't display. | `Image of double fudge iced cream` | | `ads.heroImage` | The image link of the hero image of the banner. | `[]\() | | `ads.position` | The banner's position in the Epsilon Retail Media response. You should honour this position in the event fixed tenancy campaigns are utilised. | 1 | | `ads.secondaryBackgroundImage` | The image link of the secondary background image. | `[]\() | | `ads.secondaryBackgroundImagePosition` | This defines the position type of the secondary background image. |

leftaligned
rightaligned

| | `ads.secondaryHeroImageAltText` | Alternative text for the secondary hero image in the rare event it doesn't display. | `Image of [brand] logo` | | `ads.secondaryHeroImage` | The image link of the secondary hero image. | `[]\() | | `ads.secondaryHeroMode` | This defines the display mode of the secondary hero image. If no value, you will need to default to `block` . |

block
landscape

| | `ads.slotId` | The slot ID of the banner you have requested. When requesting multiple banners, this can be used to reference the IDs requested. | `Category_Top` | | `ads.tags` | This field returns any third party tags entered by the advertiser in their campaign. This is not currently something supported by banner x, though the API response is formatted. | `{}` | | `ads.sellerId` | The unique Id of the seller. Will only populate if a sellerId is set on a team. sellerIds are typically used when onboarding marketplace sellers. | `73nns-32sxr-32ss` Custom per integration | | `ads.metadata` |

Object containing the advertiser info required to help advertisers comply with local advertising legislation such as the Digital Services Act in Europe.

advertiser is carried from the Company name in the supplier team.

onBehalfOf is carried from the Ad financer in the supplier team.

| `"metadata": {
"advertiserInfo": {
"advertiser": "Bob's advertising agency",
"onBehalfOf": "Brand company inc"
}
...` | | `ads.adm` | Object containing the video ad details including VAST tags. | "\n\\n \\n \\n \Epsilon Retail Media\\n \!\[CDATA\[]] \\n \\n \!\[CDATA\[]] \\n \\\n \\\n \\n \VAST-4.0-Short-Intro.mp4\\n \\n \\n \VAST-4.0-Short-Intro.mp4\\n \\n \\\n \\n \!\[CDATA\[]] \\n \!\[CDATA\[]] \\n \\n \\n \!\[CDATA\[]] \\n \\\n \\n \\n \\n \\n \\n \\n\" | | `ads.companionProducts` | Companion product details. |

“companionProducts”: \[
"Banana14-simfk15"
"Oranges5-qgxeb6",
"Incaberries20-ppscn21"

| | `metadata.warnings` | Object containing warning information about the ad request. Currently only warns if the maximum number of segments is exceeded. | `"metadata": {
"warnings": [
"Audience Segment IDs exceeded the limit of {maxSegmentIds} and were truncated"
]
}` | {% hint style="info" %} If there is a field not configured as part of the ad's campaign, it will not be served. i.e. if the advertiser has not configured a `heroImage`, Epsilon Retail Media will not serve the `heroImage` property. {% endhint %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://help.citrusad.com/retail-media-interface/integration/references/banner-x-reference-1.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.