> 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/references/banner-x-reference-1.md).
# Referenční příručka banneru X
Níže jsou uvedeny vlastnosti, které jsou možné v běžném požadavku, jak je popsáno v části [Žádost o reklamy](/retail-media-interface/integration/cs/generating-ads/banner-x-responsive/requesting-banner-x-ads.md) pro váš požadavek a odpověď, pokud obdržíte reklamu.
## Požadované položky
| Řetězec | Popis | Povinné/volitelné |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- |
| `BannerSlotIds` | Pole JSON složené ze slotIds bannerových pozic, které jsou požadovány. | Povinné |
| `catalogId` | Identifikátor vašeho produktového katalogu pro váš web. | Povinné |
| `contentStandardId` | Standardní identifikátor obsahu pro váš web. | Povinné |
| `customerId` | Unikátní identifikátor zákazníka, kterému se zobrazují reklamy. | Volitelné |
| `filterMode` | Volitelný způsob definování struktury vašeho požadavku. Viz [Filtrování generování reklam](/retail-media-interface/integration/cs/data-api/api-overview/ad-generation-filtering-1.md) pro více informací. | Volitelné, preferované |
| `maxNumberOfAds` | Maximální počet jednotlivých bannerových pozic, které chcete vrátit. | Povinné |
| `options` | Volitelný způsob definování struktury vašeho požadavku. Další informace naleznete v části Filtrování generování reklam.
Toto je také objekt, ve kterém můžete požadovat informace o inzerentovi za účelem dodržení místní reklamní legislativy, jako je evropský Zákon o digitálních službách .
| Volitelné, preferované |
| `placement` | Unikátní umístění, pro které žádáte o reklamy. | Povinné |
| `productFilters` | Jakékoli produktové filtry relevantní pro váš požadavek. Například filtr kategorie, lokace nebo velikosti. | Vyžadováno pro umístění v kategoriích |
| `searchTerm` | Hledaný výraz zadaný vaším zákazníkem na vašem webu. | Vyžadováno pro umístění ve vyhledávání |
| `sessionId` | Unikátní identifikátor relace zákazníka. Používá se pro atribuci v standardních integracích. Prohlédněte si [Možnosti integračního postupu](/retail-media-interface/integration/cs/data-api/api-overview/integration-workflow-options-1.md)pro více informací. | Vyžadováno ve standardních integracích |
| `slotId` | Obsahuje jakýkoli požadovaný SlotId v kontextu. Může jich být jeden nebo více. | Povinné |
| `dtmCookieId` | Soubory cookie vytvořené a uložené webovou stránkou, používané ke sledování chování uživatelů na stejné doméně. | Volitelné |
| `audience` | Určuje konkrétní segmenty publika, do kterých nakupující patří. Relevantní pouze při použití [Cílení na publikum – Možnost 3](/retail-media-interface/integration/cs/data-api/audience-targeting-new/integration-option-3-sync-audiences-only.md) | Volitelné |
## Vrácené položky
| Řetězec | Popis | Příklad hodnoty |
| -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ads.backgroundColour` | Barva pozadí banneru – pouze hodnoty HEX. | `6e6c6c` |
| `ads.backgroundImage` | Odkaz na obrázek pozadí banneru. | `[]\() |
| `ads.backgroundImagePosition` | Definuje typ pozice obrázku na pozadí. Pokud hodnota chybí, budete muset použít výchozí `leftaligned` . | leftaligned
rightaligned
fill
repeating
|
| `ads.bannerText` | Text zobrazený v banneru. Může obsahovat značky HTML | `Double Fudge Ice Cream` |
| `ads.bannerTextColour` | Barva textu banneru – pouze hodnoty HEX. Citrus neodesílá `#`. | `1dc711` |
| `ads.citrusAdId` | Unikátní ID reklamy.
Toto je unikátní pro každý požadavek odeslaný na Epsilon Retail Media a nelze ukládat do vyrovnávací paměti.
| `shotgun_wIpZraEXcIu0daC5YMQewPil2S83NzE0MTA3` |
| `ads.citrusCampaignName` | Název kampaně reklamy. | `Epsilon-Example-Category-Banner-X-Ad-ae536b0d5c3ded28ea624ab4285facd6` |
| `ads.citrusContentStandardId` | Standardní ID obsahu související s pozicí. | `8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c` |
| `ads.citrusExpiry` | Exspirace reklamy. Toto je nejzazší okamžik, kdy lze kliknutí nahlásit na Epsilon Retail Media | `2021-06-01T23:48:16.573967987Z` |
| `ads.citrusSlotId` | ID konkrétní pozice pro banner, o který jste požádali. | `Category_Top` |
| `ads.contentStandardId` | Standardní ID obsahu související s pozicí. Duplikát `citrusContentStandardId` | `8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c` |
| `ads.ctaFlag` | Určuje, zda se zobrazí CTA. | true
false
|
| `ads.ctaLink` | URL přesměrovaná z CTA (je jako linkUrl pro bannery). Podává se pouze v případě, že ctaFlag je `true` | ` |
| `ads.ctaText` | Text uvnitř CTA. | `Shop now` |
| `ads.ctaTextAccessibility` | Text přístupnosti CTA pro uživatele čteček obrazovky. | `for Double Fudge Ice Cream` |
| `ads.gtins` | Pole až 20 kódů produktů vybraných z inzerovaných produktů kampaně.
Prodejci mohou tento seznam použít k automatizaci výpisů produktů při kliknutí na banner nebo k automatizaci určitých funkcí vykreslování (odznaky, tvorba cen, sekundární kontrola skladových zásob).
| `[
"7714107",
"7163379",
"7733636",
"7733657",
"7733628"
],` |
| `ads.headingText` | Text nadpisu pro uživatele čteček obrazovky. | `Banner Advertisement for Fudge Double Ice Cream with a product image and shop now button` |
| `ads.heroImageAltText` | Alternativní text pro hlavní obrázek pro vzácné případy, kdy se nezobrazí. | `Image of double fudge iced cream` |
| `ads.heroImage` | Odkaz na hlavní obrázek banneru. | `[]\() |
| `ads.position` | Pozice banneru v Epsilon Retail Media odpovědi. Tuto pozici byste měli respektovat v případě, že jsou využity kampaně typu Fixní umístění. | 1 |
| `ads.secondaryBackgroundImage` | Odkaz na sekundární obrázek pozadí. | `[]\() |
| `ads.secondaryBackgroundImagePosition` | Tímto se definuje typ pozice sekundárního obrázku na pozadí. | leftaligned
rightaligned
|
| `ads.secondaryHeroImageAltText` | Alternativní text pro sekundární hlavního obrázek (hero image) pro vzácné případy, kdy se nezobrazí. | `Image of [brand] logo` |
| `ads.secondaryHeroImage` | Odkaz na sekundární hlavní obrázek (hero image). | `[]\() |
| `ads.secondaryHeroMode` | Tímto se definuje režim zobrazení sekundárního hlavního obrázku (hero image). Pokud není zadána žádná hodnota, budete muset použít výchozí `block` . | block
landscape
|
| `ads.slotId` | ID pozice požadovaného banneru. Při požadování více bannerů je lze použít k odkazu na požadovaná ID. | `Category_Top` |
| `ads.tags` | Toto pole vrací jakékoli tagy třetích stran zadané inzerentem v jeho kampani. V současné době to banner x nepodporuje, i když je odpověď API naformátována. | `{}` |
| `ads.sellerId` | Unikátní Id prodejce. Vyplní se pouze v případě, že je na týmu nastaven sellerId. sellerIds se obvykle používají při zapojování prodejců na tržiště (marketplace). | `73nns-32sxr-32ss` Vlastní podle integrace |
| `ads.metadata` | Objekt obsahující informace o inzerentovi požadované k tomu, aby inzerenti dodrželi místní legislativu o reklamě, jako je např. Zákon o digitálních službách v Evropě.
advertiser se přebírá z Násobu společnosti v týmu dodavatele.
onBehalfOf se přebírá z Financovatele reklamy v týmu dodavatele.
| `"metadata": {
"advertiserInfo": {
"advertiser": "Bob's advertising agency",
"onBehalfOf": "Brand company inc"
}
...` |
| `ads.adm` | Objekt obsahující podrobnosti o videoreklamě včetně 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` | Podrobnosti o doprovodných produktech. | “companionProducts”: \[
"Banana14-simfk15"
"Oranges5-qgxeb6",
"Incaberries20-ppscn21"
|
| `metadata.warnings` | Objekt obsahující varovné informace o požadavku na reklamu. V současné době pouze varuje, pokud je překročen maximální počet segmentů. | `"metadata": {
"warnings": [
"Audience Segment IDs exceeded the limit of {maxSegmentIds} and were truncated"
]
}` |
{% hint style="info" %}
Pokud existuje pole, které není nakonfigurováno jako součást kampaně reklamy, nebude se zobrazovat. Tj. pokud inzerent nenakonfiguroval `heroImage`, Epsilon Retail Media nebude zobrazovat `heroImage` vlastnost.
{% 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/cs/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.