> 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/partner/cs/partner-api-overview/campaign-field-definitions.md). # Definice polí kampaně ## Společná pole kampaní Tato sekce obsahuje stručné popisy a příklady, které vám pomohou porozumět společným polím kampaní napříč různými typy, jako jsou produktové reklamy, bannery a banner X. Každá položka obsahuje účel pole a reprezentativní příklad implementace pro vaši platformu. | Pole | Účel a příklad | | ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `name` | Doporučujeme uvést podrobnosti, jako je propagovaný produkt, časový rámec nebo strategie, například 'Cadbury Chocolate June Clearance', které pomohou kampaň snadno identifikovat. Název může mít délku až 255 znaků. | | `namespaceId` |

Unikátní identifikátor vašeho jmenného prostoru (namespace), který se nachází v základní URL. Například v exampleretailer.citrusad.comje namespaceId is exampleretailer.

Ujistěte se, že zdroj pro ID, které poskytujete jako jmenný prostor, existuje.

| | `approval.state` |

Stav schválení kampaně může používat pouze specifikované hodnoty výčtu (enum). Podporované stavy jsou APPROVAL\_STATE\_APPROVED, APPROVAL\_STATE\_REJECTED, APPROVAL\_STATE\_PENDING.

Všimněte si, žeAPPROVAL\_STATE\_UNSPECIFIED nelze použít.

| | `approval.rejectionReason` | Důvod, proč byla kampaň zamítnuta. Toto je povinné pole, pokud je stav `APPROVAL_STATE_REJECTED`. | | `campaignState` |

Aktivní stav kampaně udává, zda je kampaň aktivní, pozastavená, koncept nebo archivovaná. Například CAMPAIGN\_STATE\_ACTIVE, CAMPAIGN\_STATE\_DRAFT, CAMPAIGN\_STATE\_UNSPECIFIED.

Všimněte si, že CAMPAIGN\_STATE\_UNSPECIFIED nelze použít.

| | `teamId` |

je teamId je unikátní identifikátor týmu kampaně.

Ujistěte se, že zdroj pro dané ID týmu existuje a nemá nastavený příznak archivace. ID týmu šablony se navíc musí shodovat s ID týmu kampaně.

| | `startTime` |

Čas zahájení kampaně pomocí přesného časového razítka ISO-8601. Například 2024-09-01T12:00:00Z.

Tuto hodnotu vynechejte pro always on kampaně.

| | `endTime` |

Čas ukončení kampaně používá přesné časové razítko ISO-8601 a musí být nastaven, pokud je zadán startTime . Například 2024-09-30T23:59:59Z. Čas ukončení musí být po čase zahájení.

Tuto hodnotu vynechejte proalways on kampaně.

| | `walletId` |

Unikátní identifikátor peněženky, ze které má být kampaň účtována, například wallet\_123456789.

- If campaignType není 'Wildcard', měl by pro toto ID existovat objekt.
– ID týmu peněženky by se mělo shodovat s ID týmu kampaně.
– Kód měny peněženky se musí shodovat s kódem měny katalogu kampaně. Pokud si tím nejste jisti, ověřte si to u svého zákaznického integračního inženýra (CIE).

| | `placementId` |

Unikátní identifikátor umístění kampaně. Například placement\_987654321.

Ujistěte se, že zdroj pro dané ID umístění existuje a odpovídá správné kampani.

| | `catalogIds` |

Unikátní identifikátor katalogu/katalogů prodejce. Například \["329f1e08-d3ee-4e04-90c4-068b3ce6b856","6c29a96a-f55a-497f-b03a-2fed85dd7198" ].

Ujistěte se, že zdroj pro dané ID katalogu existuje a odpovídá správné kampani.

| | `advertisedProducts.
productsByKey` |

Kombinace kódů produktů a ID katalogů, které jsou v kampani propagovány. Pokud se kampaň zobrazuje ve dvou katalozích, uveďte dvě dvojice katalog-produkt.

Například \[{"catalogId": "14edbbc5-a7be-4c54-9f35-767b4ee29fd3","productCode": "ABC123"}].

