> 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/brand-pages/brand-page-retailer-integration-guide/module-capabilities.md).
# Dettaglio funzionalità dei moduli
Questo documento descrive tutti i tipi di modulo disponibili, i relativi campi, vincoli e opzioni di configurazione. Usalo come riferimento rivolto ai retailer per scoprire cosa supporta ciascun modulo e cosa possono configurare i brand durante la creazione dei contenuti della Pagina del brand.
***
## Tipi di modulo in sintesi
| Modulo | Scopo |
| ------------------ | ---------------------------------------------------------------------- |
| Banner Hero | Media a larghezza intera con titolo, sottotitolo e CTA |
| Immagine | Singola immagine con didascalia opzionale, testo alternativo e link |
| Testo | Titolo, tagline, testo del corpo o testo personalizzato su più righe |
| Layout diviso | Layout a due colonne o impilato contenente moduli Immagine e/o Testo |
| Galleria immagini | Griglia di immagini con titolo di sezione opzionale, descrizione e CTA |
| Menu di filtraggio | Barra di navigazione con elementi di filtraggio etichettati |
| Griglia prodotti | Griglia di prodotti selezionati con filtraggio opzionale e CTA |
## Campi comuni (tutti i moduli)
Ogni modulo condivide i seguenti campi gestiti dal sistema. I brand non li impostano direttamente.
| Campo | Descrizione |
| --------------------------- | ------------------------------------------------------------------------------------- |
| `id` | Identificatore univoco generato automaticamente |
| `brandPageModuleTemplateId` | Collega il contenuto al modello di modulo del retailer |
| `order` | Posizione di visualizzazione sulla pagina (gestita tramite trascinamento) |
| `optionality` | Indica se l'intero modulo è obbligatorio o può essere saltato (definito dal retailer) |
## 1. Banner Hero
Un banner a larghezza intera che combina un'immagine di sfondo, un overlay, un testo del titolo e una call-to-action. Di solito è il primo modulo sulla Pagina del brand.
### Media
| Campo | Obbligatorio? | Vincoli |
| ----------------- | ------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------- |
| Immagine | Obbligatorio | Formati: `GIF`, `JPG`, `PNG`, `SVG` · Dimensioni minime: definite dal retailer · Dimensione massima del file: definita dal retailer |
| Testo alternativo | Obbligatorio o Opzionale (definito dal retailer) | Testo descrittivo per l'accessibilità |
{% hint style="info" %}
Il supporto video è pianificato ma non ancora disponibile. Al momento è accettata solo l'immagine.
{% endhint %}
### Overlay
Il retailer definisce se un overlay è disponibile su questo modulo:
| Impostazione | Comportamento |
| ----------------------- | ------------------------------------------------------------------------ |
| `disabled` | Nessun overlay — l'immagine viene mostrata senza alcun livello di colore |
| `optional` (consentito) | Il brand può scegliere se abilitare o disabilitare l'overlay |
| `required` | L'overlay è sempre mostrato; il brand non può disattivarlo |
Quando l'overlay è abilitato, il brand seleziona lo stile dello sfondo. Il retailer controlla quali stili vengono offerti:
| Stile | Descrizione |
| ---------- | --------------------------------------- |
| `gradient` | Sfumatura graduale dall'immagine |
| `solid` | Blocco di colore piatto dietro il testo |
Entrambe le opzioni possono essere rese disponibili contemporaneamente.
### Contenuto del testo
| Campo | Obbligatorio? | Vincoli |
| ---------------------- | -------------------------------------------------------------- | ---------------------------------------------------------------- |
| Titolo | Obbligatorio | Caratteri max: definiti dal retailer |
| Sottotitolo | Opzionale | Caratteri max: definiti dal retailer |
| Testo del pulsante CTA | Obbligatorio, Opzionale o Disabilitato (definito dal retailer) | Caratteri max: definiti dal retailer |
| URL del link della CTA | Obbligatorio, Opzionale o Disabilitato (definito dal retailer) | Caratteri max: definiti dal retailer · Deve essere un URL valido |
{% hint style="info" %}
Il testo della CTA e il link della CTA vengono configurati insieme. Se la CTA è disabilitata, non appare nessuno dei due campi. Non è possibile avere un link CTA senza un pulsante CTA, o viceversa.
{% endhint %}
### Allineamento del testo
Il retailer definisce quali opzioni di allineamento sono disponibili. Valori possibili: `left`, `center`, `right`. Il brand seleziona dal set offerto.
## 2. Immagine
Un'immagine singola con legenda opzionale, testo alternativo e una destinazione del link.
### Caricamento immagine
| Campo | Obbligatorio? | Vincoli |
| ----------------- | ------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------- |
| Immagine | Obbligatorio | Formati: `GIF`, `JPG`, `PNG`, `SVG` · Dimensioni minime: definite dal retailer · Dimensione massima del file: definita dal retailer |
| Testo alternativo | Obbligatorio o Opzionale (definito dal retailer) | Testo descrittivo per l'accessibilità |
### Legenda
| Campo | Obbligatorio? | Vincoli |
| ------- | ------------- | --------------------------------------------------- |
| Legenda | Opzionale | Caratteri max: definiti dal retailer · Riga singola |
{% hint style="info" %}
La disponibilità della legenda è definita dal retailer. Se il retailer non ha abilitato le legende, il campo non viene visualizzato.
{% endhint %}
### Link
Ogni immagine può facoltativamente essere collegata a una destinazione. Il brand seleziona uno dei tre tipi di link:
| Tipo di link | Descrizione |
| ------------ | --------------------------------------------------------------------------------------------------- |
| `image` | Nessun link — l'immagine non è interattiva |
| `url` | Naviga verso un URL personalizzato quando selezionato |
| `product` | Naviga verso una pagina di dettaglio prodotto specifica (selezionata tramite il selettore prodotti) |
### Righe di testo aggiuntive
Alcuni moduli Immagine supportano righe di testo etichettate aggiuntive accanto all'immagine (ad esempio, un titolo o una descrizione mostrati sotto o sopra l'immagine). La disponibilità, le etichette, le dimensioni del carattere e l'obbligatorietà o meno di ciascuna riga sono tutte definite dal retailer.
## 3. Testo
Un modulo di testo flessibile che supporta varianti a riga singola e multilinea.
### Varianti
Il retailer definisce quale variante utilizza il modulo:
| Variante | Descrizione |
| ---------- | --------------------------------------------------------------------------------------------- |
| `headline` | Una singola riga di testo in evidenza — grande, in grassetto |
| `tagline` | Una singola riga di supporto — più piccola dell'intestazione |
| `body` | Un singolo blocco di testo principale — viene visualizzato come un'area di testo |
| `lines` | Più righe di testo denominate, ciascuna con la propria dimensione del carattere e opzionalità |
### Campi — varianti a riga singola (`headline`, `tagline`, `body`)
| Campo | Obbligatorio? | Vincoli |
| ----- | ------------- | ------------------------------------------------------------------ |
| Testo | Obbligatorio | Caratteri max: definiti dal retailer (si applica all'intero campo) |
### Campi — variante multilinea (`lines`)
Ciascuna riga è definita in modo indipendente dal retailer:
| Campo | Obbligatorio? | Vincoli |
| ---------------- | ---------------------------------------------------------- | ------------------------------------------------------------- |
| Testo della riga | Obbligatorio o Opzionale (per riga, definito dal retailer) | Caratteri max: definiti dal retailer (si applica per riga) |
| URL della riga | Opzionale | Disponibile solo sulle righe in cui `isHyperlink` è abilitato |
### CTA
| Campo | Obbligatorio? | Vincoli |
| ---------------------- | -------------------------------------------------------------- | ------------------------- |
| Testo del pulsante CTA | Obbligatorio, Opzionale o Disabilitato (definito dal retailer) | — |
| URL del link della CTA | Obbligatorio, Opzionale o Disabilitato (definito dal retailer) | Deve essere un URL valido |
{% hint style="info" %}
L'opzionalità della CTA si applica sia al testo sia all'URL insieme. Se disabilitata, non appare nessuno dei due campi.
{% endhint %}
### Allineamento
Definito dal retailer. Valori possibili: `left`, `center`, `right`. Si applica a tutto il testo nel modulo.
### Larghezza massima
Il retailer imposta un vincolo di `maxWidth` che limita la larghezza massima con cui il blocco di testo può essere mostrato (ad esempio, `600px` or `80%`). Si tratta di un vincolo di visualizzazione, non di un vincolo di contenuto.
## 4. Layout diviso
Un contenitore di layout che ospita due o più moduli figlio disposti in colonne o righe. I figli sono moduli **Immagine** e/o **Testo**. L'annidamento è supportato fino a una profondità di 2, ma non è possibile annidare i Layout divisi al livello radice.
### Opzioni di layout
| Layout | Opzioni |
| --------- | -------------------------------------------------------------------------------------------------- |
| `columns` | Fianco a fianco. Rapporto: `50:50`, `33:67`, or `67:33` (definito dal retailer tra quelli offerti) |
| `rows` | Impilati verticalmente |
### Spaziatura
Lo spazio tra i figli è definito dal retailer, ricavato dalla scala di spaziatura della guida di stile del retailer.
### Figli
| Proprietà | Valore |
| ------------------------ | --------------------------------------------------------------------------------------------- |
| Tipi di figli consentiti | `Image`, `Text` |
| Numero di figli | Definito dal retailer (`numChildren`) |
| Annidamento | Un Layout diviso figlio può a sua volta contenere moduli `Image` e `Text` (profondità max: 2) |
{% hint style="info" %}
Importante
Non è possibile inserire un Banner Hero, una Galleria immagini, un Menu filtro o una Griglia prodotti all'interno di un Layout diviso.
{% endhint %}
## 5. Galleria immagini
Una griglia di immagini con un'intestazione di sezione opzionale, una descrizione e una CTA in basso.
### Intestazione di sezione
| Campo | Obbligatorio? | Vincoli |
| ------------------------- | -------------------------------------------------------------- | ------- |
| Titolo della sezione | Obbligatorio, Opzionale o Disabilitato (definito dal retailer) | — |
| Descrizione della sezione | Obbligatorio, Opzionale o Disabilitato (definito dal retailer) | — |
### Layout della galleria
Definito dal retailer per breakpoint:
| Proprietà | Descrizione |
| ---------------- | --------------------------------------------------------------------- |
| Colonne | Numero di colonne su mobile, tablet e desktop (definito dal retailer) |
| Altezza immagine | Altezza in pixel o percentuale per breakpoint (definita dal retailer) |
| Spaziatura | Spaziatura tra le immagini (dalla guida di stile del retailer) |
### Immagini
| Proprietà | Vincoli |
| --------------------------- | --------------------------------------------------------------------- |
| Numero minimo di immagini | Definito dal retailer (è necessario aggiungerne almeno questo numero) |
| Numero massimo di immagini | Definito dal retailer (non è possibile superare questo conteggio) |
| Formati | `GIF`, `JPG`, `PNG`, `SVG` |
| Dimensioni minime | Definito dal retailer |
| Dimensione massima del file | Definito dal retailer |
| Testo alternativo | Obbligatorio o Facoltativo per immagine (definito dal retailer) |
| Didascalia per immagine | Opzionale, max caratteri: definito dal retailer |
| Link per immagine | `image` (nessuno) · `url` · `product` — uguale al modulo Immagine |
### Righe di testo aggiuntive per immagine
Uguale al modulo Immagine — etichette, dimensioni del carattere e opzionalità per riga definite dal retailer.
### CTA (in fondo alla galleria)
| Campo | Obbligatorio? | Vincoli |
| ---------------------- | -------------------------------------------------------------- | ------------------------- |
| Testo del pulsante CTA | Obbligatorio, Opzionale o Disabilitato (definito dal retailer) | — |
| URL del link della CTA | Obbligatorio, Opzionale o Disabilitato (definito dal retailer) | Deve essere un URL valido |
| Allineamento CTA | `left`, `center`, `right` (definito dal retailer) | — |
## 6. Menu dei filtri
Una barra di navigazione orizzontale di elementi filtro etichettati. Utilizzala per consentire agli acquirenti di filtrare i contenuti nella pagina (ad esempio, per categoria o sottocategoria).
### Elementi
| Proprietà | Vincoli |
| -------------------------- | ------------------------------------------------------------------------------------------ |
| Numero minimo di elementi | Definito dal retailer (è necessario aggiungerne almeno questo numero) |
| Numero massimo di elementi | Definito dal retailer (non è possibile superare questo conteggio) |
| Testo dell'etichetta | Caratteri max: definiti dal retailer |
| Valore del filtro | Valore interno utilizzato dalla logica di filtraggio. Max caratteri: definito dal retailer |
### Allineamento
Definito dal retailer. Valori possibili: `left`, `center`.
Gli elementi filtro possono essere riordinati. L'etichetta è ciò che l'acquirente vede; il valore è ciò che viene applicato come filtro. Non devono essere per forza la stessa stringa.
## 7. Griglia prodotti
Una griglia curata di prodotti selezionati dal brand, con intestazione di sezione opzionale, filtraggio e CTA.
### Intestazione di sezione
| Campo | Obbligatorio? | Vincoli |
| ------------------------- | -------------------------------------------------------------- | ------- |
| Titolo della sezione | Obbligatorio, Opzionale o Disabilitato (definito dal retailer) | — |
| Descrizione della sezione | Obbligatorio, Opzionale o Disabilitato (definito dal retailer) | — |
### Prodotti
| Proprietà | Vincoli |
| -------------------------- | ---------------------------------------------------------------- |
| Numero minimo di prodotti | Definito dal retailer |
| Numero massimo di prodotti | Definito dal retailer |
| Origine dei prodotti | Selezionati tramite il selettore prodotti dal catalogo del brand |
| Ordine di visualizzazione | Trascina e rilascia all'interno del modulo |
### CTA della scheda prodotto
Il retailer decide se far comparire un pulsante CTA su ciascuna scheda prodotto:
| Impostazione | Comportamento |
| ------------ | -------------------------------------------------------------------------------------------- |
| Disattivato | Nessun pulsante CTA sulle schede prodotto |
| Attivato | Viene visualizzato un pulsante CTA; il retailer imposta il testo dell'etichetta del pulsante |
{% hint style="info" %}
Quando attivato, tutte le schede prodotto nella griglia condividono la stessa etichetta CTA (impostata dal retailer, non dal brand).
{% endhint %}
### Filtraggio
Il retailer può facoltativamente abilitare il filtraggio nella pagina per la Griglia prodotti:
| Impostazione | Descrizione |
| ------------------- | ------------------------------------------------------------------------------ |
| `enabled` | Gli acquirenti possono filtrare la griglia prodotti |
| `showActiveFilter` | Evidenzia il filtro attualmente attivo |
| `showResultCount` | Visualizza quanti risultati corrispondono al filtro attivo |
| `emptyStateMessage` | Messaggio personalizzato mostrato quando nessun prodotto corrisponde al filtro |
{% hint style="info" %}
Il filtraggio funziona in combinazione con un modulo Menu dei filtri. I valori di filtro impostati sui prodotti devono corrispondere ai valori degli elementi filtro nel Menu dei filtri.
{% endhint %}
### CTA (in fondo alla griglia)
| Campo | Obbligatorio? | Vincoli |
| ---------------------- | -------------------------------------------------------------- | ------------------------- |
| Testo del pulsante CTA | Obbligatorio, Opzionale o Disabilitato (definito dal retailer) | — |
| URL del link della CTA | Obbligatorio, Opzionale o Disabilitato (definito dal retailer) | Deve essere un URL valido |
| Allineamento CTA | `left`, `center`, `right` (definito dal retailer) | — |
## Riferimento dei vincoli
### `ContentLimit` — modello di vincolo del campo di testo
| Valore | Significato |
| ----------------------- | ------------------------------------------------------------------------- |
| `disabled` | Il campo non è disponibile in questo template |
| `allowed` + `maxChars` | Il campo è opzionale; se compilato, non può superare `maxChars` caratteri |
| `required` + `maxChars` | Il campo deve essere compilato; non può superare `maxChars` caratteri |
### `ImageConstraints` — modello di vincolo per il caricamento dell'immagine
| Proprietà | Descrizione |
| ----------------- | ----------------------------------------------------------------------------------------- |
| `altOptionality` | `required` or `allowed` |
| `minWidth` | Larghezza minima dell'immagine in pixel (opzionale) |
| `minHeight` | Altezza minima dell'immagine in pixel (opzionale) |
| `maxFileSizeMb` | Dimensione massima del file in megabyte (opzionale) |
| `acceptedFormats` | Sottoinsieme di `GIF`, `JPG`, `PNG`, `SVG` (opzionale — tutti accettati se non impostato) |
### `CtaConfig` — modello di vincolo per la call-to-action
| Proprietà | Descrizione |
| ------------- | ----------------------------------- |
| `optionality` | `required` · `allowed` · `disabled` |
| `alignment` | `left` · `center` · `right` |
## Cosa è definito dal retailer rispetto a cosa è fisso
| Configurazione | Il retailer imposta questo | Fissato dalla piattaforma |
| ------------------------------------------------------------- | :-----------------------------------------------------: | :----------------------------------: |
| Se un modulo è ignorabile | ✅ | |
| Limiti massimi di caratteri | ✅ | |
| Dimensioni minime dell'immagine e dimensione massima del file | ✅ | |
| Quali formati di immagine sono accettati | ✅ (sottoinsieme di quelli supportati dalla piattaforma) | |
| Se la CTA è obbligatoria, opzionale o disabilitata | ✅ | |
| Se la sovrapposizione è disponibile (Hero) | ✅ | |
| Quali opzioni di allineamento del testo sono offerte | ✅ | |
| Opzioni di rapporto colonne (Split Layout) | ✅ | |
| Numero minimo/massimo di immagini (Galleria immagini) | ✅ | |
| Numero minimo/massimo di prodotti (Griglia prodotti) | ✅ | |
| Tipi di modulo disponibili | | ✅ (7 tipi, fissi) |
| Tipo di media supportato (Hero) | | ✅ (solo immagine; video pianificato) |
| Tipi di link per le immagini | | ✅ (immagine · url · prodotto) |
| Profondità massima di annidamento per Split Layout | | ✅ (profondità 2) |
| Tipi di elementi figlio consentiti per Split Layout | | ✅ (solo Immagine e Testo) |
---
# 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/brand-pages/brand-page-retailer-integration-guide/module-capabilities.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.