> 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/sv/references/banner-x-reference-1.md).
# Referens för banner X
Nedanstående beskriver de egenskaperna som är möjliga i en standardbegäran så som beskrivs i [Begära annonser](/retail-media-interface/integration/sv/generating-ads/banner-x-responsive/requesting-banner-x-ads.md) för din begäran, och svaret om du får en annons.
## Begärda objekt
| Sträng | Beskrivning | Obligatorisk/valfri |
| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- |
| `BannerSlotIds` | En json-matris med de banner slotIds som begärs. | Obligatorisk |
| `catalogId` | Din produktkatalogidentifierare för din webbplats. | Obligatorisk |
| `contentStandardId` | Innehållsstandardidentifieraren för din webbplats. | Obligatorisk |
| `customerId` | Den unika identifieraren för kunden som visas annonser. | Valfri |
| `filterMode` | Valfritt sätt att definiera strukturen på din begäran. Se [Filtrering för annonsgenerering](/retail-media-interface/integration/sv/data-api/api-overview/ad-generation-filtering-1.md) för mer information. | Valfri, föredras |
| `maxNumberOfAds` | Det maximala antalet av varje Bannerplats du vill ska returneras. | Obligatorisk |
| `options` | Valfritt sätt att definiera strukturen på din begäran. Se Filtrering för annonsgenerering för mer information.
Detta är också objektet där du kan begära annonsörsinformation för att uppfylla lokal annonseringslagstiftning som Europas Förordning om digitala tjänster .
| Valfri, föredras |
| `placement` | Den unika placeringen du begär annonser för. | Obligatorisk |
| `productFilters` | Eventuella produktfilter som är relevanta för din begäran. Till exempel ett kategori-, plats- eller storleksfilter. | Obligatoriskt för kategoriplaceringar |
| `searchTerm` | Sökbegreppet som skrivits in av din kund på din webbplats. | Obligatoriskt för sökplaceringar |
| `sessionId` | Den unika identifieraren för kundens session. Används för attribuering i standardintegrationer. Granska [Arbetsflödesalternativ för integration](/retail-media-interface/integration/sv/data-api/api-overview/integration-workflow-options-1.md)för mer information. | Obligatorisk i standardintegrationer |
| `slotId` | Detta innehåller alla begärda SlotId i kontexten. Det kan finnas en eller flera. | Obligatorisk |
| `dtmCookieId` | Cookies som skapas och lagras av webbplatsen, använd för att spåra användarbeteende på samma domän. | Valfri |
| `audience` | Anger specifika målgruppssegment som köparen tillhör. Endast relevant om du använder [Målgruppsanpassning alternativ 3](/retail-media-interface/integration/sv/data-api/audience-targeting-new/integration-option-3-sync-audiences-only.md) | Valfri |
## Returnerade objekt
| Sträng | Beskrivning | Exempelvärde |
| -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ads.backgroundColour` | Bakgrundsfärgen på bannern - endast HEX-värden. | `6e6c6c` |
| `ads.backgroundImage` | Bildlänken för bannerns bakgrundsbild. | `[]\() |
| `ads.backgroundImagePosition` | Detta definierar positionstypen för bakgrundsbilden. Om inget värde finns måste du använda standardvärdet `leftaligned` . | leftaligned
rightaligned
fill
repeating
|
| `ads.bannerText` | Texten som visas i bannern. Kan innehålla HTML-taggar | `Double Fudge Ice Cream` |
| `ads.bannerTextColour` | Bannerns textfärg - endast HEX-värden. Citrus skickar inte `#`. | `1dc711` |
| `ads.citrusAdId` | Det unika id:t för annonsen.
Detta är unikt för varje begäran som görs till Epsilon Retail Media och kan inte cachas.
| `shotgun_wIpZraEXcIu0daC5YMQewPil2S83NzE0MTA3` |
| `ads.citrusCampaignName` | Annonsens kampanjnamn. | `Epsilon-Example-Category-Banner-X-Ad-ae536b0d5c3ded28ea624ab4285facd6` |
| `ads.citrusContentStandardId` | Innehållsstandard-id relaterat till platsen. | `8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c` |
| `ads.citrusExpiry` | Annonsens utgångstid. Detta är den senaste tidpunkten då ett klick kan rapporteras till Epsilon Retail Media | `2021-06-01T23:48:16.573967987Z` |
| `ads.citrusSlotId` | ID:t för den specifika platsen för bannern som du har begärt. | `Category_Top` |
| `ads.contentStandardId` | Innehållsstandard-id relaterat till platsen. Duplikat av `citrusContentStandardId` | `8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c` |
| `ads.ctaFlag` | Detta definierar om en CTA visas eller inte. | true
false
|
| `ads.ctaLink` | URL:en som vidarebefordras från CTA (detta är som linkUrl för banners). Serveras endast om ctaFlag är `true` | ` |
| `ads.ctaText` | Texten i CTA. | `Shop now` |
| `ads.ctaTextAccessibility` | Tillgänglighetstext för CTA för skärmläsaranvändare. | `for Double Fudge Ice Cream` |
| `ads.gtins` | En matris med upp till 20 produktkoder valda från kampanjens annonserade produkter.
Återförsäljare kan använda denna lista för att automatisera listsidor när bannern klickas, eller automatisera viss återgivningsfunktionalitet (roundels, prissättning, sekundär lagernivåkontroll).
| `[
"7714107",
"7163379",
"7733636",
"7733657",
"7733628"
],` |
| `ads.headingText` | Rubriktext för skärmläsaranvändare. | `Banner Advertisement for Fudge Double Ice Cream with a product image and shop now button` |
| `ads.heroImageAltText` | Alternativ text för huvudbilden i det sällsynta fall den inte visas. | `Image of double fudge iced cream` |
| `ads.heroImage` | Bildlänken för bannerns huvudbild. | `[]\() |
| `ads.position` | Bannerns position i Epsilon Retail Media svaret. Du bör respektera denna position i händelse av att kampanjer med Fast placering används. | 1 |
| `ads.secondaryBackgroundImage` | Bildlänken för den sekundära bakgrundsbilden. | `[]\() |
| `ads.secondaryBackgroundImagePosition` | Detta definierar positionstypen för den sekundära bakgrundsbilden. | leftaligned
rightaligned
|
| `ads.secondaryHeroImageAltText` | Alternativ text för den sekundära hero-bilden i det sällsynta fall den inte visas. | `Image of [brand] logo` |
| `ads.secondaryHeroImage` | Bildlänken för den sekundära hero-bilden. | `[]\() |
| `ads.secondaryHeroMode` | Detta definierar visningsläget för den sekundära hero-bilden. Om inget värde finns måste du använda standardvärdet `block` . | block
landscape
|
| `ads.slotId` | Plats-ID för bannern du har begärt. När du begär flera banners kan detta användas för att referera till de begärda ID:na. | `Category_Top` |
| `ads.tags` | Det här fältet returnerar eventuella tredjepartstaggar som annonsören har anger i sin kampanj. Detta stöds för närvarande inte av banner x, även om API-svaret är formaterat. | `{}` |
| `ads.sellerId` | Det unika ID:t för säljaren. Fylls endast i om ett sellerId har angetts för ett team. sellerIds används vanligtvis vid onboarding av marknadsplatssäljare. | `73nns-32sxr-32ss` Anpassad per integration |
| `ads.metadata` | Objekt som innehåller den annonsörsinformation som krävs för att hjälpa annonsörer att följa lokal annonslagstiftning såsom Förordning om digitala tjänster i Europa.
advertiser hämtas från Företagsnamnet i leverantörsteamet.
onBehalfOf hämtas från Annonsfinansiären i leverantörsteamet.
| `"metadata": {
"advertiserInfo": {
"advertiser": "Bob's advertising agency",
"onBehalfOf": "Brand company inc"
}
...` |
| `ads.adm` | Objekt som innehåller videoannonsinformation inklusive VAST-taggar. | "\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` | Information om medföljande produkter. | “companionProducts”: \[
"Banana14-simfk15"
"Oranges5-qgxeb6",
"Incaberries20-ppscn21"
|
| `metadata.warnings` | Objekt som innehåller varningsinformation om annonsbegäran. Varnar för närvarande endast om det maximala antalet segment överskrids. | `"metadata": {
"warnings": [
"Audience Segment IDs exceeded the limit of {maxSegmentIds} and were truncated"
]
}` |
{% hint style="info" %}
Om det finns ett fält som inte är konfigurerat som en del av annonsens kampanj kommer den inte att visas, t.ex. om annonsören inte har konfigurerat en `heroImage`, Epsilon Retail Media kommer inte att visa egenskapen `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/sv/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.