> 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/de/references/banner-x-reference-1.md). # Banner X-Referenz Im Folgenden sind die möglichen Eigenschaften in einer Standardanfrage beschrieben, wie unter [Anzeigen anfordern](/retail-media-interface/integration/de/generating-ads/banner-x-responsive/requesting-banner-x-ads.md) für Ihre Anfrage angegeben, sowie die Antwort, wenn Sie eine Anzeige erhalten. ## Angeforderte Elemente | String | Beschreibung | Erforderlich/Optional | | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | | `BannerSlotIds` | Ein JSON-Array der angeforderten Banner-slotIds. | Erforderlich | | `catalogId` | Ihre Produktkatalog-Kennung für Ihre Website. | Erforderlich | | `contentStandardId` | Die Inhaltsstandard-Kennung für Ihre Website. | Erforderlich | | `customerId` | Die eindeutige Kennung für den Kunden, dem Anzeigen ausgespielt werden. | Optional | | `filterMode` | Optionale Möglichkeit, die Struktur Ihrer Anfrage zu definieren. Siehe [Anzeigengenerierungsfilterung](/retail-media-interface/integration/de/data-api/api-overview/ad-generation-filtering-1.md) für weitere Informationen. | Optional, bevorzugt | | `maxNumberOfAds` | Die maximale Anzahl jedes Banner-Slots, die Sie zurückerhalten möchten. | Erforderlich | | `options` |

Optionale Möglichkeit, die Struktur Ihrer Anfrage zu definieren. Siehe Filterung bei der Anzeigenerstellung für weitere Informationen.

Dies ist auch das Objekt, in dem Sie Werbetreibenden-Informationen anfordern können, um lokale Werbegesetze zu erfüllen, wie etwa das europäische Gesetz über digitale Dienste .

| Optional, bevorzugt | | `placement` | Die eindeutige Platzierung, für die Sie Anzeigen anfordern. | Erforderlich | | `productFilters` | Alle für Ihre Anfrage relevanten Produktfilter. Wie z. B. ein Kategorie-, Standort- oder Größenfilter. | Erforderlich für Kategorie-Platzierungen | | `searchTerm` | Der von Ihrem Kunden auf Ihrer Website eingegebene Suchbegriff. | Erforderlich für Such-Platzierungen | | `sessionId` | Die eindeutige Kennung der Kundensitzung. Wird für die Zuordnung in Standardintegrationen verwendet. Überprüfen Sie [Integrations-Workflow-Optionen](/retail-media-interface/integration/de/data-api/api-overview/integration-workflow-options-1.md)für weitere Informationen. | Erforderlich bei Standardintegrationen | | `slotId` | Dies enthält jede angeforderte SlotId im Kontext. Es können eine oder mehrere sein. | Erforderlich | | `dtmCookieId` | Von der Website erstellte und gespeicherte Cookies, die zur Verfolgung des Nutzerverhaltens auf derselben Domain verwendet werden. | Optional | | `audience` | Gibt spezifische Zielgruppensegmente an, denen der Käufer angehört. Nur relevant bei der Verwendung von [Zielgruppen-Targeting-Option 3](/retail-media-interface/integration/de/data-api/audience-targeting-new/integration-option-3-sync-audiences-only.md) | Optional | ## Zurückgegebene Elemente | String | Beschreibung | Beispielwert | | -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ads.backgroundColour` | Die Hintergrundfarbe des Banners – nur HEX-Werte. | `6e6c6c` | | `ads.backgroundImage` | Der Bild-Link des Banner-Hintergrundbildes. | `[]\() | | `ads.backgroundImagePosition` | Dies definiert den Positionstyp des Hintergrundbildes. Wenn kein Wert vorhanden ist, müssen Sie standardmäßig auf `leftaligned` . |

leftaligned
rightaligned
fill
repeating

| | `ads.bannerText` | Der im Banner angezeigte Text. Kann HTML-Tags enthalten | `Double Fudge Ice Cream` | | `ads.bannerTextColour` | Die Bannertextfarbe – nur HEX-Werte. Citrus sendet nicht das `#`. | `1dc711` | | `ads.citrusAdId` |

Die eindeutige ID der Anzeige.
Dies ist eindeutig für jede Anfrage an Epsilon Retail Media und kann nicht zwischengespeichert werden.

| `shotgun_wIpZraEXcIu0daC5YMQewPil2S83NzE0MTA3` | | `ads.citrusCampaignName` | Der Kampagnenname der Anzeige. | `Epsilon-Example-Category-Banner-X-Ad-ae536b0d5c3ded28ea624ab4285facd6` | | `ads.citrusContentStandardId` | Die mit dem Slot verknüpfte Inhaltsstandard-ID. | `8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c` | | `ads.citrusExpiry` | Ablaufdatum/-zeit der Anzeige. Dies ist der späteste Zeitpunkt, zu dem ein Klick gemeldet werden kann an Epsilon Retail Media | `2021-06-01T23:48:16.573967987Z` | | `ads.citrusSlotId` | Die ID des spezifischen Slots für das von Ihnen angeforderte Banner. | `Category_Top` | | `ads.contentStandardId` | Die mit dem Slot verknüpfte Inhaltsstandard-ID. Duplikat von `citrusContentStandardId` | `8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c` | | `ads.ctaFlag` | Dies definiert, ob ein CTA angezeigt wird oder nicht. |

