> 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/de/partner-api-overview/campaign-field-definitions.md). # Kampagnenfeld-Definitionen ## Gemeinsame Kampagnenfelder Dieser Abschnitt bietet kurze Beschreibungen und Beispiele, die Ihnen helfen, gemeinsame Kampagnenfelder über verschiedene Typen hinweg zu verstehen, wie z. B. Produktanzeigen, Banner und Banner X. Jeder Eintrag enthält den Zweck des Feldes und ein repräsentatives Implementierungsbeispiel für Ihre Plattform. | Feld | Zweck und Beispiel | | ------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `name` | Es wird empfohlen, Details wie das beworbene Produkt, den Zeitraum oder die Strategie anzugeben, wie z. B. 'Cadbury Chocolate June Clearance', um die Identifizierung der Kampagne zu erleichtern. Der Name kann bis zu 255 Zeichen lang sein. | | `namespaceId` |

Eindeutige Kennung Ihres Namespace, die sich in der Basis-URL befindet. Beispiel: exampleretailer.citrusad.com, die namespaceId is exampleretailer.

Stellen Sie sicher, dass die Ressource für die von Ihnen als Namespace angegebene ID existiert.

| | `approval.state` |

Der Genehmigungsstatus der Kampagne kann nur bestimmte Enum-Werte verwenden. Unterstützte Status sind APPROVAL\_STATE\_APPROVED, APPROVAL\_STATE\_REJECTED, APPROVAL\_STATE\_PENDING.

Beachten Sie, dassAPPROVAL\_STATE\_UNSPECIFIED nicht verwendet werden kann.

| | `approval.rejectionReason` | Der Grund, warum eine Kampagne abgelehnt wurde. Dies ist ein Pflichtfeld, wenn der Status `APPROVAL_STATE_REJECTED`. | | `campaignState` |

Der Aktivitätsstatus der Kampagne gibt an, ob sie aktiv, pausiert, ein Entwurf oder archiviert ist. Beispiel: CAMPAIGN\_STATE\_ACTIVE, CAMPAIGN\_STATE\_DRAFT, CAMPAIGN\_STATE\_UNSPECIFIED.

Beachten Sie, dass CAMPAIGN\_STATE\_UNSPECIFIED nicht verwendet werden kann.

| | `teamId` |

Die teamId ist die eindeutige Kennung des Teams der Kampagne.

Stellen Sie sicher, dass die Ressource für die angegebene Team-ID existiert und nicht als archiviert markiert ist. Außerdem muss die Vorlagen-Team-ID mit der Kampagnen-Team-ID übereinstimmen.

| | `startTime` |

Die Startzeit der Kampagne unter Verwendung eines präzisen ISO-8601-Zeitstempels. Beispiel: 2024-09-01T12:00:00Z.

Lassen Sie diesen Wert bei always on -Kampagnen weg.

| | `endTime` |

Die Endzeit der Kampagne verwendet einen präzisen ISO-8601-Zeitstempel und muss festgelegt werden, wenn startTime angegeben ist. Beispiel: 2024-09-30T23:59:59Z. Die Endzeit muss nach der Startzeit liegen.

Lassen Sie diesen Wert beialways on -Kampagnen weg.

| | `walletId` |

Die eindeutige Kennung des Wallets, das für die Kampagne belastet werden soll, zum Beispiel wallet\_123456789.

- If campaignType nicht 'Wildcard' ist, sollte ein Objekt für die ID existieren.
- Die Wallet-Team-ID sollte mit der Kampagnen-Team-ID übereinstimmen.
- Der Währungscode des Wallets muss mit dem Währungscode des Kampagnenkatalogs übereinstimmen. Wenn Sie sich nicht sicher sind, wenden Sie sich an Ihren Customer Integration Engineer (CIE).

| | `placementId` |

Die eindeutige Kennung der Platzierung der Kampagne. Zum Beispiel placement\_987654321.

Stellen Sie sicher, dass die Ressource für die angegebene Platzierungs-ID existiert und der richtigen Kampagne entspricht.

| | `catalogIds` |

Die eindeutige Kennung des Katalogs/der Kataloge des Händlers. Zum Beispiel \["329f1e08-d3ee-4e04-90c4-068b3ce6b856","6c29a96a-f55a-497f-b03a-2fed85dd7198" ].

