> 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/sk/partner-api-overview/campaign-field-definitions.md). # Definície polí kampane ## Spoločné polia kampane Táto sekcia poskytuje stručné popisy a príklady, ktoré vám pomôžu pochopiť spoločné polia kampaní naprieč rôznymi typmi, ako sú produktové reklamy, bannery a banner X. Každý záznam obsahuje účel poľa a reprezentatívny príklad implementácie pre vašu platformu. | Pole | Účel a príklad | | ------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `name` | Odporúča sa uviesť podrobnosti, ako je propagovaný produkt, časový rámec alebo stratégia, napríklad 'Cadbury Chocolate June Clearance', čo pomôže kampaň ľahko identifikovať. Názov môže mať dĺžku až 255 znakov. | | `namespaceId` |

Jedinečný identifikátor vášho menného priestoru (namespace), ktorý sa nachádza v základnej URL adrese. Napríklad v exampleretailer.citrusad.com, namespaceId is exampleretailer.

Uistite sa, že zdroj pre ID, ktoré poskytujete ako namespace, existuje.

| | `approval.state` |

Stav schválenia kampane môže používať iba špecifikované enum hodnoty. Podporované stavy sú APPROVAL\_STATE\_APPROVED, APPROVAL\_STATE\_REJECTED, APPROVAL\_STATE\_PENDING.

Upozorňujeme, žeAPPROVAL\_STATE\_UNSPECIFIED nie je možné použiť.

| | `approval.rejectionReason` | Dôvod, prečo bola kampaň zamietnutá. Toto je povinné pole, ak je status `APPROVAL_STATE_REJECTED`. | | `campaignState` |

Aktívny stav kampane udáva, či je aktívna, pozastavená, koncept alebo archivovaná. Napríklad, CAMPAIGN\_STATE\_ACTIVE, CAMPAIGN\_STATE\_DRAFT, CAMPAIGN\_STATE\_UNSPECIFIED.

Upozorňujeme, že CAMPAIGN\_STATE\_UNSPECIFIED nie je možné použiť.

| | `teamId` |

, teamId je jedinečný identifikátor tímu kampane.

Uistite sa, že pre dané ID tímu zdroj existuje a nemá nastavenú príznak archivácie. Okrem toho sa ID tímu šablóny musí zhodovať s ID tímu kampane.

| | `startTime` |

Čas začiatku kampane pomocou presného časového pečiatky ISO-8601. Napríklad, 2024-09-01T12:00:00Z.

Túto hodnotu vynechajte pri always on kampaniach.

| | `endTime` |

Čas ukončenia kampane používa presnú časovú pečiatku ISO-8601 a musí byť nastavený, ak je špecifikované startTime Napríklad, 2024-09-30T23:59:59ZČas ukončenia musí byť po čase začiatku.

Túto hodnotu vynechajte prialways on kampaniach.

| | `walletId` |

Jedinečný identifikátor peňaženky, z ktorej sa bude kampaň účtovať, napríklad wallet\_123456789.

- If campaignType , ak nie je 'Wildcard', mal by existovať objekt pre toto ID.
– ID tímu peňaženky by sa malo zhodovať s ID tímu kampane.
– Kód meny peňaženky sa musí zhodovať s kódom meny katalógu kampane. Ak si tým nie ste istí, overte si to u svojho Customer Integration Engineera (CIE).

| | `placementId` |

Jedinečný identifikátor umiestnenia kampane. Napríklad, placement\_987654321.

Uistite sa, že zdroj pre dané ID umiestnenia existuje a zodpovedá správnej kampani.

| | `catalogIds` |

Jedinečný identifikátor katalógu (katalógov) predajcu. Napríklad, \["329f1e08-d3ee-4e04-90c4-068b3ce6b856","6c29a96a-f55a-497f-b03a-2fed85dd7198" ].

Uistite sa, že zdroj pre dané ID katalógu existuje a zodpovedá správnej kampani.

| | `advertisedProducts.
productsByKey` |

Kombinácie kódov produktov a ID katalógov, ktoré sa propagujú v kampani. Ak sa kampaň zobrazuje v dvoch katalógoch, uveďte dve dvojice katalóg-produkt.

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

| | `targeting.searchTerms` | Vyhľadávacie výrazy a ich typy zhody, na ktoré bude kampaň cieliť. Tieto informácie uveďte len pre umiestnenia vo vyhľadávaní. Napríklad, `{"matchType": "MATCH_TYPE_EXACT_MATCH","phrase": "string"}`}. | | `targeting.excludeFilters` |

Filtre na vylúčenie počas fázy cieľenia, čo by mali byť len filtre polohy alebo kategórie zosúladené s vašimi filterClassId. Väčšina integrácií môže tieto hodnoty vynechať. Ak používate dve triedy filtrov, zadajte jeden objekt pre každú triedu filtra:

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

| | `targeting.includeFilters` |

