> 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/it/references/banner-x-reference-1.md). # Riferimento per Banner X Di seguito vengono descritte le proprietà possibili in una richiesta standard, come indicato in [Richiesta di annunci](/retail-media-interface/integration/it/generating-ads/banner-x-responsive/requesting-banner-x-ads.md) per la tua richiesta e la risposta se ricevi un annuncio. ## Elementi richiesti | Stringa | Descrizione | Obbligatorio/facoltativo | | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- | | `BannerSlotIds` | Un array JSON dei slotId degli slot banner richiesti. | Obbligatorio | | `catalogId` | L'identificatore del catalogo prodotti del tuo sito web. | Obbligatorio | | `contentStandardId` | L'identificatore dello standard di contenuto per il tuo sito web. | Obbligatorio | | `customerId` | L'identificatore univoco per il cliente a cui vengono mostrati gli annunci. | Opzionale | | `filterMode` | Modo opzionale per definire la struttura della tua richiesta. Vedi [Filtraggio della generazione di annunci](/retail-media-interface/integration/it/data-api/api-overview/ad-generation-filtering-1.md) per maggiori informazioni. | Opzionale, preferito | | `maxNumberOfAds` | Il numero massimo per ogni slot banner che desideri ricevere in risposta. | Obbligatorio | | `options` |

Modo opzionale per definire la struttura della tua richiesta. Vedi Filtraggio della generazione di annunci per maggiori informazioni.

Questo è anche l'oggetto in cui puoi richiedere informazioni sull'inserzionista per conformarti alla legislazione pubblicitaria locale come quella Legge sui servizi digitali .

| Opzionale, preferito | | `placement` | Il posizionamento univoco per cui stai richiedendo gli annunci. | Obbligatorio | | `productFilters` | Qualsiasi filtro di prodotto pertinente alla tua richiesta. Ad esempio un filtro per categoria, posizione o dimensione. | Obbligatorio per i posizionamenti di categoria | | `searchTerm` | Il termine di ricerca inserito dal tuo cliente nel tuo sito web. | Obbligatorio per i posizionamenti di ricerca | | `sessionId` | L'identificatore univoco della sessione del cliente. Utilizzato per l'attribuzione nelle integrazioni standard. Consulta [Opzioni del flusso di lavoro di integrazione](/retail-media-interface/integration/it/data-api/api-overview/integration-workflow-options-1.md)per maggiori informazioni. | Obbligatorio nelle integrazioni standard | | `slotId` | Questo contiene qualsiasi SlotId richiesto nel contesto. Ce ne può essere uno o molti. | Obbligatorio | | `dtmCookieId` | Cookie creati e memorizzati dal sito web, utilizzati per monitorare il comportamento dell'utente sullo stesso dominio. | Opzionale | | `audience` | Specifica i segmenti di pubblico specifici a cui appartiene l'acquirente. Rilevante solo se si utilizza [Opzione di targeting per pubblico 3](/retail-media-interface/integration/it/data-api/audience-targeting-new/integration-option-3-sync-audiences-only.md) | Opzionale | ## Elementi restituiti | Stringa | Descrizione | Valore di esempio | | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ads.backgroundColour` | Il colore di sfondo del banner - solo valori HEX. | `6e6c6c` | | `ads.backgroundImage` | Il link dell'immagine di sfondo del banner. | `[]\() | | `ads.backgroundImagePosition` | Definisce il tipo di posizione dell'immagine di sfondo. Se non c'è alcun valore, dovrai impostare di default `leftaligned` . |

leftaligned
rightaligned
fill
repeating

| | `ads.bannerText` | Il testo visualizzato nel banner. Può includere tag HTML | `Double Fudge Ice Cream` | | `ads.bannerTextColour` | Il colore del testo del banner - solo valori HEX. Citrus non invia il `#`. | `1dc711` | | `ads.citrusAdId` |

L'ID univoco dell'annuncio.
Questo è univoco per ogni richiesta effettuata a Epsilon Retail Media e non può essere memorizzato in cache.

| `shotgun_wIpZraEXcIu0daC5YMQewPil2S83NzE0MTA3` | | `ads.citrusCampaignName` | Il nome della campagna dell'annuncio. | `Epsilon-Example-Category-Banner-X-Ad-ae536b0d5c3ded28ea624ab4285facd6` | | `ads.citrusContentStandardId` | L'ID dello standard di contenuto relativo allo slot. | `8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c` | | `ads.citrusExpiry` | La scadenza dell'annuncio. Questo è l'ultimo momento in cui un clic può essere segnalato a Epsilon Retail Media | `2021-06-01T23:48:16.573967987Z` | | `ads.citrusSlotId` | L'ID dello slot specifico per il banner che hai richiesto. | `Category_Top` | | `ads.contentStandardId` | L'ID dello standard di contenuto relativo allo slot. Duplicato di `citrusContentStandardId` | `8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c` | | `ads.ctaFlag` | Definisce se una CTA viene mostrata o meno. |