| | `targeting.searchTerms` | Vyhledávací dotazy a jejich typy shody, na které bude kampaň cílit. Tyto informace uveďte pouze pro vyhledávací umístění. Například `{"matchType": "MATCH_TYPE_EXACT_MATCH","phrase": "string"}`}. | | `targeting.excludeFilters` |

Filtry k vyloučení během fáze cílení, což by měly být pouze filtry lokace nebo kategorie zarovnané s vaším filterClassId. Většina integrací může tyto hodnoty vynechat. Pokud používáte dvě třídy filtrů, určete jeden objekt na třídu filtru:

{"excludeFilters": \[ \
{ \
"catalogId": "76df36b4-45a2-46a5-9308-3dd14861d76e", \
"filter": "category:chocolate" \
}, \
{ \
"catalogId": "76df36b4-45a2-46a5-9308-3dd14861d76e", \
"filter": "location:florida" \
} \
] \
}

| | `targeting.includeFilters` |

Explicitní filtry, na které má kampaň cílit. U standardních integrací toto vynechejte. Toto pole vyplňte pouze na základě doporučení nebo při vytváření kampaní s Fixním umístěním.

{"includeFilters": \[ \
{ \
"catalogId": "76df36b4-45a2-46a5-9308-3dd14861d76e", \
"filter": "category:flavoured-milk" \
} \
] \
}

| | `targeting.negativeSearchTerms` | Negativní vyhledávací dotazy vylučují z vaší kampaně konkrétní slova nebo fráze, čímž brání zobrazování vašich reklam při nesouvisejícím vyhledávání. Tato strategie zpřesňuje vaše publikum, snižuje náklady a zvyšuje efektivitu kampaně. Například přidání `used` jako negativního výrazu pro reklamu na nové auto zabrání jejímu zobrazení uživatelům, kteří hledají ojetá auta. | | `targeting.crossSell` | Určuje cílení na umístění pro křížový prodej (cross-sell). | | `targeting.crossSell.
targetProductsByKey` |

Určuje explicitní dvojice katalog-produkt, na které se má cílit.

\[{"catalogId": "14edbbc5-a7be-4c54-9f35-767b4ee29fd3","productCode": "ABC123"}]

– Cílové katalogy produktů se musí shodovat s katalogy kampaně.
– Pro každou dvojici produkt-katalog musí existovat produkt.
– Cílové produkty nesmí být mezi propagovanými produkty.
– Cílové produkty a propagované produkty musí sdílet odpovídající kategorie.

| | `targeting.upSell.
targetProductsByKey` |

Určuje explicitní dvojice katalog-produkt, na které se má cílit.

\[{"catalogId": "14edbbc5-a7be-4c54-9f35-767b4ee29fd3","productCode": "ABC123"}]

| | `strategy.auction.maxBid` |

Maximální nabídka ceny za proklik (CPC) vaší kampaně. Například 2.99.