Explicitné filtre, na ktoré má kampaň cieliť. Pri štandardných integráciách toto pole vynechajte. Toto pole vyplňte len vtedy, ak je to odporúčané alebo pri vytváraní kampaní s fixným umiestnením.

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

| | `targeting.negativeSearchTerms` | Negatívne vyhľadávacie výrazy vylučujú z vašej kampane konkrétne slová alebo frázy, čím zabraňujú zobrazovaniu vašich reklám pri nesúvisiacich vyhľadávaniach. Táto stratégia spresňuje vaše publikum, znižuje náklady a zvyšuje efektivitu kampane. Napríklad pridanie `used` ako negatívneho výrazu pre reklamu na nové auto zabráni jej zobrazovaniu ľuďom, ktorí hľadajú ojazdené autá. | | `targeting.crossSell` | Špecifikuje cieľenie na umiestnenia krížového predaja (cross-sell). | | `targeting.crossSell.
targetProductsByKey` |

Špecifikuje explicitné dvojice katalóg-produkt, na ktoré sa má cieliť.

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

- Cieľové katalógy produktov sa musia zhodovať s katalógmi kampane.
- Pre každú dvojicu produkt-katalóg musí existovať produkt.
- Cieľové produkty nemôžu byť medzi propagovanými produktmi.
- Cieľové produkty a propagované produkty musia zdieľať zhodné kategórie.

| | `targeting.upSell.
targetProductsByKey` |

Špecifikuje explicitné dvojice katalóg-produkt, na ktoré sa má cieliť.

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

| | `strategy.auction.maxBid` |

Maximálna ponuka ceny za kliknutie (CPC) vaša kampaň. Napríklad 2.99.

- Musí byť platný BigDecimal.
- Musí byť vyššia ako minimálna ponuka.

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

| | `strategy.auction.spendLimit` |

Špecifikuje maximálne denné alebo celkové výdavky pre kampaň.

Vynechajte toto pre always on kampaň, ktorá bude pokračovať v míňaní, kým budú v peňaženke kampane prostriedky. Napríklad: "daily": "1000"." Uistite sa, že limit výdavkov je hodnota BigDecimal väčšia ako 0.

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

| | `strategy.fixedTenancy.cost` |

Predstavuje celkové náklady na kampaň, ktoré sa používajú len na účely podávania správ a neodpočítavajú sa z peňaženky. Túto hodnotu je možné aktualizovať, ak maloobchodník optimalizuje v rámci celého balíka alebo objednávky (IO). Napríklad: 1000.99.

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

| | `strategy.fixedTenancy.
catalogCostPercentage` |

Hodnota medzi 0 a 1 udávajúca časť nákladov pridelenú každému katalógu. Ak používate viacero katalógov, prideľte časť (napr. 0.5). Pre jediný katalóg použite hodnotu 1.

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

| | `strategy.fixedTenancy.
fixedCosts` |

Špecifikuje dodatočné náklady na externé dáta, tvorbu reklamného materiálu alebo iné služby súvisiace s kampaňou. Tieto poplatky sa uplatnia po schválení kampane a nie je možné ich upravovať. Vynechajte to, pokiaľ sa na vášho inzerenta nevzťahujú dodatočné náklady.

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

| | `fixedCosts.dataCost` | Náklady spojené s dátami pre kampaň. Napríklad $100.00. | | `fixedCosts.creativeCost` | Náklady spojené s výrobou reklamného materiálu pre kampaň. Napríklad $200.00. | | `fixedCosts.otherCost` | Náklady spojené s ostatnými výdavkami na kampaň. Napríklad $50.00. | | `customFields.customFieldId` |

Špecifikuje unikátne customFieldId, ktoré sa konfiguruje. Vlastné polia nie sú v štandardnej integrácii vyžadované a je pravdepodobné, že toto pole nepoužijete, pokiaľ vám to neodporučí váš Customer Integration Engineer (CIE).

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

| | `customFields.content` |

Obsah pre vlastné pole v kampani.

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

| | `customQuestions.customQuestionId` |

Špecifikuje unikátnu otázku pre vlastné cieľenie, ktorá sa konfiguruje. Vlastné otázky nie sú v štandardnej integrácii vyžadované a je pravdepodobné, že toto pole nepoužijete, pokiaľ vám to neodporučí váš Customer Integration Engineer (CIE).

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

| | `customQuestions.answers` |

Špecifikuje odpovede vybrané inzerentmi pre cieľenie na zákazníkov. Musia byť v súlade so zákazníckymi targetingData hodnotami.

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

| ## Banner X polia kampane | Pole | Účel a príklad | | ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `contentStandardId` |

Unikátny identifikátor pre obsahový štandard. Obsahové štandardy sú pravidlá a technické parametre, ktoré určujú, ako sa má bannerová reklama zobrazovať v rámci vyhradeného priestoru na webovej lokalite alebo digitálnej platforme.

Tento identifikátor je potrebný na overenie, či vytvorený podklad pre banner X spĺňa obsahové štandardy predajcu.

