> 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/integration/fr/references/banner-x-reference-1.md). # Référence des bannières X Ci-dessous sont décrites les propriétés possibles dans une requête standard comme décrit dans [Demander des annonces](/retail-media-interface/integration/fr/generating-ads/banner-x-responsive/requesting-banner-x-ads.md) pour votre requête, et la réponse si vous recevez une annonce. ## Éléments demandés | Chaîne de caractères | Description | Obligatoire/facultatif | | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------- | | `BannerSlotIds` | Un tableau json des slotIds d'emplacement de bannière demandés. | Obligatoire | | `catalogId` | L'identifiant de votre catalogue de produits pour votre site web. | Obligatoire | | `contentStandardId` | L'identifiant de norme de contenu pour votre site web. | Obligatoire | | `customerId` | L'identifiant unique du client à qui les annonces sont diffusées. | Facultatif | | `filterMode` | Moyen facultatif de définir la structure de votre requête. Voir [Filtrage de la génération d'annonces](/retail-media-interface/integration/fr/data-api/api-overview/ad-generation-filtering-1.md) pour plus d'informations. | Facultatif, préféré | | `maxNumberOfAds` | Le nombre maximum pour chaque emplacement de bannière que vous souhaitez recevoir en retour. | Obligatoire | | `options` |

Moyen facultatif de définir la structure de votre requête. Voir Filtrage de génération d'annonces pour plus d'informations.

C'est également l'objet dans lequel vous pouvez demander des informations sur l'annonceur afin de vous conformer à la législation locale sur la publicité comme celle de l'Europe Loi sur les services numériques (Digital Services Act) .

