> For the complete documentation index, see [llms.txt](https://developers.citrusad.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.citrusad.com/integration/reference/banner-ad-static-reference.md).

# Banner ad (static) reference

{% hint style="info" %}
Epsilon Retail Media's documentation is now centralized with our knowledgebase!

For up to date guides, please view [this page](https://help.citrusad.com/retail-media-interface/integration/references/banner-ad-static-reference) in the new Integration APIs space of our documentation.
{% endhint %}

The below outlines the properties possible in a standard request as outlined in [Requesting banner ads](/integration/reference/requesting-banner-ads.md) for your request, and the response if you receive an ad.

{% hint style="info" %}
Banner ads are requested on the same `/generate` endpoint as product ads. A single request can be used to retrieve both ad types.
{% endhint %}

## Requested items

| String              | Description                                                                                                                                                                                                                                                                                                                                                                                                            | Required/optional                                                                                        |
| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| `bannerSlots`       | An array of banner slots that you wish to receive banner ads for. By specifying a maxNumberOfAds for the banner slots, you can retrieve more than one banner for the slot. Such a use case would be for carousel placements.                                                                                                                                                                                           | Required                                                                                                 |
| `bannerSlotIds`     | An array of banner slots that you wish to receive banner ads for                                                                                                                                                                                                                                                                                                                                                       | Required, superseded by bannerSlots                                                                      |
| `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](/integration/reference/ad-generation-filtering-1.md) for more information.                                                                                                                                                                                                                                                       | Optional, preferred                                                                                      |
| `maxNumberOfAds`    | The maximum number of product ads you would like returned up to 15.                                                                                                                                                                                                                                                                                                                                                    | Required, enables product ads to be served in the same request. If no product ads are wanted, set to `0` |
| `options`           | <p>Optional way of defining the structure of your request. See <a href="/integration/reference/ad-generation-filtering-1.md">Ad generation filtering</a> for more information.<br><br>This is also the object where you can request advertiser information in order to comply with local advertising legislation like Europe’s <a href="/integration/reference/digital-services-act.md">Digital Services Act</a> .</p> | 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.                                                                                                                                                                                                                                                                                                                                   | Required                                                                                                 |
| `sessionId`         | The unique identifier of the customer's session. Used for attribution in standard integrations. Review Integration workflow options for more information.                                                                                                                                                                                                                                                              | Required in standard integrations                                                                        |
| `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](/integration/reference/integration-option-3-sync-audiences-only.md)                                                                                                                                                                                                                             | Optional                                                                                                 |

## Returned items

| String                      | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | Example value                                                                                                                                                                                                                          |
| --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `banners.altText`           | Alternative text for the hero image in the rare event it doesn't display.                                                                                                                                                                                                                                                                                                                                                                                                     | `Advertisement for &lt;BRAND&gt;. Art of the Burger. Create your delicious masterpiece. Shop Now.`                                                                                                                                     |
| `banners.contentStandardId` | The content standard identifier for your website.                                                                                                                                                                                                                                                                                                                                                                                                                             | \`4ffb80ba-b9a9-4567-8069-79b2eca93473                                                                                                                                                                                                 |
| `banners.expiry`            | 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`                                                                                                                                                                                                       |
| `banners.id`                | <p>The unique id of the ad.<br>This is unique to each request made to Epsilon Retail Media and cannot be cached.</p>                                                                                                                                                                                                                                                                                                                                                          | `banner_j2vfi9pN2BiQZk4X9sC55PgNu5k3ODIzOTlfMDAwODc2ODQwMDEwNzM=`                                                                                                                                                                      |
| `banners.imageUrl`          | The image link of the banner.                                                                                                                                                                                                                                                                                                                                                                                                                                                 | `[<https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3`>]\(<https://cdn.\\[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3\\`>)                                                                                           |
| `banners.gtins`             | An array of up to 20 product codes selected from the campaign's advertised products.                                                                                                                                                                                                                                                                                                                                                                                          | `[<br> "7714107",<br> "7163379",<br> "7733636",<br> "7733657",<br> "7733628"<br> ],`                                                                                                                                                   |
| `banners.linkUrl`           | The url forwarded from the banner when the customer clicks the banner.                                                                                                                                                                                                                                                                                                                                                                                                        | `<https://www.retailer.com/groceries/en-GB/search?query=double-fudge`>                                                                                                                                                                 |
| `banners.slotId`            | The id of the specific slot for the banner you have requested.                                                                                                                                                                                                                                                                                                                                                                                                                | `Category_Top`                                                                                                                                                                                                                         |
| `banners.tags`              | This field returns any third party tags entered by the advertiser in their campaign.                                                                                                                                                                                                                                                                                                                                                                                          | `{<br> "dv": "&lt;script src=\"<https://cdn.doubleverify.com/dvtp_src.js?ctx=111111&cmp=11111111&sid=111111&plc=111111&adsrv=111&btreg=&btadsrv=&crt=&tagtype=&dvtagver=6.1.src\>" type=\"text/javascript\"&gt;&lt;/script&gt;"<br> }` |
| `banners.text`              | Used in bespoke integrations as an additional text field.                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                                                                                                                                                                                                        |
| `banners.position`          | The ad's position in the Epsilon Retail Media response. You should honour this position in the event fixed tenancy campaigns are utilised.                                                                                                                                                                                                                                                                                                                                    | 1                                                                                                                                                                                                                                      |
| `banners.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                                                                                                                                                                                              |
| `banners.metadata`          | <p>Object containing the advertiser info required to help advertisers comply with local advertising legislation such as the <a href="https://commission.europa.eu/strategy-and-policy/priorities-2019-2024/europe-fit-digital-age/digital-services-act_en">Digital Services Act</a> in Europe.<br><br><code>advertiser</code> is carried from the Company name in the supplier team.<br><br><code>onBehalfOf</code> is carried from the Ad financer in the supplier team.</p> | `"metadata": { <br> "advertiserInfo": { <br> "advertiser": "Bob's advertising agency", <br> "onBehalfOf": "Brand company inc" <br> } <br> ...`                                                                                         |
| `metadata.warnings`         | Object containing warning information about the ad request. Currently only warns if the maximum number of segments is exceeded.                                                                                                                                                                                                                                                                                                                                               | `"metadata": { <br> "warnings": [ <br> "Audience Segment IDs exceeded the limit of 100 and were truncated" <br> ] <br> }`                                                                                                              |