– Musí být platný BigDecimal.
– Musí být vyšší než minimální nabídka.

},
"strategy": {
"auction": {
"maxBid": "string",
"spendLimit": {
"daily": "string",
"total": "string"
}
},

| | `strategy.auction.spendLimit` |

Určuje maximální denní nebo celkové výdaje kampaně.

Vynechejte toto pro always on kampaň, která bude utrácet tak dlouho, dokud budou v peněžence kampaně prostředky. Například: "daily": "1000". Ujistěte se, že limit výdajů je hodnota BigDecimal větší než 0.

},
"strategy": {
"auction": {
"maxBid": "string",
"spendLimit": {
"daily": "string",
"total": "string"
}
},

| | `strategy.fixedTenancy.cost` |

Představuje celkové náklady na kampaň, slouží pouze pro účely reportování a neodečítá se z peněženky. Tuto hodnotu lze aktualizovat, pokud prodejce optimalizuje v rámci celého balíčku nebo objednávky (IO). Například: 1000.99.

"fixedTenancy": {
"cost": "1000.99",
"positions": \[
0
],
"catalogCosts": \[
{
"catalogId": "string",
"catalogCostPercentage": 0
}
]
}

| | `strategy.fixedTenancy.
catalogCostPercentage` |

Hodnota mezi 0 a 1 udávající část nákladů přidělenou jednotlivým katalogům. Pokud používáte více katalogů, přidělte část (např. 0,5). Pro jediný katalog použijte hodnotu 1.

"fixedTenancy": {
"cost": "string",
"positions": \[
0
],
"catalogCosts": \[
{
"catalogId": "string",
"catalogCostPercentage": 0.5
}
]
}

| | `strategy.fixedTenancy.
fixedCosts` |

Určuje dodatečné náklady na externí data, reklamní materiály nebo jiné služby související s kampaní. Tyto poplatky se uplatní po schválení kampaně a nelze je upravovat. Vynechejte tuto možnost, pokud se na vašeho inzerenta nevztahují dodatečné náklady.

{
"dataCost": "150",
"creativeCost": "200",
"otherCost": "400"
}

| | `fixedCosts.dataCost` | Náklady spojené s daty pro kampaň. Například 100,00 $. | | `fixedCosts.creativeCost` | Náklady spojené s výrobou reklamního materiálu pro kampaň. Například 200,00 $. | | `fixedCosts.otherCost` | Náklady spojené s ostatními výdaji na kampaň. Například 50,00 $. | | `customFields.customFieldId` |

Určuje unikátní customFieldId, které se konfiguruje. Vlastní pole nejsou při standardní integraci vyžadována a je pravděpodobné, že toto pole nepoužijete, pokud vám to nedoporučí váš Customer Integration Engineer (CIE).

{
"customFieldId": "3e31d3e4-bf15-411b-a18e-5553f08a6122",
"content": "PO-12345"
}

| | `customFields.content` |

Obsah pro vlastní pole v kampani.

{
"customFieldId": "3e31d3e4-bf15-411b-a18e-5553f08a6122",
"content": "PO-12345"
}

| | `customQuestions.customQuestionId` |

Určuje unikátní otázku vlastního cílení, která se konfiguruje. Vlastní otázky nejsou při standardní integraci vyžadovány a je pravděpodobné, že toto pole nepoužijete, pokud vám to nedoporučí váš Customer Integration Engineer (CIE).

{
"answers": \[
"preference:delivery",
"preference:online"
],"customQuestionId": "593a9860-5ce4-4dcc-b6c4-15cf6fb08426"
}

| | `customQuestions.answers` |

Určuje odpovědi vybrané inzerenty pro cílení na zákazníky. Musí odpovídat zákaznickým targetingData hodnotám.

{
"answers": \[
"preference:delivery",
"preference:online"
],"customQuestionId": "593a9860-5ce4-4dcc-b6c4-15cf6fb08426"
}

| ## Banner X pole kampaně | Pole | Účel a příklad | | ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `contentStandardId` |

Unikátní identifikátor pro obsahový standard. Obsahové standardy jsou pokyny a technické parametry, které určují, jak by se měl bannerový inzerát zobrazovat v rámci vyhrazeného prostoru na webových stránkách nebo digitální platformě.

Tento identifikátor je potřeba k ověření, že vytvořené kativum banneru X splňuje obsahové standardy prodejce.

| | `slotId` | Unikátní identifikátor pozice v konfiguraci, například 'homepage\_banner\_slot\_1'. Tento identifikátor zajišťuje, že banner používá správnou pozici podle definice prodejce, jako je samostatný dlaždice, dvojitá dlaždice nebo banner. | | `slotType` | Unikátní pozice v rámci obsahového standardu, kam bude obrázek umístěn. Zajišťuje, že obrázek splňuje předem definované požadavky na pozici a validace. Příklady zahrnují left\_ribbon, top\_banner nebo side\_panel. | | `headingText` | Text nadpisu banneru. | | `bannerText` | Text banneru je text zobrazený na vašem bannerovém inzerátu. | | `bannerTextColourHex` | Barva textu banneru v hexadecimálním formátu. | | `ctaFlag` | Příznak označující, zda má banner povolenou výzvu k akci. | | `ctaText` | Text výzvy k akci na banneru. Výzva k akci (CTA) je klikatelný text nebo tlačítko, které uživatele přiměje k akci, jako je nákup nebo návštěva jiné stránky. Například "Nakupovat". | | `ctaTextAccessibility` | Text výzvy k akci pro účely přístupnosti. | | `ctaLink` | URL pro odkaz výzvy k akci. | | `backgroundColourHex` | Barva primárního obrázku na pozadí banneru X v hexadecimálním formátu. | | `backgroundImageId` | Toto je unikátní identifikátor primárního obrázku na pozadí. | | `backgroundImagePosition` | Zarovnání nebo pozice primárního obrázku na pozadí v jeho kontejneru. | | `secondaryBackgroundImageId` | Unikátní identifikátor sekundárního obrázku na pozadí. | | `secondaryBackgroundImagePosition` | Zarovnání nebo pozice sekundárního obrázku na pozadí v jeho kontejneru. | | `heroImageId` | Unikátní identifikátor hlavního propagačního obrázku (hero image). Hlavní propagační obrázek je hlavní propagační vizuál, obvykle používaný k zobrazení vašeho produktu nebo loga. | | `heroImageAltText` | Alternativní text pro hlavní propagační obrázek, který pomáhá s přístupností. | | `heroMode` | Režim zobrazení nebo styl hlavní propagační sekce. | | `secondaryHeroImageId` | Unikátní identifikátor sekundárního hlavního propagačního obrázku. | | `secondaryHeroImageAltText` | Alternativní text pro sekundární hlavní propagační obrázek, který pomáhá s přístupností. | | `secondaryHeroMode` | Režim zobrazení nebo styl sekundární hlavní propagační sekce. | | `trackingTags` | Vyžadované pole objektů používané k určení poskytovatelů sledování a jejich přidružených značek pro monitorování a analýzu výkonu kampaně banneru X. | | `additionalFields` | Vyžadované pole objektů poskytující dodatečné možnosti konfigurace pro banner X. | ## Pole bannerové kampaně | Pole | Účel a příklad | | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `contentStandardId` |

Unikátní identifikátor pro obsahový standard. Obsahové standardy jsou pokyny a technické parametry, které určují, jak by se měl bannerový inzerát zobrazovat v rámci vyhrazeného prostoru na webových stránkách nebo digitální platformě.

Tento identifikátor je potřeba k ověření, že vytvořený reklamní materiál banneru splňuje obsahové standardy prodejce.

| | `slotId` | Unikátní identifikátor pozice v konfiguraci, například 'homepage\_banner\_slot\_1'. Tento identifikátor zajišťuje, že banner používá správnou pozici podle definice prodejce, jako je samostatný dlaždice, dvojitá dlaždice nebo banner. | | `artworkImageId` | Unikátní identifikátor pro obrázek grafiky nahraný pro banner. Toto ID (fileId) vracejí API Upload the creative assets. | | `link` | Toto je URL propojená s bannerovou pozicí, která uživatele po kliknutí na reklamní materiál přesměruje na cílovou stránku. Příklad: | | `altText` | Alternativní text popisující obrázek grafiky pro účely přístupnosti. Příklad: 'Propagační banner pro letní výprodej'. | | `text` | Zobrazovaný text na banneru. Zobrazovaný text pro pozici, který poskytuje dodatečné informace nebo sdělení. Příklad: 'Získejte slevu 20 % na svůj první nákup!' | | `trackingTags` | Seznam sledovacích značek od poskytovatele používaných k monitorování interakcí s pozicí. Příklad: \[ { provider: 'Google Analytics', tag: 'promo\_click' }, { provider: 'Adobe Analytics', tag: 'banner\_view' } ]. Tyto značky jsou součástí vašeho inzerátu pro ověření třetí stranou. | --- # 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/partner/cs/partner-api-overview/campaign-field-definitions.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.