true
false

| | `ads.ctaLink` | L'URL reindirizzato dalla CTA (è come linkUrl per i banner). Servito solo se ctaFlag è `true` | ` | | `ads.ctaText` | Il testo all'interno della CTA. | `Shop now` | | `ads.ctaTextAccessibility` | Testo di accessibilità della CTA per gli utenti di uno screen reader. | `for Double Fudge Ice Cream` | | `ads.gtins` |

Un array fino a 20 codici prodotto selezionati tra i prodotti pubblicizzati della campagna.

I retailer possono utilizzare questo elenco per automatizzare le pagine di elenco quando si fa clic sul banner o per automatizzare determinate funzionalità di rendering (roundel, prezzi, verifica del livello di stock secondario).

| `[
"7714107",
"7163379",
"7733636",
"7733657",
"7733628"
],` | | `ads.headingText` | Testo dell'intestazione per gli utenti di uno screen reader. | `Banner Advertisement for Fudge Double Ice Cream with a product image and shop now button` | | `ads.heroImageAltText` | Testo alternativo per l'immagine hero nella rara eventualità in cui non venga visualizzata. | `Image of double fudge iced cream` | | `ads.heroImage` | Il link dell'immagine hero del banner. | `[]\() | | `ads.position` | La posizione del banner nella Epsilon Retail Media risposta. È necessario rispettare questa posizione nel caso in cui vengano utilizzate campagne a Canone fisso. | 1 | | `ads.secondaryBackgroundImage` | Il link dell'immagine dello sfondo secondario. | `[]\() | | `ads.secondaryBackgroundImagePosition` | Definisce il tipo di posizione dell'immagine di sfondo secondaria. |

leftaligned
rightaligned

| | `ads.secondaryHeroImageAltText` | Testo alternativo per l'immagine hero secondaria nella rara eventualità in cui non venga visualizzata. | `Image of [brand] logo` | | `ads.secondaryHeroImage` | Il link dell'immagine hero secondaria. | `[]\() | | `ads.secondaryHeroMode` | Definisce la modalità di visualizzazione dell'immagine hero secondaria. Se non c'è alcun valore, dovrai impostare di default `block` . |

block
landscape

| | `ads.slotId` | Lo slot ID del banner che hai richiesto. Quando si richiedono più banner, questo può essere utilizzato per fare riferimento agli ID richiesti. | `Category_Top` | | `ads.tags` | Questo campo restituisce eventuali tag di terze parti inseriti dall'inserzionista nella propria campagna. Al momento non è una funzionalità supportata dai banner x, sebbene la risposta API sia formattata. | `{}` | | `ads.sellerId` | L'ID univoco del venditore. Verrà popolato solo se sellerId è impostato su un team. I sellerId vengono in genere utilizzati durante l'onboarding dei venditori del marketplace. | `73nns-32sxr-32ss` Personalizzato per integrazione | | `ads.metadata` |

Oggetto contenente le informazioni sull'inserzionista necessarie per aiutare gli inserzionisti a rispettare la legislazione pubblicitaria locale come la Legge sui servizi digitali in Europa.

advertiser viene ricavato dal Nome azienda nel team del fornitore.

onBehalfOf viene ricavato dal Finanziatore dell'annuncio nel team del fornitore.

| `"metadata": {
"advertiserInfo": {
"advertiser": "Bob's advertising agency",
"onBehalfOf": "Brand company inc"
}
...` | | `ads.adm` | Oggetto contenente i dettagli dell'annuncio video, inclusi i tag VAST. | "\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` | Dettagli sui prodotti companion. |

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

| | `metadata.warnings` | Oggetto contenente informazioni sugli avvisi relativi alla richiesta di annuncio. Attualmente avvisa solo se viene superato il numero massimo di segmenti. | `"metadata": {
"warnings": [
"Audience Segment IDs exceeded the limit of {maxSegmentIds} and were truncated"
]
}` | {% hint style="info" %} Se è presente un campo non configurato come parte della campagna dell'annuncio, questo non verrà erogato. Ad esempio, se l'inserzionista non ha configurato un `heroImage`, Epsilon Retail Media non erogherà la `heroImage` proprietà. {% 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/it/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.