Stellen Sie sicher, dass die Ressource für die angegebene Katalog-ID existiert und der richtigen Kampagne entspricht.

| | `advertisedProducts.
productsByKey` |

Die Kombinationen aus Produktcodes und Katalog-IDs, die in der Kampagne beworben werden. Wenn eine Kampagne in zwei Katalogen erscheint, geben Sie zwei Katalog-Produkt-Paarungen an.

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

| | `targeting.searchTerms` | Die Suchbegriffe und deren Übereinstimmungstypen (Match Types), auf die die Kampagne ausgerichtet ist. Fügen Sie diese Informationen nur für Suchplatzierungen ein. Zum Beispiel `{"matchType": "MATCH_TYPE_EXACT_MATCH","phrase": "string"}`}. | | `targeting.excludeFilters` |

Auszuschließende Filter während der Targeting-Phase, bei denen es sich nur um Standort- oder Kategoriefilter handeln sollte, die auf Ihre filterClassIdabgestimmt sind. Bei den meisten Integrationen können diese Werte weggelassen werden. Wenn Sie zwei Filterklassen verwenden, geben Sie ein Objekt pro Filterklasse an:

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

| | `targeting.includeFilters` |

Explizite Filter, auf die die Kampagne ausgerichtet werden soll. Lassen Sie dies bei Standardintegrationen weg. Füllen Sie dieses Feld nur aus, wenn Sie dazu aufgefordert werden oder wenn Sie Feste Platzierung-Kampagnen erstellen.

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

| | `targeting.negativeSearchTerms` | Ausschließende Suchbegriffe schließen bestimmte Wörter oder Phrasen aus Ihrer Kampagne aus und verhindern, dass Ihre Anzeigen in nicht relevanten Suchanfragen erscheinen. Diese Strategie verfeinert Ihre Zielgruppe, senkt die Kosten und steigert die Kampagneneffizienz. Das Hinzufügen von `used` als ausschließender Begriff für eine Neuwagenanzeige verhindert beispielsweise, dass diese Personen angezeigt wird, die nach Gebrauchtwagen suchen. | | `targeting.crossSell` | Gibt das Targeting auf Cross-Selling-Platzierungen an. | | `targeting.crossSell.
targetProductsByKey` |

Gibt explizite Katalog-Produkt-Paarungen an, auf die das Targeting ausgerichtet werden soll.

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

- Ziel-Produktkataloge müssen mit den Kampagnenkatalogen übereinstimmen.
- Für jedes Produkt-Katalog-Paar muss ein Produkt existieren.
- Zielprodukte dürfen nicht zu den beworbenen Produkten gehören.
- Zielprodukte und beworbene Produkte müssen übereinstimmende Kategorien aufweisen.

| | `targeting.upSell.
targetProductsByKey` |

Gibt explizite Katalog-Produkt-Paarungen an, auf die das Targeting ausgerichtet werden soll.

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

| | `strategy.auction.maxBid` |

Das maximale Kosten-pro-Klick-Gebot (CPC) Ihrer Kampagne. Zum Beispiel 2.99.

- Muss ein gültiger BigDecimal-Wert sein.
- Muss höher sein als das Mindestgebot.

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

| | `strategy.auction.spendLimit` |

Gibt die maximalen täglichen oder gesamten Ausgaben für eine Kampagne an.

Lassen Sie dies bei einer always on -Kampagne weg, die so lange Ausgaben tätigt, wie Guthaben im Wallet der Kampagne vorhanden ist. Beispiel: "daily": "1000". Stellen Sie sicher, dass das Ausgabenlimit ein BigDecimal-Wert größer als 0 ist.

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

| | `strategy.fixedTenancy.cost` |

Repräsentiert die Gesamtkosten der Kampagne, wird nur für Berichtszwecke verwendet und nicht vom Wallet abgezogen. Dieser Wert kann aktualisiert werden, wenn der Händler über ein gesamtes Paket oder einen Einfügungsauftrag (IO) hinweg optimiert. Beispiel: 1000.99.

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

| | `strategy.fixedTenancy.
catalogCostPercentage` |