| | `slotId` | Unikátny identifikátor pre pozíciu v konfigurácii, ako napríklad 'homepage\_banner\_slot\_1'. Tento identifikátor zaisťuje, že banner použije správnu pozíciu definovanú predajcom, ako napríklad single tile, double tile alebo banner. | | `slotType` | Unikátna pozícia v rámci obsahového štandardu, kde bude obrázok umiestnený. Zaisťuje, že obrázok spĺňa vopred definované požiadavky a validácie pozície. Príklady zahŕňajú left\_ribbon, top\_banner alebo side\_panel. | | `headingText` | Text nadpisu pre banner. | | `bannerText` | Text bannera je text zobrazený na vašej bannerovej reklame. | | `bannerTextColourHex` | Farba textu bannera vo formáte hex. | | `ctaFlag` | Prieznaku označujúci, či má banner povolenú výzvu na akciu (call-to-action). | | `ctaText` | Text výzvy na akciu na banneri. Výzva na akciu (CTA) je klikateľný text alebo tlačidlo, ktoré nabáda používateľov k akcii, ako je nákup alebo návšteva inej stránky. Napríklad "Nakupovať teraz". | | `ctaTextAccessibility` | Text výzvy na akciu pre účely prístupnosti. | | `ctaLink` | URL adresa pre odkaz výzvy na akciu. | | `backgroundColourHex` | Farba primárneho obrázka pozadia pre banner X v hexadecimálnom formáte. | | `backgroundImageId` | Toto je unikátny identifikátor primárneho obrázka pozadia. | | `backgroundImagePosition` | Zarovnanie alebo pozícia primárneho obrázka pozadia v jeho kontajneri. | | `secondaryBackgroundImageId` | Unikátny identifikátor pre sekundárny obrázok pozadia. | | `secondaryBackgroundImagePosition` | Zarovnanie alebo pozícia sekundárneho obrázka pozadia v jeho kontajneri. | | `heroImageId` | Unikátny identifikátor pre hlavný reklamný obrázok (hero image). Hero image je hlavný propagačný obrázok, ktorý sa zvyčajne používa na zobrazenie vášho produktu alebo loga. | | `heroImageAltText` | Alternatívny text pre hlavný reklamný obrázok, ktorý pomáha s prístupnosťou. | | `heroMode` | Režim zobrazenia alebo štýl hlavnej sekcie (hero section). | | `secondaryHeroImageId` | Unikátny identifikátor pre sekundárny hlavný reklamný obrázok. | | `secondaryHeroImageAltText` | Alternatívny text pre sekundárny hlavný reklamný obrázok, ktorý pomáha s prístupnosťou. | | `secondaryHeroMode` | Režim zobrazenia alebo štýl sekundárnej hlavnej sekcie. | | `trackingTags` | Vyžadované pole objektov používané na špecifikáciu poskytovateľov sledovania a ich priradených značiek na monitorovanie a analýzu výkonnosti kampane s bannerom X. | | `additionalFields` | Vyžadované pole objektov poskytujúce dodatočné možnosti konfigurácie pre banner X. | ## Polia bannerovej kampane | Pole | Účel a príklad | | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `contentStandardId` |

Unikátny identifikátor pre obsahový štandard. Obsahové štandardy sú pravidlá a technické parametre, ktoré určujú, ako sa má bannerová reklama zobrazovať v rámci vyhradeného priestoru na webovej lokalite alebo digitálnej platforme.

Tento identifikátor je potrebný na overenie, či vytvorený podklad pre banner spĺňa obsahové štandardy predajcu.

| | `slotId` | Unikátny identifikátor pre pozíciu v konfigurácii, ako napríklad 'homepage\_banner\_slot\_1'. Tento identifikátor zaisťuje, že banner použije správnu pozíciu definovanú predajcom, ako napríklad single tile, double tile alebo banner. | | `artworkImageId` | Unikátny identifikátor pre obrázok grafiky nahraný pre banner. Toto ID (fileId) je vrátené rozhraním API Upload the creative assets. | | `link` | Toto je URL adresa prepojená s bannerovou pozíciou, ktorá po kliknutí na reklamu presmeruje používateľov na cieľovú stránku. Príklad: | | `altText` | Alternatívny text popisujúci obrázok grafiky pre účely prístupnosti. Príklad: 'Propagačný banner pre letný výpredaj'. | | `text` | Zobrazený text na banneri. Zobrazený text pre pozíciu, ktorý poskytuje dodatočné informácie alebo správu. Príklad: 'Získajte zľavu 20 % na prvý nákup!' | | `trackingTags` | Zoznam sledovacích značiek od poskytovateľa, používaných na monitorovanie interakcií s pozíciou. Príklad: \[ { provider: 'Google Analytics', tag: 'promo\_click' }, { provider: 'Adobe Analytics', tag: 'banner\_view' } ]. Tieto značky sú súčasťou vašej reklamy pre účely overenia tretími stranami. | --- # 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/sk/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.