> 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/brand-pages/brand-page-retailer-integration-guide/module-capabilities.md).
# Modulfunktionen
Dieses Dokument beschreibt jeden verfügbaren Modultyp, seine Felder, Einschränkungen und Konfigurationsoptionen. Verwenden Sie es als Händler-Referenz dafür, was jedes Modul unterstützt und was Marken beim Erstellen von Brand-Page-Inhalten konfigurieren können.
***
## Modultypen auf einen Blick
| Modul | Zweck |
| -------------- | ---------------------------------------------------------------------------- |
| Hero-Banner | Medien in voller Breite mit Überschrift, Untertitel und CTA |
| Bild | Einzelseite mit optionaler Bildunterschrift, Alt-Text und Link |
| Text | Überschrift, Tagline, Haupttext oder benutzerdefinierter mehrzeiliger Text |
| Split-Layout | Zweispaltiges oder gestapeltes Layout, das Bild- und/oder Textmodule enthält |
| Bildergalerie | Raster von Bildern mit optionalem Abschnittstitel, Beschreibung und CTA |
| Filtermenü | Navigationsleiste mit beschrifteten Filterelementen |
| Produkt-Raster | Kuratierte Produkt-Raster mit optionaler Filterung und CTA |
## Gemeinsame Felder (alle Module)
Jedes Modul teilt die folgenden vom System verwalteten Felder. Marken legen diese nicht direkt fest.
| Feld | Beschreibung |
| --------------------------- | ------------------------------------------------------------------------------------------- |
| `id` | Automatisch generierter eindeutiger Bezeichner |
| `brandPageModuleTemplateId` | Verknüpft Inhalte mit der Modulvorlage des Händlers |
| `order` | Anzeigeposition auf der Seite (verwaltet über Drag-and-Drop) |
| `optionality` | Ob das gesamte Modul erforderlich ist oder übersprungen werden kann (vom Händler definiert) |
## 1. Hero-Banner
Ein Banner in voller Breite, das ein Hintergrundbild, ein Overlay, einen Überschriftentext und einen Call-to-Action kombiniert. Dies ist normalerweise das erste Modul auf der Brand Page.
### Medien
| Feld | Erforderlich? | Einschränkungen |
| -------- | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| Bild | Erforderlich | Formate: `GIF`, `JPG`, `PNG`, `SVG` · Mindestabmessungen: vom Händler definiert · Max. Dateigröße: vom Händler definiert |
| Alt-Text | Erforderlich oder Optional (vom Händler definiert) | Beschreibender Text für Barrierefreiheit |
{% hint style="info" %}
Video-Unterstützung ist geplant, aber noch nicht verfügbar. Derzeit werden nur Bilder akzeptiert.
{% endhint %}
### Overlay
Der Händler definiert, ob für dieses Modul ein Overlay verfügbar ist:
| Einstellung | Verhalten |
| -------------------- | ------------------------------------------------------------------------ |
| `disabled` | Kein Overlay — das Bild wird ohne Farbschicht angezeigt |
| `optional` (erlaubt) | Marke kann wählen, ob das Overlay aktiviert oder deaktiviert werden soll |
| `required` | Overlay wird immer angezeigt; die Marke kann es nicht ausschalten |
Wenn das Overlay aktiviert ist, wählt die Marke den Hintergrundstil aus. Der Händler steuert, welche Stile angeboten werden:
| Stil | Beschreibung |
| ---------- | --------------------------------- |
| `gradient` | Stufenloser Verlauf vom Bild |
| `solid` | Flacher Farbblock hinter dem Text |
Beide Optionen können gleichzeitig zur Verfügung gestellt werden.
### Textinhalt
| Feld | Erforderlich? | Einschränkungen |
| --------------------- | --------------------------------------------------------------- | ---------------------------------------------------------------- |
| Überschrift | Erforderlich | Max. Zeichen: vom Händler definiert |
| Unterüberschrift | Optional | Max. Zeichen: vom Händler definiert |
| CTA-Schaltflächentext | Erforderlich, Optional oder Deaktiviert (vom Händler definiert) | Max. Zeichen: vom Händler definiert |
| CTA-Link-URL | Erforderlich, Optional oder Deaktiviert (vom Händler definiert) | Max. Zeichen: vom Händler definiert · Muss eine gültige URL sein |
{% hint style="info" %}
Der CTA-Text und der CTA-Link werden zusammen konfiguriert. Wenn CTA deaktiviert ist, wird keines der Felder angezeigt. Sie können keinen CTA-Link ohne eine CTA-Schaltfläche haben oder umgekehrt.
{% endhint %}
### Textausrichtung
Der Händler definiert, welche Ausrichtungsoptionen verfügbar sind. Mögliche Werte: `left`, `center`, `right`. Die Marke trifft eine Auswahl aus dem angebotenen Set.
## 2. Bild
Ein einzelnes Bild mit optionaler Bildunterschrift, Alt-Text und einem Linkziel.
### Bild-Upload
| Feld | Erforderlich? | Einschränkungen |
| -------- | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| Bild | Erforderlich | Formate: `GIF`, `JPG`, `PNG`, `SVG` · Mindestabmessungen: vom Händler definiert · Max. Dateigröße: vom Händler definiert |
| Alt-Text | Erforderlich oder Optional (vom Händler definiert) | Beschreibender Text für Barrierefreiheit |
### Bildunterschrift
| Feld | Erforderlich? | Einschränkungen |
| ---------------- | ------------- | ------------------------------------------------ |
| Bildunterschrift | Optional | Max. Zeichen: Händler-definiert · Einzelne Zeile |
{% hint style="info" %}
Die Verfügbarkeit von Bildunterschriften ist händlerdefiniert. Wenn der Händler Bildunterschriften nicht aktiviert hat, wird das Feld nicht angezeigt.
{% endhint %}
### Link
Jedes Bild kann optional zu einem Ziel verlinken. Die Marke wählt einen von drei Linktypen aus:
| Linktyp | Beschreibung |
| --------- | ------------------------------------------------------------------------------------- |
| `image` | Kein Link — das Bild ist nicht interaktiv |
| `url` | Navigiert nach Auswahl zu einer benutzerdefinierten URL |
| `product` | Navigiert zu einer bestimmten Produktdetailseite (ausgewählt über die Produktauswahl) |
### Zusätzliche Textzeilen
Einige Bild-Module unterstützen zusätzliche beschriftete Textzeilen neben dem Bild (z. B. ein Titel oder eine Beschreibung, die unter oder über dem Bild dargestellt werden). Verfügbarkeit, Beschriftungen, Schriftgrößen und ob jede Zeile erforderlich oder optional ist, sind alle händlerdefiniert.
## 3. Text
Ein flexibles Textmodul, das einzeilige und mehrzeilige Varianten unterstützt.
### Varianten
Der Händler legt fest, welche Variante das Modul verwendet:
| Variante | Beschreibung |
| ---------- | --------------------------------------------------------------------------- |
| `headline` | Eine einzelne hervorgehobene Textzeile — groß, fett |
| `tagline` | Eine einzelne ergänzende Zeile — kleiner als die Überschrift |
| `body` | Ein einzelner Fließtextblock — wird als Textbereich dargestellt |
| `lines` | Mehrere benannte Textzeilen, jede mit eigener Schriftgröße und Optionalität |
### Felder — einzeilige Varianten (`headline`, `tagline`, `body`)
| Feld | Erforderlich? | Einschränkungen |
| ---- | ------------- | ----------------------------------------------------------- |
| Text | Erforderlich | Max. Zeichen: Händler-definiert (gilt für das gesamte Feld) |
### Felder — mehrzeilige Variante (`lines`)
Jede Zeile wird vom Händler unabhängig definiert:
| Feld | Erforderlich? | Einschränkungen |
| ---------- | -------------------------------------------------------- | ------------------------------------------------------------- |
| Zeilentext | Erforderlich oder Optional (pro Zeile, händlerdefiniert) | Max. Zeichen: Händler-definiert (gilt pro Zeile) |
| Zeilen-URL | Optional | Nur verfügbar in Zeilen, in denen `isHyperlink` aktiviert ist |
### CTA
| Feld | Erforderlich? | Einschränkungen |
| --------------------- | --------------------------------------------------------------- | -------------------------- |
| CTA-Schaltflächentext | Erforderlich, Optional oder Deaktiviert (vom Händler definiert) | — |
| CTA-Link-URL | Erforderlich, Optional oder Deaktiviert (vom Händler definiert) | Muss eine gültige URL sein |
{% hint style="info" %}
Die CTA-Optionalität gilt für Text und URL zusammen. Wenn deaktiviert, wird keines der Felder angezeigt.
{% endhint %}
### Ausrichtung
Händlerdefiniert. Mögliche Werte: `left`, `center`, `right`. Gilt für den gesamten Text im Modul.
### Maximale Breite
Der Händler legt eine `maxWidth` -Einschränkung fest, die begrenzt, wie breit der Textblock dargestellt werden kann (zum Beispiel `600px` or `80%`). Dies ist eine Darstellungseinschränkung, keine Inhaltseinschränkung.
## 4. Getiltes Layout
Ein Layout-Container, der zwei oder mehr untergeordnete Module enthält, die in Spalten oder Zeilen angeordnet sind. Die untergeordneten Elemente sind **Bild**- und/oder **Text**-Module. Verschachtelung wird bis zu einer Tiefe von 2 unterstützt, aber Sie können keine geteilten Layouts auf der Hauptebene verschachteln.
### Layout-Optionen
| Layout | Optionen |
| --------- | --------------------------------------------------------------------------------------------------- |
| `columns` | Nebeneinander. Verhältnis: `50:50`, `33:67`, or `67:33` (händlerdefiniert, welche angeboten werden) |
| `rows` | Vertikal gestapelt |
### Abstand
Der Abstand zwischen untergeordneten Elementen ist händlerdefiniert und stammt aus der Abstandsskala des Händler-Styleguides.
### Untergeordnete Elemente
| Eigenschaft | Wert |
| ----------------------------------- | ----------------------------------------------------------------------------------------------------- |
| Zulässige untergeordnete Typen | `Image`, `Text` |
| Anzahl der untergeordneten Elemente | Händlerdefiniert (`numChildren`) |
| Verschachtelung | Ein untergeordnetes geteiltes Layout kann selbst `Image` und `Text` -Module enthalten (max. Tiefe: 2) |
{% hint style="info" %}
Wichtig
Sie können kein Hero-Banner, keine Bildergalerie, kein Filtermenü und kein Produktraster innerhalb eines geteilten Layouts platzieren.
{% endhint %}
## 5. Bildergalerie
Ein Raster aus Bildern mit einer optionalen Bereichsüberschrift, Beschreibung und einem untersten CTA.
### Bereichsüberschrift
| Feld | Erforderlich? | Einschränkungen |
| -------------------- | --------------------------------------------------------------- | --------------- |
| Bereichstitel | Erforderlich, Optional oder Deaktiviert (vom Händler definiert) | — |
| Bereichsbeschreibung | Erforderlich, Optional oder Deaktiviert (vom Händler definiert) | — |
### Galerie-Layout
Händlerdefiniert pro Breakpoint:
| Eigenschaft | Beschreibung |
| ----------- | --------------------------------------------------------------------------------- |
| Spalten | Anzahl der Spalten auf Mobilgeräten, Tablets und Desktops (vom Händler definiert) |
| Bildhöhe | Pixel- oder prozentuale Höhe pro Breakpoint (vom Händler definiert) |
| Abstand | Abstand zwischen Bildern (aus dem Styleguide des Händlers) |
### Bilder
| Eigenschaft | Einschränkungen |
| -------------------------- | ------------------------------------------------------------------------ |
| Mindestanzahl an Bildern | Vom Händler definiert (es müssen mindestens so viele hinzugefügt werden) |
| Maximale Anzahl an Bildern | Vom Händler definiert (kann diese Anzahl nicht überschreiten) |
| Formate | `GIF`, `JPG`, `PNG`, `SVG` |
| Mindestabmessungen | Vom Händler definiert |
| Maximale Dateigröße | Vom Händler definiert |
| Alt-Text | Erforderlich oder Optional pro Bild (vom Händler definiert) |
| Bildunterschrift pro Bild | Optional, max. Zeichen: vom Händler definiert |
| Link pro Bild | `image` (keine) · `url` · `product` — genau wie Image-Modul |
### Zusätzliche Textzeilen pro Bild
Genauso wie beim Image-Modul — vom Händler definierte Labels, Schriftgrößen und Optionalität pro Zeile.
### CTA (unten in der Galerie)
| Feld | Erforderlich? | Einschränkungen |
| --------------------- | --------------------------------------------------------------- | -------------------------- |
| CTA-Schaltflächentext | Erforderlich, Optional oder Deaktiviert (vom Händler definiert) | — |
| CTA-Link-URL | Erforderlich, Optional oder Deaktiviert (vom Händler definiert) | Muss eine gültige URL sein |
| CTA-Ausrichtung | `left`, `center`, `right` (vom Händler definiert) | — |
## 6. Filter-Menü
Eine horizontale Navigationsleiste mit beschrifteten Filter-Elementen. Verwenden Sie diese, damit Käufer Inhalte auf der Seite filtern können (z. B. nach Kategorie oder Unterkategorie).
### Elemente
| Eigenschaft | Einschränkungen |
| ---------------------------- | ------------------------------------------------------------------------------------------ |
| Mindestanzahl an Elementen | Vom Händler definiert (es müssen mindestens so viele hinzugefügt werden) |
| Maximale Anzahl an Elementen | Vom Händler definiert (kann diese Anzahl nicht überschreiten) |
| Label-Text | Max. Zeichen: vom Händler definiert |
| Filterwert | Interner Wert, der von der Filterlogik verwendet wird. Max. Zeichen: vom Händler definiert |
### Ausrichtung
Händlerdefiniert. Mögliche Werte: `left`, `center`.
Filter-Elemente können neu angeordnet werden. Das Label ist das, was der Käufer sieht; der Wert ist das, was als Filter angewendet wird. Es muss sich nicht um dieselbe Zeichenkette handeln.
## 7. Produktraster
Ein kuratiertes Raster von Produkten, die von der Marke ausgewählt wurden, mit optionaler Abschnittsüberschrift, Filterung und CTA.
### Bereichsüberschrift
| Feld | Erforderlich? | Einschränkungen |
| -------------------- | --------------------------------------------------------------- | --------------- |
| Bereichstitel | Erforderlich, Optional oder Deaktiviert (vom Händler definiert) | — |
| Bereichsbeschreibung | Erforderlich, Optional oder Deaktiviert (vom Händler definiert) | — |
### Produkte
| Eigenschaft | Einschränkungen |
| ---------------------------- | ------------------------------------------------------------ |
| Mindestanzahl an Produkten | Vom Händler definiert |
| Maximale Anzahl an Produkten | Vom Händler definiert |
| Produktquelle | Ausgewählt über die Produktauswahl aus dem Katalog der Marke |
| Anzeigereihenfolge | Drag-and-Drop innerhalb des Moduls |
### Produktkarten-CTA
Der Händler entscheidet, ob eine CTA-Schaltfläche auf jeder Produktkarte erscheint:
| Einstellung | Verhalten |
| ----------- | -------------------------------------------------------------------------------------------------- |
| Deaktiviert | Keine CTA-Schaltfläche auf Produktkarten |
| Aktiviert | Eine CTA-Schaltfläche wird angezeigt; der Händler legt den Beschriftungstext der Schaltfläche fest |
{% hint style="info" %}
Wenn aktiviert, teilen sich alle Produktkarten im Raster dasselbe CTA-Label (vom Händler festgelegt, nicht von der Marke).
{% endhint %}
### Filterung
Der Händler kann optional die On-Page-Filterung für das Produktraster aktivieren:
| Einstellung | Beschreibung |
| ------------------- | --------------------------------------------------------------------------------------------------- |
| `enabled` | Käufer können das Produktraster filtern |
| `showActiveFilter` | Hebt den aktuell aktiven Filter hervor |
| `showResultCount` | Zeigt an, wie viele Ergebnisse mit dem aktiven Filter übereinstimmen |
| `emptyStateMessage` | Benutzerdefinierte Nachricht, die angezeigt wird, wenn keine Produkte mit dem Filter übereinstimmen |
{% hint style="info" %}
Die Filterung funktioniert in Kombination mit einem Filter-Menü-Modul. Die für Produkte festgelegten Filterwerte müssen mit den Filterelementwerten im Filter-Menü übereinstimmen.
{% endhint %}
### CTA (unten im Raster)
| Feld | Erforderlich? | Einschränkungen |
| --------------------- | --------------------------------------------------------------- | -------------------------- |
| CTA-Schaltflächentext | Erforderlich, Optional oder Deaktiviert (vom Händler definiert) | — |
| CTA-Link-URL | Erforderlich, Optional oder Deaktiviert (vom Händler definiert) | Muss eine gültige URL sein |
| CTA-Ausrichtung | `left`, `center`, `right` (vom Händler definiert) | — |
## Einschränkungsreferenz
### `ContentLimit` — Textfeld-Einschränkungsmodell
| Wert | Bedeutung |
| ----------------------- | --------------------------------------------------------------------------------------------------- |
| `disabled` | Feld ist in dieser Vorlage nicht verfügbar |
| `allowed` + `maxChars` | Feld ist optional; falls ausgefüllt, darf es folgende Anzahl nicht überschreiten `maxChars` Zeichen |
| `required` + `maxChars` | Feld muss ausgefüllt werden; darf nicht überschreiten `maxChars` Zeichen |
### `ImageConstraints` — Einschränkungsmodell für den Bild-Upload
| Eigenschaft | Beschreibung |
| ----------------- | ---------------------------------------------------------------------------------------------------- |
| `altOptionality` | `required` or `allowed` |
| `minWidth` | Minimale Bildbreite in Pixeln (optional) |
| `minHeight` | Minimale Bildhöhe in Pixeln (optional) |
| `maxFileSizeMb` | Maximale Dateigröße in Megabyte (optional) |
| `acceptedFormats` | Teilmenge von `GIF`, `JPG`, `PNG`, `SVG` (optional — falls nicht festgelegt, werden alle akzeptiert) |
### `CtaConfig` — Einschränkungsmodell für Call-to-Action
| Eigenschaft | Beschreibung |
| ------------- | ----------------------------------- |
| `optionality` | `required` · `allowed` · `disabled` |
| `alignment` | `left` · `center` · `right` |
## Was vom Händler definiert vs. fest vorgegeben ist
| Konfiguration | Händler legt dies fest | Von der Plattform vorgegeben |
| ----------------------------------------------------- | :-----------------------------------------------: | :--------------------------: |
| Ob ein Modul übersprungen werden kann | ✅ | |
| Maximale Zeichenbegrenzungen | ✅ | |
| Mindestabmessungen für Bilder und maximale Dateigröße | ✅ | |
| Welche Bildformate akzeptiert werden | ✅ (Teilmenge der von der Plattform unterstützten) | |
| Ob CTA erforderlich, optional oder deaktiviert ist | ✅ | |
| Ob Overlay verfügbar ist (Hero) | ✅ | |
| Welche Textausrichtungsoptionen angeboten werden | ✅ | |
| Spaltenverhältnis-Optionen (Split Layout) | ✅ | |
| Min/Max-Anzahl an Bildern (Bildergalerie) | ✅ | |
| Min/Max-Anzahl an Produkten (Produkt-Grid) | ✅ | |
| Verfügbare Modultypen | | ✅ (7 Typen, fest) |
| Unterstützter Medientyp (Hero) | | ✅ (nur Bild; Video geplant) |
| Link-Typen für Bilder | | ✅ (image · url · product) |
| Maximale Verschachtelungstiefe für Split Layout | | ✅ (Tiefe 2) |
| Zulässige untergeordnete Typen für Split Layout | | ✅ (nur Bild und Text) |
---
# 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/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.