> 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/hu/partner-api-overview/campaign-field-definitions.md). # Kampánymezők meghatározásai ## Közös kampánymezők Ez a szakasz rövid leírásokat és példákat ad, hogy segítsen megérteni a közös kampánymezőket a különböző típusoknál, mint például a termékhirdetések, a bannerek és a X banner. Mindegyik bejegyzés tartalmazza a mező célját és egy reprezentatív megvalósítási példát a platformjához. | Mező | Cél és példa | | ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `name` | Javasoljuk, hogy adjon meg olyan részleteket, mint a promovált termék, az időkeret vagy a stratégia, például 'Cadbury Chocolate June Clearance', hogy segítsen a kampány könnyű azonosításában. A név legfeljebb 255 karakter hosszú lehet. | | `namespaceId` |

A névtér egyedi azonosítója, amely az alap URL-ben található. Például a exampleretailer.citrusad.comA(z) namespaceId is exampleretailer.

Győződjön meg arról, hogy az erőforrás létezik a névtérként megadott ID-hoz.

| | `approval.state` |

A kampány jóváhagyási állapota csak a megadott enum értékeket használhatja. A támogatott állapotok: APPROVAL\_STATE\_APPROVED, APPROVAL\_STATE\_REJECTED, APPROVAL\_STATE\_PENDING.

Vegye figyelembe, hogy a(z)APPROVAL\_STATE\_UNSPECIFIED nem használható.

| | `approval.rejectionReason` | A kampány elutasításának oka. Ez egy kötelező mező, ha a status értéke `APPROVAL_STATE_REJECTED`. | | `campaignState` |

A kampány aktív állapota jelzi, hogy az aktív, szüneteltetett, piszkozat vagy archivált. Például: CAMPAIGN\_STATE\_ACTIVE, CAMPAIGN\_STATE\_DRAFT, CAMPAIGN\_STATE\_UNSPECIFIED.

Vegye figyelembe, hogy a(z) CAMPAIGN\_STATE\_UNSPECIFIED nem használható.

| | `teamId` |

A(z) teamId a kampány csapatának egyedi azonosítója.

Győződjön meg arról, hogy az erőforrás létezik a megadott csapat-ID-hoz, és nincs beállítva az archivált jelzője. Ezenkívül a sablon csapat-ID-jának meg kell egyeznie a kampány csapat-ID-jával.

| | `startTime` |

A kampány kezdési ideje pontos ISO-8601 időbélyeg használatával. Például: 2024-09-01T12:00:00Z.

Hagyja ki ezt az értéket a(z) always on kampányoknál.

| | `endTime` |

A kampány befejezési ideje pontos ISO-8601 időbélyeget használ, és be kell állítani, ha a(z) startTime meg van adva. Például: 2024-09-30T23:59:59ZA befejezési időnek a kezdési idő után kell lennie.

Hagyja ki ezt az értéket a(z)always on kampányoknál.

| | `walletId` |

A kampányért terhelendő pénztárca egyedi azonosítója, például: wallet\_123456789.

- If campaignType értéke nem 'Wildcard', léteznie kell egy objektumnak az ID-hoz.
A pénztárca csapat-ID-jának meg kell egyeznie a kampány csapat-ID-jával.
A pénztárca pénznemkódjának meg kell egyeznie a kampánykatalógus pénznemkódjával. Ha nem biztos ebben, érdeklődjön az ügyfélintegrációs mérnökénél (CIE).

| | `placementId` |

A kampány elhelyezésének egyedi azonosítója. Például: placement\_987654321.

Győződjön meg arról, hogy az erőforrás létezik a megadott elhelyezés-ID-hoz, és az a megfelelő kampánynak felel meg.

| | `catalogIds` |

A kiskereskedő katalógusá(nak/inak) egyedi azonosítója. Például: \["329f1e08-d3ee-4e04-90c4-068b3ce6b856","6c29a96a-f55a-497f-b03a-2fed85dd7198" ].

Győződjön meg arról, hogy az erőforrás létezik a megadott katalógus-ID-hoz, és az a megfelelő kampánynak felel meg.

| | `advertisedProducts.
productsByKey` |

A kampányban hirdetett termékkódok és katalógus-ID-k kombinációi. Ha egy kampány két katalógusban jelenik meg, adjon meg két katalógus-termék párosítást.

Például: \[{"catalogId": "14edbbc5-a7be-4c54-9f35-767b4ee29fd3","productCode": "ABC123"}].

| | `targeting.searchTerms` | A keresési kifejezések és azok egyezési típusai, amelyeket a kampány célozni fog. Ezt az információt csak keresési elhelyezéseknél adja meg. Például: `{"matchType": "MATCH_TYPE_EXACT_MATCH","phrase": "string"}`}. | | `targeting.excludeFilters` |

Szűrők, amelyeket ki kell zárni a célzási szakaszban, amelyek csak a következőkkel összhangban lévő hely- vagy kategóriaszűrők lehetnek: filterClassIdA legtöbb integráció elhagyhatja ezeket az értékeket. Ha két szűrőosztályt használ, adja meg szűrőosztályonként egy objektumot:

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