| Facultatif, préféré | | `placement` | L'emplacement unique pour lequel vous demandez des annonces. | Obligatoire | | `productFilters` | Tous les filtres de produits pertinents pour votre requête. Comme un filtre de catégorie, de localisation ou de taille. | Obligatoire pour les emplacements de catégorie | | `searchTerm` | Le terme de recherche saisi par votre client sur votre site web. | Obligatoire pour les emplacements de recherche | | `sessionId` | L'identifiant unique de la session du client. Utilisé pour l'attribution dans les intégrations standard. Consulter [Options de flux de travail d'intégration](/retail-media-interface/integration/fr/data-api/api-overview/integration-workflow-options-1.md)pour plus d'informations. | Obligatoire dans les intégrations standard | | `slotId` | Ceci contient tout SlotId demandé dans le contexte. Il peut y en avoir un ou plusieurs. | Obligatoire | | `dtmCookieId` | Cookies créés et stockés par le site web, utilisés pour suivre le comportement de l'utilisateur sur le même domaine. | Facultatif | | `audience` | Spécifie les segments d'audience spécifiques auxquels l'acheteur appartient. Pertinent uniquement si vous utilisez [Option de ciblage d'audience 3](/retail-media-interface/integration/fr/data-api/audience-targeting-new/integration-option-3-sync-audiences-only.md) | Facultatif | ## Éléments retournés | Chaîne de caractères | Description | Exemple de valeur | | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ads.backgroundColour` | La couleur de fond de la bannière - valeurs HEX uniquement. | `6e6c6c` | | `ads.backgroundImage` | Le lien de l'image de fond de la bannière. | `[]\() | | `ads.backgroundImagePosition` | Ceci définit le type de position de l'image de fond. Si aucune valeur n'est fournie, vous devrez utiliser par défaut `leftaligned` . |

leftaligned
rightaligned
fill
repeating

| | `ads.bannerText` | Le texte affiché dans la bannière. Peut inclure des balises HTML | `Double Fudge Ice Cream` | | `ads.bannerTextColour` | La couleur du texte de la bannière - valeurs HEX uniquement. Citrus n'envoie pas le `#`. | `1dc711` | | `ads.citrusAdId` |

L'ID unique de l'annonce.
Ceci est unique pour chaque requête faite à Epsilon Retail Media et ne peut pas être mis en cache.

| `shotgun_wIpZraEXcIu0daC5YMQewPil2S83NzE0MTA3` | | `ads.citrusCampaignName` | Le nom de la campagne de l'annonce. | `Epsilon-Example-Category-Banner-X-Ad-ae536b0d5c3ded28ea624ab4285facd6` | | `ads.citrusContentStandardId` | L'ID de norme de contenu lié à l'emplacement. | `8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c` | | `ads.citrusExpiry` | L'expiration de l'annonce. Il s'agit du dernier moment où un clic peut être signalé à Epsilon Retail Media | `2021-06-01T23:48:16.573967987Z` | | `ads.citrusSlotId` | L'ID de l'emplacement spécifique pour la bannière que vous avez demandée. | `Category_Top` | | `ads.contentStandardId` | L'ID de norme de contenu lié à l'emplacement. Doublon de `citrusContentStandardId` | `8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c` | | `ads.ctaFlag` | Ceci définit si un CTA est affiché ou non. |

true
false

| | `ads.ctaLink` | L'URL redirigée depuis le CTA (similaire à linkUrl pour les bannières). Fournie uniquement si ctaFlag est `true` | ` | | `ads.ctaText` | Le texte à l'intérieur du CTA. | `Shop now` | | `ads.ctaTextAccessibility` | Texte d'accessibilité du CTA pour les utilisateurs de lecteurs d'écran. | `for Double Fudge Ice Cream` | | `ads.gtins` |

Un tableau contenant jusqu'à 20 codes produits sélectionnés parmi les produits annoncés de la campagne.

Les distributeurs peuvent utiliser cette liste pour automatiser les pages de listes lorsque la bannière est cliquée, ou automatiser certaines fonctionnalités de rendu (macarons, prix, vérification du niveau de stock secondaire).

| `[
"7714107",
"7163379",
"7733636",
"7733657",
"7733628"
],` | | `ads.headingText` | Texte d'en-tête pour les utilisateurs de lecteurs d'écran. | `Banner Advertisement for Fudge Double Ice Cream with a product image and shop now button` | | `ads.heroImageAltText` | Texte alternatif pour l'image principale dans le cas rare où elle ne s'afficherait pas. | `Image of double fudge iced cream` | | `ads.heroImage` | Le lien de l'image principale de la bannière. | `[]\() | | `ads.position` | La position de la bannière dans la Epsilon Retail Media réponse. Vous devez respecter cette position dans le cas où des campagnes d'emplacement fixe sont utilisées. | 1 | | `ads.secondaryBackgroundImage` | Le lien de l'image de fond secondaire. | `[]\() | | `ads.secondaryBackgroundImagePosition` | Ceci définit le type de position de l'image de fond secondaire. |

leftaligned
rightaligned

| | `ads.secondaryHeroImageAltText` | Texte alternatif pour l'image principale secondaire dans le cas rare où elle ne s'afficherait pas. | `Image of [brand] logo` | | `ads.secondaryHeroImage` | Le lien de l'image principale secondaire. | `[]\() | | `ads.secondaryHeroMode` | Ceci définit le mode d'affichage de l'image principale secondaire. Si aucune valeur n'est fournie, vous devrez utiliser par défaut `block` . |

block
landscape

| | `ads.slotId` | L'ID d'emplacement de la bannière que vous avez demandée. Lors de la requête de plusieurs bannières, ceci peut être utilisé pour référencer les ID demandés. | `Category_Top` | | `ads.tags` | Ce champ renvoie tous les tags tiers saisis par l'annonceur dans sa campagne. Ce n'est pas une fonctionnalité actuellement prise en charge par la bannière x, bien que la réponse de l'API soit formatée. | `{}` | | `ads.sellerId` | L'identifiant unique du vendeur. Ne sera renseigné que si un sellerId est défini sur une équipe. Les sellerIds sont généralement utilisés lors de l'intégration de vendeurs de marketplace. | `73nns-32sxr-32ss` Personnalisé par intégration | | `ads.metadata` |

Objet contenant les informations sur l'annonceur requises pour l'aider à se conformer à la législation locale sur la publicité telle que le Loi sur les services numériques (Digital Services Act) en Europe.

advertiser est extrait du nom de la société dans l'équipe fournisseur.

onBehalfOf est extrait du financeur de la publicité dans l'équipe fournisseur.

| `"metadata": {
"advertiserInfo": {
"advertiser": "Bob's advertising agency",
"onBehalfOf": "Brand company inc"
}
...` | | `ads.adm` | Objet contenant les détails de la publicité vidéo, y compris les balises VAST. | "\n\\n \\n \\n \Epsilon Retail Media\\n \!\[CDATA\[]] \\n \\n \!\[CDATA\[]] \\n \\\n \\\n \\n \VAST-4.0-Short-Intro.mp4\\n \\n \\n \VAST-4.0-Short-Intro.mp4\\n \\n \\\n \\n \!\[CDATA\[]] \\n \!\[CDATA\[]] \\n \\n \\n \!\[CDATA\[]] \\n \\\n \\n \\n \\n \\n \\n \\n\" | | `ads.companionProducts` | Détails sur les produits associés. |

“companionProducts”: \[
"Banana14-simfk15"
"Oranges5-qgxeb6",
"Incaberries20-ppscn21"

| | `metadata.warnings` | Objet contenant des avertissements concernant la demande de publicité. N'avertit actuellement que si le nombre maximal de segments est dépassé. | `"metadata": {
"warnings": [
"Audience Segment IDs exceeded the limit of {maxSegmentIds} and were truncated"
]
}` | {% hint style="info" %} Si un champ n'est pas configuré dans le cadre de la campagne de la publicité, il ne sera pas diffusé. C'est-à-dire que si l'annonceur n'a pas configuré un `heroImage`, Epsilon Retail Media ne diffusera pas la `heroImage` propriété. {% endhint %} --- # 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/integration/fr/references/banner-x-reference-1.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.