> 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/fr/partner-api-overview/campaign-field-definitions.md).
# Définitions des champs de campagne
## Champs communs aux campagnes
Cette section fournit de courtes descriptions et des exemples pour vous aider à comprendre les champs communs aux campagnes selon leurs différents types, tels que les annonces de produits, les bannières et les bannières X. Chaque entrée comprend l'objectif du champ et un exemple d'implémentation représentatif pour votre plateforme.
| Champ | Objectif et exemple |
| ------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | Il est recommandé d'inclure des détails tels que le produit promu, la période ou la stratégie, comme « Liquidation chocolat Cadbury juin », pour aider à identifier facilement la campagne. Le nom peut contenir jusqu'à 255 caractères. |
| `namespaceId` | L'identifiant unique de votre espace de noms, situé dans l'URL de base. Par exemple, dans exampleretailer.citrusad.com, le namespaceId is exampleretailer.
Assurez-vous que la ressource existe pour l'ID que vous fournissez comme espace de noms.
|
| `approval.state` | L'état d'approbation de la campagne ne peut utiliser que des valeurs d'énumération spécifiées. Les états pris en charge sont APPROVAL\_STATE\_APPROVED, APPROVAL\_STATE\_REJECTED, APPROVAL\_STATE\_PENDING.
Notez queAPPROVAL\_STATE\_UNSPECIFIED ne peut pas être utilisé.
|
| `approval.rejectionReason` | La raison pour laquelle une campagne a été rejetée. Il s'agit d'un champ obligatoire si le statut est `APPROVAL_STATE_REJECTED`. |
| `campaignState` | L'état d'activité de la campagne indique si elle est active, en pause, à l'état de brouillon ou archivée. Par exemple, CAMPAIGN\_STATE\_ACTIVE, CAMPAIGN\_STATE\_DRAFT, CAMPAIGN\_STATE\_UNSPECIFIED.
Notez que CAMPAIGN\_STATE\_UNSPECIFIED ne peut pas être utilisé.
|
| `teamId` | L' teamId est l'identifiant unique de l'équipe de la campagne.
Assurez-vous que la ressource existe pour l'ID d'équipe donné et que le fanion archivé n'est pas activé. De plus, l'ID d'équipe du modèle doit correspondre à l'ID d'équipe de la campagne.
|
| `startTime` | L'heure de début de la campagne à l'aide d'un horodatage ISO-8601 précis. Par exemple, 2024-09-01T12:00:00Z.
Omettez cette valeur pour les campagnes always on .
|
| `endTime` | L'heure de fin de la campagne utilise un horodatage ISO-8601 précis et doit être définie si startTime est spécifié. Par exemple, 2024-09-30T23:59:59Z. L'heure de fin doit être postérieure à l'heure de début.
Omettez cette valeur pour les campagnesalways on .
|
| `walletId` | L'identifiant unique du portefeuille à débiter pour la campagne, par exemple, wallet\_123456789.
- If campaignType n'est pas 'Wildcard', un objet doit exister pour l'ID.
- L'ID d'équipe du portefeuille doit correspondre à l'ID d'équipe de la campagne.
- Le code devise du portefeuille doit correspondre au code devise du catalogue de la campagne. Si vous n'en êtes pas sûr, vérifiez auprès de votre ingénieur d'intégration client (CIE).
|
| `placementId` | L'identifiant unique de l'emplacement de la campagne. Par exemple, placement\_987654321.
Assurez-vous que la ressource existe pour l'ID d'emplacement donné et qu'elle correspond à la bonne campagne.
|
| `catalogIds` | L'identifiant unique du ou des catalogues du détaillant. Par exemple, \["329f1e08-d3ee-4e04-90c4-068b3ce6b856","6c29a96a-f55a-497f-b03a-2fed85dd7198" ].
Assurez-vous que la ressource existe pour l'ID de catalogue donné et qu'elle correspond à la bonne campagne.
|
| `advertisedProducts.
productsByKey` | Les combinaisons de codes produits et d'IDs de catalogue faisant l'objet d'une publicité dans la campagne. Si une campagne apparaît dans deux catalogues, fournissez deux associations catalogue-produit.
Par exemple, \[{"catalogId": "14edbbc5-a7be-4c54-9f35-767b4ee29fd3","productCode": "ABC123"}].
|
| `targeting.searchTerms` | Les termes de recherche et leurs types de correspondance que la campagne ciblera. Incluez ces informations uniquement pour les emplacements de recherche. Par exemple, `{"matchType": "MATCH_TYPE_EXACT_MATCH","phrase": "string"}`}. |
| `targeting.excludeFilters` | Filtres à exclure lors de l'étape de ciblage, qui doivent être uniquement des filtres de lieu ou de catégorie alignés avec votre filterClassId. La plupart des intégrations peuvent omettre ces valeurs. Si vous utilisez deux classes de filtres, spécifiez un objet par classe de filtre :
{"excludeFilters": \[ \
{ \
"catalogId": "76df36b4-45a2-46a5-9308-3dd14861d76e", \
"filter": "category:chocolate" \
}, \
{ \
"catalogId": "76df36b4-45a2-46a5-9308-3dd14861d76e", \
"filter": "location:florida" \
} \
] \
}
|
| `targeting.includeFilters` | Filtres explicites à cibler par la campagne. Omettez ceci pour les intégrations standards. Ne renseignez ce champ que si cela est conseillé ou lors de la création de campagnes avec Emplacement fixe.
{"includeFilters": \[ \
{ \
"catalogId": "76df36b4-45a2-46a5-9308-3dd14861d76e", \
"filter": "category:flavoured-milk" \
} \
] \
}
|
| `targeting.negativeSearchTerms` | Les mots clés négatifs excluent des mots ou phrases spécifiques de votre campagne, empêchant vos annonces d'apparaître dans des recherches non pertinentes. Cette stratégie affine votre audience, réduit les coûts et améliore l'efficacité de la campagne. Par exemple, ajouter `used` comme terme négatif pour une annonce de voiture neuve évite de l'afficher aux personnes recherchant des voitures d'occasion. |
| `targeting.crossSell` | Spécifie le ciblage sur les emplacements de vente croisée. |
| `targeting.crossSell.
targetProductsByKey` | Spécifie les associations catalogue-produit explicites à cibler.
\[{"catalogId": "14edbbc5-a7be-4c54-9f35-767b4ee29fd3","productCode": "ABC123"}]
- Les catalogues de produits cibles doivent correspondre aux catalogues de la campagne.
- Un produit doit exister pour chaque paire produit-catalogue.
- Les produits cibles ne peuvent pas faire partie des produits annoncés.
- Les produits cibles et les produits annoncés doivent partager des catégories correspondantes.
|
| `targeting.upSell.
targetProductsByKey` | Spécifie les associations catalogue-produit explicites à cibler.
\[{"catalogId": "14edbbc5-a7be-4c54-9f35-767b4ee29fd3","productCode": "ABC123"}]
|
| `strategy.auction.maxBid` | L'enchère de coût par clic maximal (CPC) de votre campagne. Par exemple, 2.99.
- Doit être un BigDecimal valide.
- Doit être supérieure à l'enchère minimale.
},
"strategy": {
"auction": {
"maxBid": "string",
"spendLimit": {
"daily": "string",
"total": "string"
}
},
|
| `strategy.auction.spendLimit` | Spécifie la dépense maximale quotidienne ou totale pour une campagne.
Omettez ceci pour une campagne always on qui continuera à dépenser tant qu'il y aura des fonds dans le portefeuille de la campagne. Par exemple : "daily": "1000". Assurez-vous que la limite de dépense est une valeur BigDecimal supérieure à 0.
},
"strategy": {
"auction": {
"maxBid": "string",
"spendLimit": {
"daily": "string",
"total": "string"
}
},
|
| `strategy.fixedTenancy.cost` | Représente le coût total de la campagne, utilisé à des fins de reporting uniquement et non déduit du portefeuille. Cette valeur peut être mise à jour si le détaillant optimise sur l'ensemble d'un package ou d'un ordre d'insertion (IO). Par exemple : 1000.99.
"fixedTenancy": {
"cost": "1000.99",
"positions": \[
0
],
"catalogCosts": \[
{
"catalogId": "string",
"catalogCostPercentage": 0
}
]
}
|
| `strategy.fixedTenancy.
catalogCostPercentage` | Une valeur comprise entre 0 et 1 indiquant la part du coût attribuée à chaque catalogue. Si vous utilisez plusieurs catalogues, attribuez une part (par exemple, 0,5). Pour un seul catalogue, utilisez la valeur 1.
"fixedTenancy": {
"cost": "string",
"positions": \[
0
],
"catalogCosts": \[
{
"catalogId": "string",
"catalogCostPercentage": 0.5
}
]
}
|
| `strategy.fixedTenancy.
fixedCosts` | Spécifie les coûts supplémentaires pour les données externes, le travail de création ou d'autres services liés à la campagne. Ces frais s'appliquent lorsque la campagne est approuvée et ne peuvent pas être modifiés. Omettez ceci sauf si des coûts supplémentaires s'appliquent à votre annonceur.
{
"dataCost": "150",
"creativeCost": "200",
"otherCost": "400"
}
|
| `fixedCosts.dataCost` | Le coût associé aux données pour la campagne. Par exemple, 100,00 $. |
| `fixedCosts.creativeCost` | Le coût associé à la production de la création pour la campagne. Par exemple, 200,00 $. |
| `fixedCosts.otherCost` | Le coût associé aux autres dépenses pour la campagne. Par exemple, 50,00 $. |
| `customFields.customFieldId` | Spécifie le customFieldId unique en cours de configuration. Les champs personnalisés ne sont pas requis dans une intégration standard et il est probable que vous n'utilisiez pas ce champ, sauf recommandation de votre ingénieur d'intégration client (CIE).
{
"customFieldId": "3e31d3e4-bf15-411b-a18e-5553f08a6122",
"content": "PO-12345"
}
|
| `customFields.content` | Le contenu du champ personnalisé de la campagne.
{
"customFieldId": "3e31d3e4-bf15-411b-a18e-5553f08a6122",
"content": "PO-12345"
}
|
| `customQuestions.customQuestionId` | Spécifie la question de ciblage personnalisé unique en cours de configuration. Les questions personnalisées ne sont pas requises dans une intégration standard et il est probable que vous n'utilisiez pas ce champ, sauf recommandation de votre ingénieur d'intégration client (CIE).
{
"answers": \[
"preference:delivery",
"preference:online"
],"customQuestionId": "593a9860-5ce4-4dcc-b6c4-15cf6fb08426"
}
|
| `customQuestions.answers` | Spécifie les réponses sélectionnées par les annonceurs pour le ciblage client. Doit correspondre aux valeurs targetingData client.
{
"answers": \[
"preference:delivery",
"preference:online"
],"customQuestionId": "593a9860-5ce4-4dcc-b6c4-15cf6fb08426"
}
|
## Banner X champs de la campagne
| Champ | Objectif et exemple |
| ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `contentStandardId` | Un identifiant unique pour la norme de contenu. Les normes de contenu sont des directives et des paramètres techniques qui dictent la manière dont une annonce bannière doit être affichée dans un espace désigné sur un site web ou une plateforme numérique.
Cet identifiant est nécessaire pour vérifier que la ressource de bannière X créée respecte les normes de contenu du distributeur.
|
| `slotId` | Un identifiant unique pour l'emplacement dans la configuration, tel que « homepage\_banner\_slot\_1 ». Cet identifiant garantit que la bannière utilise le bon emplacement tel que défini par le distributeur, comme un pavé simple, un pavé double ou une bannière. |
| `slotType` | L'emplacement unique au sein de la norme de contenu où l'image sera placée. Il garantit que l'image respecte les exigences et validations d'emplacement prédéfinies. Les exemples incluent left\_ribbon, top\_banner ou side\_panel. |
| `headingText` | Le texte de titre pour la bannière. |
| `bannerText` | Le texte de la bannière est le texte affiché sur votre annonce bannière. |
| `bannerTextColourHex` | La couleur du texte de la bannière au format hexadécimal. |
| `ctaFlag` | Un indicateur spécifiant si la bannière a un appel à l'action activé. |
| `ctaText` | Le texte de l'appel à l'action sur la bannière. Un appel à l'action (CTA) est un texte ou un bouton cliquable incitant les utilisateurs à agir, comme effectuer un achat ou visiter une autre page. Par exemple, « Acheter maintenant ». |
| `ctaTextAccessibility` | Le texte de l'appel à l'action à des fins d'accessibilité. |
| `ctaLink` | L'URL pour le lien d'appel à l'action. |
| `backgroundColourHex` | La couleur de l'image de fond principale de la bannière X au format hexadécimal. |
| `backgroundImageId` | Il s'agit de l'identifiant unique de l'image de fond principale. |
| `backgroundImagePosition` | L'alignement ou la position de l'image de fond principale dans son conteneur. |
| `secondaryBackgroundImageId` | L'identifiant unique de l'image de fond secondaire. |
| `secondaryBackgroundImagePosition` | L'alignement ou la position de l'image de fond secondaire dans son conteneur. |
| `heroImageId` | L'identifiant unique pour l'image principale. L'image principale est l'image promotionnelle centrale, généralement utilisée pour afficher votre produit ou votre logo. |
| `heroImageAltText` | Le texte alternatif pour l'image principale, aidant à l'accessibilité. |
| `heroMode` | Le mode d'affichage ou le style de la section principale. |
| `secondaryHeroImageId` | L'identifiant unique pour l'image principale secondaire. |
| `secondaryHeroImageAltText` | Le texte alternatif pour l'image principale secondaire, aidant à l'accessibilité. |
| `secondaryHeroMode` | Le mode d'affichage ou le style de la section principale secondaire. |
| `trackingTags` | Un tableau d'objets requis utilisé pour spécifier les fournisseurs de suivi et leurs balises associées afin de surveiller et d'analyser les performances d'une campagne de bannière X. |
| `additionalFields` | Un tableau d'objets requis fournissant des options de configuration supplémentaires pour la bannière X. |
## Champs de campagne de bannière
| Champ | Objectif et exemple |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `contentStandardId` | Un identifiant unique pour la norme de contenu. Les normes de contenu sont des directives et des paramètres techniques qui dictent la manière dont une annonce bannière doit être affichée dans un espace désigné sur un site web ou une plateforme numérique.
Cet identifiant est nécessaire pour vérifier que la ressource de bannière créée respecte les normes de contenu du distributeur.
|
| `slotId` | Un identifiant unique pour l'emplacement dans la configuration, tel que « homepage\_banner\_slot\_1 ». Cet identifiant garantit que la bannière utilise le bon emplacement tel que défini par le distributeur, comme un pavé simple, un pavé double ou une bannière. |
| `artworkImageId` | Un identifiant unique pour l'image d'illustration téléversée pour la bannière. Cet ID (fileId) est renvoyé par l'API Téléverser les ressources de création. |
| `link` | Il s'agit de l'URL liée à l'Emplacement de bannière, redirigeant les utilisateurs vers une page cible lorsqu'ils cliquent sur l'annonce. Exemple : |
| `altText` | Texte alternatif décrivant l'image d'illustration à des fins d'accessibilité. Exemple : « Bannière promotionnelle pour les soldes d'été ». |
| `text` | Texte d'affichage sur la bannière. Le texte d'affichage pour l'emplacement, fournissant des informations supplémentaires ou un message. Exemple : « Obtenez 20 % de réduction sur votre premier achat ! » |
| `trackingTags` | Une liste de balises de suivi du fournisseur, utilisées pour surveiller les interactions avec l'emplacement. Exemple : \[ { provider: 'Google Analytics', tag: 'promo\_click' }, { provider: 'Adobe Analytics', tag: 'banner\_view' } ]. Ces balises sont incluses avec votre annonce pour une vérification tierce. |
---
# 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/fr/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.