Ein Wert zwischen 0 und 1, der den Anteil der Kosten angibt, der jedem Katalog zugewiesen ist. Wenn Sie mehrere Kataloge verwenden, weisen Sie einen Anteil zu (z. B. 0.5). Verwenden Sie für einen einzelnen Katalog den Wert 1.

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

| | `strategy.fixedTenancy.
fixedCosts` |

Gibt zusätzliche Kosten für externe Daten, Werbemittel-Erstellung oder andere Dienste im Zusammenhang mit der Kampagne an. Diese Gebühren fallen an, wenn die Kampagne genehmigt wird, und können nicht geändert werden. Lassen Sie dies weg, es sei denn, für Ihren Werbetreibenden fallen zusätzliche Kosten an.

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

| | `fixedCosts.dataCost` | Die mit den Daten für die Kampagne verbundenen Kosten. Zum Beispiel 100,00 $. | | `fixedCosts.creativeCost` | Die mit der Produktion des Werbemittels für die Kampagne verbundenen Kosten. Zum Beispiel 200,00 $. | | `fixedCosts.otherCost` | Die mit sonstigen Ausgaben für die Kampagne verbundenen Kosten. Zum Beispiel 50,00 $. | | `customFields.customFieldId` |

Gibt die eindeutige customFieldId an, die konfiguriert wird. Benutzerdefinierte Felder sind in einer Standardintegration nicht erforderlich, und es ist wahrscheinlich, dass dieses Feld nicht verwendet wird, es sei denn, Ihr Customer Integration Engineer (CIE) rät dazu.

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

| | `customFields.content` |

Der Inhalt für das benutzerdefinierte Feld der Kampagne.

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

| | `customQuestions.customQuestionId` |

Gibt die eindeutige benutzerdefinierte Targetingsfrage an, die konfiguriert wird. Benutzerdefinierte Fragen sind in einer Standardintegration nicht erforderlich, und es ist wahrscheinlich, dass dieses Feld nicht verwendet wird, es sei denn, Ihr Customer Integration Engineer (CIE) rät dazu.

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

| | `customQuestions.answers` |

Gibt die von den Werbetreibenden ausgewählten Antworten für das Kunden-Targeting an. Muss mit den Kunden- targetingData Werten übereinstimmen.

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

| ## Banner X Kampagnenfelder | Feld | Zweck und Beispiel | | ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `contentStandardId` |

Eindeutiger Bezeichner für den Inhaltsstandard. Inhaltsstandards sind Richtlinien und technische Parameter, die festlegen, wie eine Banner-Anzeige innerhalb eines vorgesehenen Bereichs auf einer Website oder digitalen Plattform angezeigt werden soll.

Dieser Bezeichner wird benötigt, um zu überprüfen, ob das erstellte Banner X-Asset den Inhaltsstandards des Händlers entspricht.

