> 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/cs/brand-pages/brand-page-retailer-integration-guide/module-capabilities.md).
# Schopnosti modulu
Tento dokument popisuje každý dostupný typ modulu, jeho pole, omezení a možnosti konfigurace. Použijte jej jako referenci určenou pro maloobchodníky, která popisuje, co jednotlivé moduly podporují a co mohou značky konfigurovat při vytváření obsahu stránky značky (Brand Page).
***
## Přehled typů modulů
| Modul | Účel |
| ------------------- | --------------------------------------------------------------------------- |
| Hero banner | Médiá na celou šířku s nadpisem, podnadpisem a tlačítkem výzvy k akci (CTA) |
| Obrázek | Samostatný obrázek s volitelným popiskem, alternativním textem a odkazem |
| Text | Nadpis, podnadpis, hlavní text nebo vlastní víceřádkový text |
| Rozdělené rozvržení | Dvousloupcové nebo skládané rozvržení obsahující moduly Obrázek a/nebo Text |
| Galerie obrázků | Mřížka obrázků s volitelným názvem sekce, popisem a výzvou k akci (CTA) |
| Nabídka filtrů | Navigační lišta označených položek filtrů |
| Mřížka produktů | Kurátorovaná mřížka produktů s volitelným filtrováním a výzvou k akci (CTA) |
## Společná pole (všechny moduly)
Všechny moduly sdílejí následující systémem spravovaná pole. Značky je nenastavují přímo.
| Pole | Popis |
| --------------------------- | -------------------------------------------------------------------------- |
| `id` | Automaticky vygenerovaný unikátní identifikátor |
| `brandPageModuleTemplateId` | Propojuje obsah se šablonou modulu maloobchodníka |
| `order` | Pozice zobrazení na stránce (spravována přetažením drag-and-drop) |
| `optionality` | Zda je celý modul povinný, nebo jej lze přeskočit (definuje maloobchodník) |
## 1. Hero banner
Banner na celou šířku, který kombinuje obrázek na pozadí, překryvnou vrstvu, text nadpisu a výzvu k akci (CTA). Jedná se obvykle o první modul na stránce značky (Brand Page).
### Média
| Pole | Povinné? | Omezení |
| ----------------- | ----------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| Obrázek | Povinné | Formáty: `GIF`, `JPG`, `PNG`, `SVG` · Min. rozměry: definuje maloobchodník · Max. velikost souboru: definuje maloobchodník |
| Alternativní text | Povinné nebo Volitelné (definuje maloobchodník) | Popisný text pro přístupnost |
{% hint style="info" %}
Podpora videa je plánována, ale dosud není k dispozici. V současné době je akceptován pouze obrázek.
{% endhint %}
### Překryvná vrstva
Maloobchodník definuje, zda je pro tento modul k dispozici překryvná vrstva:
| Nastavení | Chování |
| --------------------- | --------------------------------------------------------------------- |
| `disabled` | Bez překryvné vrstvy — obrázek se zobrazí bez jakékoli barevné vrstvy |
| `optional` (povoleno) | Značka si může zvolit, zda překryvnou vrstvu povolí nebo zakáže |
| `required` | Překryvná vrstva se zobrazuje vždy; značka ji nemůže vypnout |
Při povolené překryvné vrstvě značka vybírá styl pozadí. Maloobchodník určuje, které styly jsou nabízeny:
| Styl | Popis |
| ---------- | ------------------------------------- |
| `gradient` | Plynulý přechod do ztracena z obrázku |
| `solid` | Jednobarevný blok za textem |
Obě možnosti mohou být zpřístupněny současně.
### Textový obsah
| Pole | Povinné? | Omezení |
| ----------------- | ---------------------------------------------------------- | -------------------------------------------------------------- |
| Nadpis | Povinné | Max. počet znaků: definuje maloobchodník |
| Podnadpis | Volitelné | Max. počet znaků: definuje maloobchodník |
| Text tlačítka CTA | Povinné, Volitelné, nebo Zakázáno (definuje maloobchodník) | Max. počet znaků: definuje maloobchodník |
| URL odkazu CTA | Povinné, Volitelné, nebo Zakázáno (definuje maloobchodník) | Max. počet znaků: definuje maloobchodník · Musí být platná URL |
{% hint style="info" %}
Text CTA a odkaz CTA se konfigurují společně. Pokud je CTA zakázána, nezobrazí se ani jedno pole. Nemůžete mít odkaz CTA bez tlačítka CTA a naopak.
{% endhint %}
### Zarovnání textu
Maloobchodník definuje, které možnosti zarovnání jsou k dispozici. Možné hodnoty: `left`, `center`, `right`. Značka vybírá ze nabízené sady.
## 2. Obrázek
Samostatný obrázek s volitelným popiskem, alternativním textem a cílem odkazu.
### Nahrání obrázku
| Pole | Povinné? | Omezení |
| ----------------- | ----------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| Obrázek | Povinné | Formáty: `GIF`, `JPG`, `PNG`, `SVG` · Min. rozměry: definuje maloobchodník · Max. velikost souboru: definuje maloobchodník |
| Alternativní text | Povinné nebo Volitelné (definuje maloobchodník) | Popisný text pro přístupnost |
### Popisek
| Pole | Povinné? | Omezení |
| ------- | --------- | ------------------------------------------------- |
| Popisek | Volitelné | Max. počet znaků: definuje prodejce · Jeden řádek |
{% hint style="info" %}
Dostupnost popisku definuje prodejce. Pokud prodejce popisky nepovolil, pole se nezobrazí.
{% endhint %}
### Odkaz
Každý obrázek může volitelně odkazovat na cíl. Značka vybírá jeden ze tří typů odkazu:
| Typ odkazu | Popis |
| ---------- | ------------------------------------------------------------------------------------- |
| `image` | Bez odkazu — obrázek není interaktivní |
| `url` | Při výběru přesměruje na vlastní URL |
| `product` | Přesměruje na konkrétní stránku s detailem produktu (vybranou pomocí výběru produktů) |
### Další textové řádky
Některé moduly Obrázek podporují vedle obrázku další textové řádky s označením (například název nebo popis vyobrazený pod nebo nad obrázkem). Dostupnost, označení, velikosti písma a to, zda je každý řádek povinný nebo volitelný, definuje prodejce.
## 3. Text
Flexibilní textový modul, který podporuje jednořádkové a víceřádkové varianty.
### Varianty
Prodejce definuje, kterou variantu modul používá:
| Varianta | Popis |
| ---------- | ---------------------------------------------------------------------------------- |
| `headline` | Jeden výrazný textový řádek — velký, tučný |
| `tagline` | Jeden doplňkový řádek — menší než hlavatý text |
| `body` | Jeden blok hlavního textu — zobrazí se jako textová oblast |
| `lines` | Více pojmenovaných textových řádků, každý s vlastní velikostí písma a volitelností |
### Pole — jednořádkové varianty (`headline`, `tagline`, `body`)
| Pole | Povinné? | Omezení |
| ---- | -------- | --------------------------------------------------------- |
| Text | Povinné | Max. počet znaků: definuje prodejce (platí pro celé pole) |
### Pole — víceřádková varianta (`lines`)
Každý řádek definuje prodejce samostatně:
| Pole | Povinné? | Omezení |
| ---------- | ---------------------------------------------------- | ---------------------------------------------------------------- |
| Text řádku | Povinné nebo Volitelné (na řádek, definuje prodejce) | Max. počet znaků: definuje prodejce (platí pro jednotlivé řádky) |
| URL řádku | Volitelné | K dispozici pouze na řádcích, kde `isHyperlink` je povoleno |
### CTA
| Pole | Povinné? | Omezení |
| ----------------- | ---------------------------------------------------------- | ------------------- |
| Text tlačítka CTA | Povinné, Volitelné, nebo Zakázáno (definuje maloobchodník) | — |
| URL odkazu CTA | Povinné, Volitelné, nebo Zakázáno (definuje maloobchodník) | Musí být platná URL |
{% hint style="info" %}
Volitelnost CTA platí pro text i URL společně. Pokud je zakázána, nezobrazí se ani jedno pole.
{% endhint %}
### Zarovnání
Definuje prodejce. Možné hodnoty: `left`, `center`, `right`. Platí pro veškerý text v modulu.
### Maximální šířka
Prodejce nastavuje `maxWidth` omezení, které limituje, jak široký se blok textu může zobrazit (například `600px` or `80%`). Jedná se o omezení zobrazení, nikoli obsahu.
## 4. Rozdělené rozvržení
Kontejner rozvržení, který obsahuje dva nebo více podřízených modulů uspořádaných do sloupců nebo řádků. Podřízenými moduly jsou moduly **Obrázek** a/nebo **Text**. Vnoření je podporováno až do hloubky 2, ale Rozdělená rozvržení nelze vnořovat v kořenové úrovni.
### Možnosti rozvržení
| Rozvržení | Možnosti |
| --------- | ---------------------------------------------------------------------------------------- |
| `columns` | Vedle sebe. Poměr: `50:50`, `33:67`, or `67:33` (které jsou nabízeny, definuje prodejce) |
| `rows` | Skládané svisle |
### Odsazení
Mezeru mezi podřízenými prvky definuje prodejce a vychází ze stupnice odsazení v grafickém manuálu prodejce.
### Podřízené prvky
| Vlastnost | Hodnota |
| ------------------------------- | ------------------------------------------------------------------------------------------- |
| Povolené typy podřízených prvků | `Image`, `Text` |
| Počet podřízených prvků | Definuje prodejce (`numChildren`) |
| Vnoření | Podřízené Rozdělené rozvržení může samo obsahovat `Image` a `Text` moduly (max. hloubka: 2) |
{% hint style="info" %}
Důležité
Do Rozděleného rozvržení nelze umístit Hero Banner, Galerii obrázků, Nabídku filtrů ani Mřížku produktů.
{% endhint %}
## 5. Galerie obrázků
Mřížka obrázků s volitelným záhlavím sekce, popisem a spodním CTA.
### Záhlaví sekce
| Pole | Povinné? | Omezení |
| ----------- | ---------------------------------------------------------- | ------- |
| Název sekce | Povinné, Volitelné, nebo Zakázáno (definuje maloobchodník) | — |
| Popis sekce | Povinné, Volitelné, nebo Zakázáno (definuje maloobchodník) | — |
### Rozvržení galerie
Definuje prodejce pro každý breakpoint:
| Vlastnost | Popis |
| ------------- | ---------------------------------------------------------------------------- |
| Sloupce | Počet sloupců na mobilu, tabletu a počítači (definováno prodejcem) |
| Výška obrázku | Výška v pixelech nebo procentech pro každý breakpoint (definována prodejcem) |
| Mezera | Rozstupy mezi obrázky (podle stylu prodejce) |
### Obrázky
| Vlastnost | Omezení |
| -------------------------- | ------------------------------------------------------------------ |
| Minimální počet obrázků | Definováno prodejcem (musí být přidáno alespoň tolik) |
| Maximální počet obrázků | Definováno prodejcem (nesmí překročit tento počet) |
| Formáty | `GIF`, `JPG`, `PNG`, `SVG` |
| Minimální rozměry | Definováno prodejcem |
| Maximální velikost souboru | Definováno prodejcem |
| Alternativní text | Vyžadováno nebo volitelné pro každý obrázek (definováno prodejcem) |
| Popisek pro každý obrázek | Volitelné, max. počet znaků: definováno prodejcem |
| Odkaz pro každý obrázek | `image` (žádný) · `url` · `product` — stejné jako modul Obrázek |
### Další řádky textu pro každý obrázek
Stejné jako u modulu Obrázek — štítky, velikosti písma a volitelnost pro každý řádek jsou definovány prodejcem.
### Výzva k akci (spodní část galerie)
| Pole | Povinné? | Omezení |
| ---------------------- | ---------------------------------------------------------- | ------------------- |
| Text tlačítka CTA | Povinné, Volitelné, nebo Zakázáno (definuje maloobchodník) | — |
| URL odkazu CTA | Povinné, Volitelné, nebo Zakázáno (definuje maloobchodník) | Musí být platná URL |
| Zarovnání výzvy k akci | `left`, `center`, `right` (definováno prodejcem) | — |
## 6. Nabídka filtrů
Horizontální navigační lišta s označenými položkami filtrů. Slouží k tomu, aby kupující mohli filtrovat obsah na stránce (například podle kategorie nebo podkategorie).
### Položky
| Vlastnost | Omezení |
| ----------------------- | ------------------------------------------------------------------------------------ |
| Minimální počet položek | Definováno prodejcem (musí být přidáno alespoň tolik) |
| Maximální počet položek | Definováno prodejcem (nesmí překročit tento počet) |
| Text štítku | Max. počet znaků: definuje maloobchodník |
| Hodnota filtru | Interní hodnota používaná logikou filtrování. Max. počet znaků: definováno prodejcem |
### Zarovnání
Definuje prodejce. Možné hodnoty: `left`, `center`.
Položky filtru lze přeuspořádat. Štítek je to, co vidí kupující; hodnota je to, co se použije jako filtr. Nemusí se jednat o stejný řetězec.
## 7. Mřížka produktů
Vybraná mřížka produktů zvolených značkou s volitelným záhlavím sekce, filtrováním a výzvou k akci.
### Záhlaví sekce
| Pole | Povinné? | Omezení |
| ----------- | ---------------------------------------------------------- | ------- |
| Název sekce | Povinné, Volitelné, nebo Zakázáno (definuje maloobchodník) | — |
| Popis sekce | Povinné, Volitelné, nebo Zakázáno (definuje maloobchodník) | — |
### Produkty
| Vlastnost | Omezení |
| ------------------------ | ------------------------------------------------ |
| Minimální počet produktů | Definováno prodejcem |
| Maximální počet produktů | Definováno prodejcem |
| Zdroj produktů | Vybráno pomocí výběru produktů z katalogu značky |
| Pořadí zobrazení | Přetažením v rámci modulu |
### Výzva k akci na kartě produktu
Prodejce rozhodne, zda se na každé kartě produktu zobrazí tlačítko výzvy k akci:
| Nastavení | Chování |
| ------------ | ------------------------------------------------------------------------- |
| Deaktivováno | Žádné tlačítko výzvy k akci na kartách produktů |
| Aktivováno | Zobrazí se tlačítko výzvy k akci; text štítku tlačítka nastavuje prodejce |
{% hint style="info" %}
Pokud je aktivováno, všechny karty produktů v mřížce sdílejí stejný štítek výzvy k akci (nastavený prodejcem, nikoli značkou).
{% endhint %}
### Filtrování
Prodejce může volitelně povolit filtrování na stránce pro mřížku produktů:
| Nastavení | Popis |
| ------------------- | ------------------------------------------------------------------------- |
| `enabled` | Kupující mohou filtrovat mřížku produktů |
| `showActiveFilter` | Zvýrazní aktuálně aktivní filtr |
| `showResultCount` | Zobrazí, kolik výsledků odpovídá aktivnímu filtru |
| `emptyStateMessage` | Vlastní zpráva zobrazená v případě, že filtru neodpovídají žádné produkty |
{% hint style="info" %}
Filtrování funguje ve spojení s modulem Nabídka filtrů. Hodnoty filtrů nastavené u produktů musí odpovídat hodnotám položek filtrů v Nabídce filtrů.
{% endhint %}
### Výzva k akci (spodní část mřížky)
| Pole | Povinné? | Omezení |
| ---------------------- | ---------------------------------------------------------- | ------------------- |
| Text tlačítka CTA | Povinné, Volitelné, nebo Zakázáno (definuje maloobchodník) | — |
| URL odkazu CTA | Povinné, Volitelné, nebo Zakázáno (definuje maloobchodník) | Musí být platná URL |
| Zarovnání výzvy k akci | `left`, `center`, `right` (definováno prodejcem) | — |
## Odkaz na omezení
### `ContentLimit` — model omezení textového pole
| Hodnota | Význam |
| ----------------------- | ---------------------------------------------------------------------- |
| `disabled` | Pole není v této šabloně k dispozici |
| `allowed` + `maxChars` | Pole je volitelné; pokud je vyplněno, nesmí překročit `maxChars` znaky |
| `required` + `maxChars` | Pole musí být vyplněno; nesmí překročit `maxChars` znaky |
### `ImageConstraints` — model omezení nahrávání obrázku
| Vlastnost | Popis |
| ----------------- | ------------------------------------------------------------------------------------------------ |
| `altOptionality` | `required` or `allowed` |
| `minWidth` | Minimální šířka obrázku v pixelech (volitelné) |
| `minHeight` | Minimální výška obrázku v pixelech (volitelné) |
| `maxFileSizeMb` | Maximální velikost souboru v megabajtech (volitelné) |
| `acceptedFormats` | Podmnožina `GIF`, `JPG`, `PNG`, `SVG` (volitelné — pokud není nastaveno, jsou přijímány všechny) |
### `CtaConfig` — model omezení výzvy k akci
| Vlastnost | Popis |
| ------------- | ----------------------------------- |
| `optionality` | `required` · `allowed` · `disabled` |
| `alignment` | `left` · `center` · `right` |
## Co je definováno prodejcem vs. fixní
| Konfigurace | Nastavuje prodejce | Fixováno platformou |
| ------------------------------------------------------ | :-------------------------------------: | :---------------------------------: |
| Zda lze modul přeskočit | ✅ | |
| Maximální limity počtu znaků | ✅ | |
| Minimální rozměry obrázku a maximální velikost souboru | ✅ | |
| Které formáty obrázků jsou podporovány | ✅ (podmnožina podporovaných platformou) | |
| Zda je výzva k akci povinná, volitelná nebo zakázaná | ✅ | |
| Zda je k dispozici překrytí (Hero) | ✅ | |
| Které možnosti zarovnání textu jsou nabízeny | ✅ | |
| Možnosti poměru sloupců (Split Layout) | ✅ | |
| Min./max. počet obrázků (Image Gallery) | ✅ | |
| Min./max. počet produktů (Product Grid) | ✅ | |
| Dostupné typy modulů | | ✅ (7 typů, fixní) |
| Podporovaný typ média (Hero) | | ✅ (pouze obrázek; video se plánuje) |
| Typy odkazů pro obrázky | | ✅ (image · url · product) |
| Maximální hloubka zanoření rozvržení Split Layout | | ✅ (hloubka 2) |
| Povolené dceřiné typy rozvržení Split Layout | | ✅ (pouze Image a 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/cs/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.