Référence des bannières X

The below outlines the properties possible in a standard request as outlined in Requesting ads for your request, and the response if you receive an ad.

Éléments liés à la requête

ChaîneDescriptionObligatoire/facultatif
BannerSlotIdsUn tableau JSON des slotIds de bannière associés à la requête.Obligatoire
catalogIdL'identifiant de votre catalogue de produits pour votre site Web.Obligatoire
contentStandardIdL'identifiant standard du contenu de votre site Web.Obligatoire
customerIdL'identifiant unique du client recevant les annonces.Facultatif
filterModeOptional way of defining the structure of your request. See Ad generation filtering for more information.Facultatif, préféré
maxNumberOfAdsLe nombre maximum d'espaces de bannière que vous souhaitez voir renvoyés.Obligatoire
options

Optional way of defining the structure of your request. See Ad generation filtering for more information.

This is also the object where you can request advertiser information in order to comply with local advertising legislation like Europe’s Digital Services Act .

Facultatif, préféré
placementL'emplacement unique lié à votre requête d'annonces.Obligatoire
productFiltersTous les filtres de produits associés à votre requête, comme une catégorie, un emplacement ou une taille.Obligatoire pour les emplacements de catégorie
searchTermLe terme de recherche saisi par votre client sur votre site Web.Obligatoire pour les emplacements de recherche
sessionIdThe unique identifier of the customer's session. Used for attribution in standard integrations. Review Integration workflow optionsfor more information.Obligatoire dans le cas d'intégrations standard
slotIdCelui-ci contient tout SlotId requis dans le contexte. Il peut y en avoir un ou plusieurs.Obligatoire
dtmCookieIdCookies créés et stockés par le site Web, utilisés pour suivre le comportement de l’utilisateur sur le même domaine.Facultatif
audienceSpecifies specific audience segments that the shopper belongs to. Only relevant is using Audience Targeting Option 3Facultatif

Éléments renvoyés