| | `slotId` | Eindeutiger Bezeichner für die Platzierung in der Konfiguration, wie z. B. 'homepage\_banner\_slot\_1'. Dieser Bezeichner stellt sicher, dass das Banner die korrekte Banner-Platzierung verwendet, wie vom Händler definiert, z. B. Kachel, Doppelkachel oder Banner. | | `slotType` | Die eindeutige Platzierung innerhalb des Inhaltsstandards, in der das Bild platziert wird. Sie stellt sicher, dass das Bild die vordefinierten Anforderungen und Validierungen der Platzierung einhält. Beispiele hierfür sind left\_ribbon, top\_banner oder side\_panel. | | `headingText` | Der Überschriften-Text für das Banner. | | `bannerText` | Banner-Text ist der Text, der auf Ihrer Banner-Anzeige angezeigt wird. | | `bannerTextColourHex` | Die Farbe des Banner-Textes im Hex-Format. | | `ctaFlag` | Ein Flag, das angibt, ob das Banner einen aktivierten Call-to-Action hat. | | `ctaText` | Der Call-to-Action-Text auf dem Banner. Ein Call-to-Action (CTA) ist ein anklickbarer Text oder Button, der Nutzer zu einer Handlung auffordert, wie z. B. einen Kauf zu tätigen oder eine andere Seite zu besuchen. Zum Beispiel „Jetzt shoppen“. | | `ctaTextAccessibility` | Der Call-to-Action-Text für Barrierefreiheitszwecke. | | `ctaLink` | Die URL für den Call-to-Action-Link. | | `backgroundColourHex` | Die Farbe des primären Hintergrundbildes des Banners X im Hexadezimalformat. | | `backgroundImageId` | Dies ist der eindeutige Bezeichner des primären Hintergrundbildes. | | `backgroundImagePosition` | Die Ausrichtung oder Position des primären Hintergrundbildes innerhalb seines Containers. | | `secondaryBackgroundImageId` | Der eindeutige Bezeichner für das sekundäre Hintergrundbild. | | `secondaryBackgroundImagePosition` | Die Ausrichtung oder Position des sekundären Hintergrundbildes innerhalb seines Containers. | | `heroImageId` | Der eindeutige Bezeichner für das Hero-Bild. Das Hero-Bild ist das Hauptwerbebild, das typischerweise zur Anzeige Ihres Produkts oder Logos verwendet wird. | | `heroImageAltText` | Der Alternativtext für das Hero-Bild zur Unterstützung der Barrierefreiheit. | | `heroMode` | Der Anzeigemodus oder Stil des Hero-Bereichs. | | `secondaryHeroImageId` | Der eindeutige Bezeichner für das sekundäre Hero-Bild. | | `secondaryHeroImageAltText` | Der Alternativtext für das sekundäre Hero-Bild zur Unterstützung der Barrierefreiheit. | | `secondaryHeroMode` | Der Anzeigemodus oder Stil des sekundären Hero-Bereichs. | | `trackingTags` | Ein erforderliches Array von Objekten, die verwendet werden, um Tracking-Anbieter und deren zugehörige Tags zur Überwachung und Analyse der Performance einer Banner X-Kampagne anzugeben. | | `additionalFields` | Ein erforderliches Array von Objekten, das zusätzliche Konfigurationsoptionen für Banner X bereitstellt. | ## Banner-Kampagnenfelder | Feld | Zweck und Beispiel | | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `contentStandardId` |

Eindeutiger Bezeichner für den Inhaltsstandard. Inhaltsstandards sind Richtlinien und technische Parameter, die festlegen, wie eine Banner-Anzeige innerhalb eines vorgesehenen Bereichs auf einer Website oder digitalen Plattform angezeigt werden soll.

Dieser Bezeichner wird benötigt, um zu überprüfen, ob das erstellte Banner-Asset den Inhaltsstandards des Händlers entspricht.

| | `slotId` | Eindeutiger Bezeichner für die Platzierung in der Konfiguration, wie z. B. 'homepage\_banner\_slot\_1'. Dieser Bezeichner stellt sicher, dass das Banner die korrekte Banner-Platzierung verwendet, wie vom Händler definiert, z. B. Kachel, Doppelkachel oder Banner. | | `artworkImageId` | Ein eindeutiger Bezeichner für das hochgeladene Grafikbild des Banners. Diese ID (fileId) wird von der API zum Hochladen von Werbemitteln zurückgegeben. | | `link` | Dies ist die mit der Banner-Platzierung verknüpfte URL, die Nutzer beim Anklicken der Anzeige auf eine Zielseite weiterleitet. Beispiel: | | `altText` | Alternativtext, der das Grafikbild für Barrierefreiheitszwecke beschreibt. Beispiel: 'Werbebanner für den Sommer-Sale'. | | `text` | Anzeigetext auf dem Banner. Der Anzeigetext für die Platzierung, der zusätzliche Informationen oder eine Nachricht bereitstellt. Beispiel: 'Erhalten Sie 20 % Rabatt auf Ihren ersten Einkauf!' | | `trackingTags` | Eine Liste von Tracking-Tags des Anbieters, die zur Überwachung von Interaktionen mit der Platzierung verwendet werden. Beispiel: \[ { provider: 'Google Analytics', tag: 'promo\_click' }, { provider: 'Adobe Analytics', tag: 'banner\_view' } ]. Diese Tags sind in Ihrer Anzeige für die Verifizierung durch Drittanbieter enthalten. | --- # 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/de/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.