| | `targeting.includeFilters` |

Kifejezett szűrők, amelyeket a kampány megcéloz. Hagyja ki ezt a standard integrációknál. Csak akkor töltse ki ezt a mezőt, ha ezt tanácsolják, vagy ha Fix elhelyezés kampányokat hoz létre.

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

| | `targeting.negativeSearchTerms` | A negatív keresési kifejezések kizárnak bizonyos szavakat vagy kifejezéseket a kampányból, megakadályozva, hogy a hirdetései nem kapcsolódó keresésekben jelenjenek meg. Ez a stratégia finomítja a célközönséget, csökkenti a költségeket és növeli a kampány hatékonyságát. Például a(z) `used` negatív kifejezésként való hozzáadása egy új autó hirdetéséhez elkerüli annak megjelenítését a használt autókat keresők számára. | | `targeting.crossSell` | Meghatározza a célzást a keresztértékesítési elhelyezéseken. | | `targeting.crossSell.
targetProductsByKey` |

Meghatározza a célzandó kifejezett katalógus-termék párosításokat.

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

A cél termékkatalógusoknak meg kell egyezniük a kampánykatalógusokkal.
Minden termék-katalógus párhoz léteznie kell egy terméknek.
A céltermékek nem lehetnek a hirdetett termékek között.
A céltermékeknek és a hirdetett termékeknek egyező kategóriákkal kell rendelkezniük.

| | `targeting.upSell.
targetProductsByKey` |

Meghatározza a célzandó kifejezett katalógus-termék párosításokat.

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

| | `strategy.auction.maxBid` |

A kampány maximális kattintásonkénti költség (CPC) ajánlata. Például: 2.99.

Érvényes BigDecimalnak kell lennie.
Többnek kell lennie a minimális ajánlatnál.

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

| | `strategy.auction.spendLimit` |

Meghatározza a kampány maximális napi vagy teljes költését.

Hagyja ki ezt egy always on kampánynál, amely mindaddig költ, amíg van fedezet a kampány pénztárcájában. Például: "daily": "1000"." Győződjön meg arról, hogy a költési limit egy 0-nál nagyobb BigDecimal érték.

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

| | `strategy.fixedTenancy.cost` |

A kampány teljes költségét képviseli, amely csak jelentési célokat szolgál, és nem kerül levonásra a pénztárcából. Ez az érték frissíthető, ha a kiskereskedő egy teljes csomagon vagy beszúrási sorrenden (IO) belül optimalizál. Például: 1000.99.

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

| | `strategy.fixedTenancy.
catalogCostPercentage` |

Egy 0 és 1 közötti érték, amely az egyes katalógusokhoz rendelt költség arányát jelzi. Több katalógus használata esetén adjon meg egy arányt (pl. 0.5). Egyetlen katalógus esetén használja az 1 értéket.

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

| | `strategy.fixedTenancy.
fixedCosts` |

Meghatározza a külső adatokkal, kreatív munkával vagy a kampányhoz kapcsolódó egyéb szolgáltatásokkal kapcsolatos további költségeket. Ezek a díjak a kampány jóváhagyásakor lépnek életbe, és nem módosíthatók. Hagyja ki ezt, kivéve, ha a hirdetőre további költségek vonatkoznak.

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

| | `fixedCosts.dataCost` | A kampány adatival kapcsolatos költség. Például $100.00. | | `fixedCosts.creativeCost` | A kampányhoz kapcsolódó kreatív gyártás költsége. Például $200.00. | | `fixedCosts.otherCost` | A kampány egyéb kiadásaival kapcsolatos költség. Például $50.00. | | `customFields.customFieldId` |

Meghatározza a konfigurálandó egyedi customFieldId azonosítót. Az egyéni mezők nem kötelezőek a standard integrációban, és valószínűleg nem kell használnia ezt a mezőt, kivéve, ha az ügyfélintegrációs mérnöke (CIE) ezt javasolja.

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

| | `customFields.content` |

A kampány egyéni mezőjének tartalma.

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

| | `customQuestions.customQuestionId` |

Meghatározza a konfigurálandó egyedi ügyfél-célzási kérdést. Az egyéni kérdések nem kötelezőek a standard integrációban, és valószínűleg nem kell használnia ezt a mezőt, kivéve, ha az ügyfélintegrációs mérnöke (CIE) ezt javasolja.

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

| | `customQuestions.answers` |

Meghatározza a hirdetők által az ügyfélcélzáshoz kiválasztott válaszokat. Illeszkednie kell a vásárlói targetingData értékekhez.

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

| ## Banner X kampánymeztők | Mező | Cél és példa | | ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `contentStandardId` |

Egyedi azonosító a tartalmi szabványhoz. A tartalmi szabványok olyan irányelvek és műszaki paraméterek, amelyek meghatározzák, hogyan kell megjeleníteni egy bannerhirdetést egy webhely vagy digitális platform kijelölt helyén.