true
false

| | `ads.ctaLink` | Die vom CTA weitergeleitete URL (dies ist wie linkUrl für Banner). Wird nur bereitgestellt, wenn ctaFlag ist `true` | ` | | `ads.ctaText` | Der Text innerhalb des CTA. | `Shop now` | | `ads.ctaTextAccessibility` | Barrierefreiheits-Text des CTA für Screenreader-Nutzer. | `for Double Fudge Ice Cream` | | `ads.gtins` |

Ein Array von bis zu 20 Produktcodes, die aus den beworbenen Produkten der Kampagne ausgewählt wurden.

Händler können diese Liste nutzen, um Übersichtsseiten zu automatisieren, wenn auf das Banner geklickt wird, oder um bestimmte Rendering-Funktionen zu automatisieren (Roundels, Preisgestaltung, sekundäre Lagerstandsprüfung).

| `[
"7714107",
"7163379",
"7733636",
"7733657",
"7733628"
],` | | `ads.headingText` | Überschriften-Text für Screenreader-Nutzer. | `Banner Advertisement for Fudge Double Ice Cream with a product image and shop now button` | | `ads.heroImageAltText` | Alternativtext für das Hero-Image für den seltenen Fall, dass es nicht angezeigt wird. | `Image of double fudge iced cream` | | `ads.heroImage` | Der Bild-Link des Hero-Images des Banners. | `[]\() | | `ads.position` | Die Position des Banners in der Epsilon Retail Media Antwort. Sie sollten diese Position berücksichtigen, falls Feste Platzierung-Kampagnen verwendet werden. | 1 | | `ads.secondaryBackgroundImage` | Der Bild-Link des sekundären Hintergrundbildes. | `[]\() | | `ads.secondaryBackgroundImagePosition` | Dies definiert den Positionstyp des sekundären Hintergrundbildes. |

leftaligned
rightaligned

| | `ads.secondaryHeroImageAltText` | Alternativtext für das sekundäre Hero-Image für den seltenen Fall, dass es nicht angezeigt wird. | `Image of [brand] logo` | | `ads.secondaryHeroImage` | Der Bild-Link des sekundären Hero-Images. | `[]\() | | `ads.secondaryHeroMode` | Dies definiert den Anzeigemodus des sekundären Hero-Images. Wenn kein Wert vorhanden ist, müssen Sie standardmäßig auf `block` . |

block
landscape

| | `ads.slotId` | Die Slot-ID des von Ihnen angeforderten Banners. Bei der Anfrage mehrerer Banner kann dies verwendet werden, um auf die angeforderten IDs zu verweisen. | `Category_Top` | | `ads.tags` | Dieses Feld gibt alle Drittanbieter-Tags zurück, die vom Werbetreibenden in seiner Kampagne eingegeben wurden. Dies wird derzeit von Banner x nicht unterstützt, obwohl die API-Antwort entsprechend formatiert ist. | `{}` | | `ads.sellerId` | Die eindeutige Id des Verkäufers. Wird nur ausgefüllt, wenn für ein Team eine sellerId festgelegt ist. sellerIds werden in der Regel beim Onboarding von Marketplace-Verkäufern verwendet. | `73nns-32sxr-32ss` Benutzerdefiniert pro Integration | | `ads.metadata` |

Objekt mit den Informationen zum Werbetreibenden, die erforderlich sind, um Werbetreibenden dabei zu helfen, lokale Werbevorschriften einzuhalten, wie z. B. die Gesetz über digitale Dienste in Europa.

advertiser wird aus dem Firmennamen im Lieferantenteam übernommen.

onBehalfOf wird aus dem Werbekostenträger im Lieferantenteam übernommen.

| `"metadata": {
"advertiserInfo": {
"advertiser": "Bob's advertising agency",
"onBehalfOf": "Brand company inc"
}
...` | | `ads.adm` | Objekt mit den Videoanzeigendetails einschließlich 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` | Details zu Begleitprodukten. |

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

| | `metadata.warnings` | Objekt mit Warninformationen zur Anzeigenanfrage. Warnt derzeit nur, wenn die maximale Anzahl von Segmenten überschritten wird. | `"metadata": {
"warnings": [
"Audience Segment IDs exceeded the limit of {maxSegmentIds} and were truncated"
]
}` | {% hint style="info" %} Wenn ein Feld nicht als Teil der Kampagne der Anzeige konfiguriert ist, wird sie nicht ausgeliefert. D. h. wenn der Werbetreibende kein `heroImage`, Epsilon Retail Media konfiguriert hat, wird die Eigenschaft `heroImage` nicht ausgeliefert. {% 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/de/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.