> 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/sv/partner-api-overview/campaign-field-definitions.md).
# Fältdefinitioner för kampanj
## Vanliga kampanjfält
Det här avsnittet ger korta beskrivningar och exempel för att hjälpa dig att förstå vanliga kampanjfält för olika typer, till exempel produktannonser, banners och banner X. Varje post innehåller fältets syfte och ett representativt implementeringsexempel för din plattform.
| Fält | Syfte och exempel |
| ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | Det rekommenderas att inkludera detaljer som den marknadsförda produkten, tidsramen eller strategin, till exempel "Cadbury Chocolate June Clearance", för att hjälpa till att enkelt identifiera kampanjen. Namnet kan vara upp till 255 tecken långt. |
| `namespaceId` | Den unika identifieraren för din namnområdesdomän, placerad i grund-URL:en. Till exempel i exampleretailer.citrusad.com, är namespaceId is exampleretailer.
Se till att resursen finns för det ID du anger som namnområde.
|
| `approval.state` | Kampanjens godkännandestatus kan endast använda angivna enum-värden. Statusar som stöds är APPROVAL\_STATE\_APPROVED, APPROVAL\_STATE\_REJECTED, APPROVAL\_STATE\_PENDING.
Observera attAPPROVAL\_STATE\_UNSPECIFIED inte kan användas.
|
| `approval.rejectionReason` | Orsaken till att en kampanj har avvisats. Detta är ett obligatoriskt fält om statusen är `APPROVAL_STATE_REJECTED`. |
| `campaignState` | Kampanjens aktiva status anger om den är aktiv, pausad, ett utkast eller arkiverad. Till exempel, CAMPAIGN\_STATE\_ACTIVE, CAMPAIGN\_STATE\_DRAFT, CAMPAIGN\_STATE\_UNSPECIFIED.
Observera att CAMPAIGN\_STATE\_UNSPECIFIED inte kan användas.
|
| `teamId` | Detta teamId är den unika identifieraren för kampanjens team.
Se till att resursen finns för det angivna team-ID:t och inte har arkiveringsflaggan satt. Dessutom måste mallens team-ID matcha kampanjens team-ID.
|
| `startTime` | Kampanjens starttid med en exakt ISO-8601-tidsstämpel. Till exempel, 2024-09-01T12:00:00Z.
Uteslut detta värde för always on -kampanjer.
|
| `endTime` | Kampanjens sluttid använder en exakt ISO-8601-tidsstämpel och måste anges om startTime är angiven. Till exempel, 2024-09-30T23:59:59Z. Sluttiden måste vara efter starttiden.
Uteslut detta värde föralways on -kampanjer.
|
| `walletId` | Den unika identifieraren för plånboken som ska debiteras för kampanjen, till exempel wallet\_123456789.
- If campaignType inte är "Wildcard", bör ett objekt finnas för ID:t.
- Plånbokens team-ID ska matcha kampanjens team-ID.
- Plånbokens valutakod måste matcha kampanjkatalogens valutakod. Om du är osäker på detta, kontrollera med din Customer Integration Engineer (CIE).
|
| `placementId` | Den unika identifieraren för kampanjens placering. Till exempel, placement\_987654321.
Se till att resursen finns för det angivna placerings-ID:t och att den motsvarar rätt kampanj.
|
| `catalogIds` | Den unika identifieraren för återförsäljarens katalog(er). Till exempel, \["329f1e08-d3ee-4e04-90c4-068b3ce6b856","6c29a96a-f55a-497f-b03a-2fed85dd7198" ].
Se till att resursen finns för det angivna katalog-ID:t och att den motsvarar rätt kampanj.
|
| `advertisedProducts.
productsByKey` | Kombinationerna av produktkoder och katalog-ID:n som annonseras i kampanjen. Om en kampanj visas i två kataloger, ange två katalog-produkt-parningar.
Till exempel, \[{"catalogId": "14edbbc5-a7be-4c54-9f35-767b4ee29fd3","productCode": "ABC123"}].
|
| `targeting.searchTerms` | Söktermerna och deras matchningstyper som kampanjen kommer att rikta in sig på. Inkludera endast denna information för sökplaceringar. Till exempel, `{"matchType": "MATCH_TYPE_EXACT_MATCH","phrase": "string"}`}. |
| `targeting.excludeFilters` | Filter som ska exkluderas under riktningsstadiet, vilket endast bör vara plats- eller kategorifilter som är anpassade till din filterClassId. De flesta integrationer kan utelämna dessa värden. Om du använder två filterklasser, ange ett objekt per filterklass:
{"excludeFilters": \[ \
{ \
"catalogId": "76df36b4-45a2-46a5-9308-3dd14861d76e", \
"filter": "category:chocolate" \
}, \
{ \
"catalogId": "76df36b4-45a2-46a5-9308-3dd14861d76e", \
"filter": "location:florida" \
} \
] \
}
|
| `targeting.includeFilters` | Explicita filter som kampanjen ska rikta in sig på. Utelämna detta för standardintegrationer. Fyll endast i detta fält om du blir rådd till det eller när du skapar kampanjer med Fast placering.
{"includeFilters": \[ \
{ \
"catalogId": "76df36b4-45a2-46a5-9308-3dd14861d76e", \
"filter": "category:flavoured-milk" \
} \
] \
}
|
| `targeting.negativeSearchTerms` | Negativa söktermer utesluter specifika ord eller fraser från din kampanj, vilket förhindrar att dina annonser visas i orelevanta sökningar. Denna strategi förfinar din målgrupp, sänker kostnaderna och ökar kampanjens effektivitet. Att till exempel lägga till `used` som en negativ term för en ny bilannons undviker att den visas för personer som söker efter begagnade bilar. |
| `targeting.crossSell` | Anger inriktning på korsförsäljningsplaceringar. |
| `targeting.crossSell.
targetProductsByKey` | Anger explicita katalog-produkt-parningar som ska riktas in.
\[{"catalogId": "14edbbc5-a7be-4c54-9f35-767b4ee29fd3","productCode": "ABC123"}]
- Målproduktkataloger måste matcha kampanjkatalogerna.
- En produkt måste finnas för varje produkt-katalog-par.
- Målprodukter kan inte vara bland de annonserade produkterna.
- Målprodukter och annonserade produkter måste dela matchande kategorier.
|
| `targeting.upSell.
targetProductsByKey` | Anger explicita katalog-produkt-parningar som ska riktas in.
\[{"catalogId": "14edbbc5-a7be-4c54-9f35-767b4ee29fd3","productCode": "ABC123"}]
|
| `strategy.auction.maxBid` | Det maximala kostnad-per-klick (CPC)-budet för din kampanj. Till exempel 2.99.
- Måste vara en giltig BigDecimal.
- Måste vara mer än minimibudet.
},
"strategy": {
"auction": {
"maxBid": "string",
"spendLimit": {
"daily": "string",
"total": "string"
}
},
|
| `strategy.auction.spendLimit` | Anger den maximala dagliga eller totala utgiften för en kampanj.
Utelämna detta för en always on -kampanj, som kommer att fortsätta spendera så länge det finns medel i kampanjens plånbok. Till exempel: "daily": "1000". Se till att utgiftsgränsen är ett BigDecimal-värde större än 0.
},
"strategy": {
"auction": {
"maxBid": "string",
"spendLimit": {
"daily": "string",
"total": "string"
}
},
|
| `strategy.fixedTenancy.cost` | Representerar den totala kostnaden för kampanjen, används endast för rapporteringsändamål och dras inte från plånboken. Detta värde kan uppdateras om återförsäljaren optimerar över en hel förpackning eller införandeorder (IO). Till exempel: 1000.99.
"fixedTenancy": {
"cost": "1000.99",
"positions": \[
0
],
"catalogCosts": \[
{
"catalogId": "string",
"catalogCostPercentage": 0
}
]
}
|
| `strategy.fixedTenancy.
catalogCostPercentage` | Ett värde mellan 0 och 1 som anger den andel av kostnaden som tilldelas varje katalog. Om du använder flera kataloger, tilldela en andel (t.ex. 0,5). För en enskild katalog, använd värdet 1.
"fixedTenancy": {
"cost": "string",
"positions": \[
0
],
"catalogCosts": \[
{
"catalogId": "string",
"catalogCostPercentage": 0.5
}
]
}
|
| `strategy.fixedTenancy.
fixedCosts` | Anger ytterligare kostnader för externa data, annonskreativt arbete eller andra tjänster relaterade till kampanjen. Dessa avgifter gäller när kampanjen godkänns och kan inte ändras. Utelämna detta om inte ytterligare kostnader är tillämpliga på din annonsör.
{
"dataCost": "150",
"creativeCost": "200",
"otherCost": "400"
}
|
| `fixedCosts.dataCost` | Kostnaden kopplad till data för kampanjen. Till exempel 100,00 $. |
| `fixedCosts.creativeCost` | Kostnaden kopplad till produktion av annonskreativ för kampanjen. Till exempel 200,00 $. |
| `fixedCosts.otherCost` | Kostnaden kopplad till övriga utgifter för kampanjen. Till exempel 50,00 $. |
| `customFields.customFieldId` | Anger det unika customFieldId som konfigureras. Anpassade fält krävs inte i en standardintegration och det är sannolikt att detta fält inte används om du inte rekommenderas det av din Customer Integration Engineer (CIE).
{
"customFieldId": "3e31d3e4-bf15-411b-a18e-5553f08a6122",
"content": "PO-12345"
}
|
| `customFields.content` | Innehållet för det anpassade fältet i kampanjen.
{
"customFieldId": "3e31d3e4-bf15-411b-a18e-5553f08a6122",
"content": "PO-12345"
}
|
| `customQuestions.customQuestionId` | Anger den unika anpassade målinriktningsfrågan som konfigureras. Anpassade frågor krävs inte i en standardintegration och det är sannolikt att detta fält inte används om du inte rekommenderas det av din Customer Integration Engineer (CIE).
{
"answers": \[
"preference:delivery",
"preference:online"
],"customQuestionId": "593a9860-5ce4-4dcc-b6c4-15cf6fb08426"
}
|
| `customQuestions.answers` | Anger de svar som valts av annonsörer för kundmålinriktning. Måste stämma överens med kund- targetingData värden.
{
"answers": \[
"preference:delivery",
"preference:online"
],"customQuestionId": "593a9860-5ce4-4dcc-b6c4-15cf6fb08426"
}
|
## Banner X kampanjfält
| Fält | Syfte och exempel |
| ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `contentStandardId` | En unik identifierare för innehållsstandarden. Innehållsstandarder är riktlinjer och tekniska parametrar som styr hur en bannerannons ska visas inom ett angivet utrymme på en webbplats eller digital plattform.
Denna identifierare behövs för att verifiera att den skapade banner X-tillgången följer återförsäljarens innehållsstandarder.
|
| `slotId` | En unik identifierare för platsen i konfigurationen, såsom 'homepage\_banner\_slot\_1'. Denna identifierare säkerställer att bannern använder rätt plats så som den definierats av återförsäljaren, som enskild ruta, dubbelruta eller banner. |
| `slotType` | Den unika platsen inom innehållsstandarden där bilden kommer att placeras. Den säkerställer att bilden följer fördefinierade platskrav och valideringar. Exempel inkluderar left\_ribbon, top\_banner eller side\_panel. |
| `headingText` | Rubriktexten för bannern. |
| `bannerText` | Bannertext är den text som visas på din bannerannons. |
| `bannerTextColourHex` | Färgen på bannertexten i hex-format. |
| `ctaFlag` | En flagga som anger om bannern har en aktiverad uppmaning till handling (call-to-action). |
| `ctaText` | Uppmaningstexten (call-to-action) på bannern. En uppmaning till handling (CTA) är en klickbar text eller knapp som uppmanar användare att agera, som att göra ett köp eller besöka en annan sida. Till exempel "Handla nu". |
| `ctaTextAccessibility` | Uppmaningstexten (call-to-action) för tillgänglighetsändamål. |
| `ctaLink` | URL:en för länken för uppmaningen till handling. |
| `backgroundColourHex` | Färgen på den primära bakgrundsbilden för banner X i hexadecimalt format. |
| `backgroundImageId` | Detta är den unika identifieraren för den primära bakgrundsbilden. |
| `backgroundImagePosition` | Justeringsinställningen eller positionen för den primära bakgrundsbilden i dess behållare. |
| `secondaryBackgroundImageId` | Den unika identifieraren för den sekundära bakgrundsbilden. |
| `secondaryBackgroundImagePosition` | Justeringsinställningen eller positionen för den sekundära bakgrundsbilden i dess behållare. |
| `heroImageId` | Den unika identifieraren för huvudbilden (hero image). Huvudbilden är den primära kampanjbilden, som vanligtvis används för att visa din produkt eller logotyp. |
| `heroImageAltText` | Alternativtexten för huvudbilden, som hjälper till med tillgänglighet. |
| `heroMode` | Visningsläget eller stilen för huvudsektionen. |
| `secondaryHeroImageId` | Den unika identifieraren för den sekundära huvudbilden. |
| `secondaryHeroImageAltText` | Alternativtexten för den sekundära huvudbilden, som hjälper till med tillgänglighet. |
| `secondaryHeroMode` | Visningsläget eller stilen för den sekundära huvudsektionen. |
| `trackingTags` | En obligatorisk matris med objekt som används för att ange spårningsleverantörer och deras tillhörande taggar för att övervaka och analysera prestandan för en banner X-kampanj. |
| `additionalFields` | En obligatorisk matris med objekt som ger extra konfigurationsalternativ för banner X. |
## Fält för bannerkampanj
| Fält | Syfte och exempel |
| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `contentStandardId` | En unik identifierare för innehållsstandarden. Innehållsstandarder är riktlinjer och tekniska parametrar som styr hur en bannerannons ska visas inom ett angivet utrymme på en webbplats eller digital plattform.
Denna identifierare behövs för att verifiera att den skapade bannertillgången följer återförsäljarens innehållsstandarder.
|
| `slotId` | En unik identifierare för platsen i konfigurationen, såsom 'homepage\_banner\_slot\_1'. Denna identifierare säkerställer att bannern använder rätt plats så som den definierats av återförsäljaren, som enskild ruta, dubbelruta eller banner. |
| `artworkImageId` | En unik identifierare för den bildfil som laddats upp för bannern. Detta ID (fileId) returneras av API:et Ladda upp annonskreativ. |
| `link` | Detta är URL:en som är länkad till bannerplatsen och som dirigerar användare till en målsida när de klickar på annonsen. Exempel: |
| `altText` | Alternativ text som beskriver bildfilen för tillgänglighetsändamål. Exempel: 'Banner för sommarrea'. |
| `text` | Visningstext på bannern. Visningstexten för platsen som ger ytterligare information eller ett meddelande. Exempel: 'Få 20 % rabatt på ditt första köp!' |
| `trackingTags` | En lista över spårningstaggar från leverantören som används för att övervaka interaktioner med platsen. Exempel: \[ { provider: 'Google Analytics', tag: 'promo\_click' }, { provider: 'Adobe Analytics', tag: 'banner\_view' } ]. Dessa taggar inkluderas med din annons för tredjepartsverifiering. |
---
# 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/sv/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.