Ez az azonosító szükséges annak ellenőrzéséhez, hogy a létrehozott banner X eszköz megfelel-e a kereskedő tartalmi szabványainak.

| | `slotId` | A konfigurációban lévő slot egyedi azonosítója, például 'homepage\_banner\_slot\_1'. Ez az azonosító biztosítja, hogy a banner a kereskedő által meghatározott megfelelő slotot használja, például single tile, double tile vagy banner. | | `slotType` | A tartalmi szabványon belüli egyedi slot, ahová a kép elhelyezésre kerül. Biztosítja, hogy a kép megfeleljen az előre meghatározott slot-követelményeknek és ellenőrzéseknek. Példák: left\_ribbon, top\_banner vagy side\_panel. | | `headingText` | A banner címsorának szövege. | | `bannerText` | A bannerszöveg a bannerhirdetésen megjelenő szöveg. | | `bannerTextColourHex` | A bannerszöveg színe hexadecimális formátumban. | | `ctaFlag` | Egy jelző, amely azt mutatja, hogy a banner rendelkezik-e engedélyezett cselekvésre ösztönzéssel (call-to-action). | | `ctaText` | A cselekvésre ösztönző szöveg a banneren. A cselekvésre ösztönzés (CTA) egy kattintható szöveg vagy gomb, amely cselekvésre ösztönzi a felhasználókat, például vásárlásra vagy egy másik oldal felkeresésére. Például: "Vásároljon most". | | `ctaTextAccessibility` | A cselekvésre ösztönző szöveg akadálymentesítési célokra. | | `ctaLink` | A cselekvésre ösztönző hivatkozás URL-címe. | | `backgroundColourHex` | A banner X elsődleges háttérképének színe hexadecimális formátumban. | | `backgroundImageId` | Ez az elsődleges háttérkép egyedi azonosítója. | | `backgroundImagePosition` | Az elsődleges háttérkép igazítása vagy pozíciója a tárolóján belül. | | `secondaryBackgroundImageId` | A másodlagos háttérkép egyedi azonosítója. | | `secondaryBackgroundImagePosition` | A másodlagos háttérkép igazítása vagy pozíciója a tárolóján belül. | | `heroImageId` | A hero kép egyedi azonosítója. A hero kép a fő promóciós kép, amelyet általában a termék vagy a logó megjelenítésére használnak. | | `heroImageAltText` | A hero kép alternatív szövege, amely segíti az akadálymentesítést. | | `heroMode` | A hero rész megjelenítési módja vagy stílusa. | | `secondaryHeroImageId` | A másodlagos hero kép egyedi azonosítója. | | `secondaryHeroImageAltText` | A másodlagos hero kép alternatív szövege, amely segíti az akadálymentesítést. | | `secondaryHeroMode` | A másodlagos hero rész megjelenítési módja vagy stílusa. | | `trackingTags` | Egy kötelező objektumtömb, amely a mérésfigyelő szolgáltatók és a hozzájuk kapcsolódó tagek megadására szolgál a banner X kampány teljesítményének nyomon követéséhez és elemzéséhez. | | `additionalFields` | Egy kötelező objektumtömb, amely további konfigurációs lehetőségeket biztosít a banner X számára. | ## Bannerkampány-mezők | Mező | Cél és példa | | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `contentStandardId` |

Egyedi azonosító a tartalmi szabványhoz. A tartalmi szabványok olyan irányelvek és műszaki paraméterek, amelyek meghatározzák, hogyan kell megjeleníteni egy bannerhirdetést egy webhely vagy digitális platform kijelölt helyén.

Ez az azonosító szükséges annak ellenőrzéséhez, hogy a létrehozott bannereszköz megfelel-e a kereskedő tartalmi szabványainak.

| | `slotId` | A konfigurációban lévő slot egyedi azonosítója, például 'homepage\_banner\_slot\_1'. Ez az azonosító biztosítja, hogy a banner a kereskedő által meghatározott megfelelő slotot használja, például single tile, double tile vagy banner. | | `artworkImageId` | A bannerhez feltöltött illusztráció egyedi azonosítója. Ezt az azonosítót (fileId) a Kreatív anyagok feltöltése API adja vissza. | | `link` | Ez a bannerhelyhez kapcsolódó URL, amely a hirdetésre kattintva a céloldalra irányítja a felhasználókat. Példa: | | `altText` | Az illusztrációt leíró alternatív szöveg akadálymentesítési célokból. Példa: 'Promóciós banner nyári kiárusításhoz'. | | `text` | Megjelenő szöveg a banneren. A slot megjelenő szövege, amely további információkat vagy üzenetet nyújt. Példa: 'Kapjon 20% kedvezményt az első vásárlásából!' | | `trackingTags` | A szolgáltatótól származó követőtagek listája, amelyek a slot-tal való interakciók nyomon követésére szolgálnak. Példa: \[ { provider: 'Google Analytics', tag: 'promo\_click' }, { provider: 'Adobe Analytics', tag: 'banner\_view' } ]. Ezek a tagek a hirdetés részét képezik a harmadik fél általi ellenőrzéshez. | --- # 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/hu/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.