ChaîneDescriptionExemple de valeur
ads.backgroundColourLa couleur d'arrière-plan de la bannière. Seules les valeurs HEX sont autorisées.6e6c6c
ads.backgroundImageLe lien de l'image d'arrière-plan de la bannière.[<https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3>](https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3`)
ads.backgroundImagePositionCela définit le type de position de l'image d'arrière-plan. Si non renseigné, vous devez utiliser la valeur par défaut (leftaligned).leftaligned
rightaligned
fill
repeating
ads.bannerTextLe texte affiché dans la bannière. Il peut inclure des balises HTML.<strong>Double Fudge Ice Cream</strong>
ads.bannerTextColourCouleur du texte de la bannière : valeurs HEX uniquement. Citrus n'envoie pas le #.1dc711
ads.citrusAdIdL'identifiant unique de l'annonce.
Il est propre à chaque requête adressée à Epsilon Retail Media et ne peut pas être mis en cache.
shotgun_wIpZraEXcIu0daC5YMQewPil2S83NzE0MTA3
ads.citrusCampaignNameLe nom de campagne de l'annonce.Epsilon-Example-Category-Banner-X-Ad-ae536b0d5c3ded28ea624ab4285facd6
ads.citrusContentStandardIdL'identifiant standard de contenu lié à l'espace.8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c
ads.citrusExpiryLe délai d'expiration de l'annonce. C'est le dernier moment où un clic peut être signalé à Epsilon Retail Media2021-06-01T23:48:16.573967987Z
ads.citrusSlotIdL'ID de l'espace spécifique de la bannière associé à votre requête.Category_Top
ads.contentStandardIdL'identifiant standard de contenu lié à l'espace. Duplicata de citrusContentStandardId8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c
ads.ctaFlagIl permet de définir l'affichage ou non d'un appel à l'action.true
false
ads.ctaLinkL'URL transférée depuis l'appel à l'action (similaire à linkUrl pour les bannières). Uniquement transférée si ctaFlag l'est aussi true<https://www.retailer.com/groceries/en-GB/search?query=double-fudge>
ads.ctaTextLe texte d'appel à l'action.Shop now
ads.ctaTextAccessibilityLe texte d'accessibilité de l'appel à l'action pour les utilisateurs ayant recours à un lecteur d'écran.for Double Fudge Ice Cream
ads.gtins

Un tableau contenant un maximum de 20 codes produit sélectionnés parmi les produits présentés dans une campagne.

Les détaillants peuvent utiliser cette liste pour automatiser l'ouverture des pages des annonceurs lorsqu'un utilisateur clique sur la bannière, ou pour automatiser certaines fonctionnalités de rendu (réductions, prix, vérification du stock secondaire).

[ "7714107", "7163379", "7733636", "7733657", "7733628" ],
ads.headingTextTexte d'en-tête pour les utilisateurs de lecteur d'écran.Banner Advertisement for Fudge Double Ice Cream with a product image and shop now button
ads.heroImageAltTextLe texte alternatif pour l'image Hero dans les rares cas où elle ne s'afficherait pas.Image of double fudge iced cream
ads.heroImageLe lien de l'image Hero de la bannière.[<https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3>](https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3`)
ads.positionLa position de la bannière dans la réponse d'Epsilon Retail Media. Vous devez respecter cette position dans le cas où des campagnes de location fixe sont utilisées.1
ads.secondaryBackgroundImageLe lien de l'image d'arrière-plan secondaire.[<https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3>](https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3`)
ads.secondaryBackgroundImagePositionCela définit le type de position de l'image d'arrière-plan secondaire.leftaligned
rightaligned
ads.secondaryHeroImageAltTextLe texte alternatif pour l'image Hero secondaire dans les rares cas où elle ne s'afficherait pas.Image of [brand] logo
ads.secondaryHeroImageLe lien de l'image Hero secondaire.[<https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3>](https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3`)
ads.secondaryHeroModeCela définit le mode d'affichage de l'image Hero secondaire. Si non renseigné, vous devez utiliser la valeur par défaut (block).block
landscape
ads.slotIdL'ID de l'espace de la bannière associé à votre requête. En cas de requête de plusieurs bannières, cet ID peut être utilisé pour référencer les identifiants requis.Category_Top
ads.tagsCe champ renvoie toutes les balises tierces saisies par l'annonceur dans sa campagne. Il n'est actuellement pas pris en charge par les bannières X, bien que la réponse de l'API soit formatée.{}
ads.sellerIdID unique du vendeur. S'affichera uniquement si un sellerId est défini pour une équipe. Les sellerId sont généralement utilisés pour l'onboarding des vendeurs Marketplace.73nns-32sxr-32ss Personnalisation par intégration
ads.metadata

Object containing the advertiser info required to help advertisers comply with local advertising legislation such as the Digital Services Act in Europe.

advertiser est issu du Nom de l'entreprise dans l'équipe de fournisseurs.

onBehalfOf est issu du Financeur de l'annonce dans l'équipe de fournisseurs.

"metadata": { "advertiserInfo": { "advertiser": "Bob's advertising agency", "onBehalfOf": "Brand company inc" } ...
ads.admObjet contenant les détails de l'annonce vidéo, y compris les balises VAST."\n<VAST version="4.0">\n <Ad id="1">\n \n \n"
ads.companionProductsDétails des produits complémentaires.“companionProducts”: [
"Banana14-simfk15"
"Oranges5-qgxeb6",
"Incaberries20-ppscn21"
metadata.warningsObjet contenant des informations d'avertissement relatives à la demande d'annonce. Actuellement, avertit uniquement si le nombre maximal de segments est dépassé. "metadata": { "warnings": [ "Audience Segment IDs exceeded the limit of {maxSegmentIds} and were truncated" ] }
📘

Si un champ n'est pas configuré dans le cadre de la campagne de l'annonce, il ne sera pas diffusé. Par exemple, si l'annonceur n'a pas configuré de heroImage, Epsilon Retail Media ne diffusera pas la propriété heroImage.