Le tableau ci-dessous décrit les propriétés possibles dans une requête standard, ainsi que la réponse si vous recevez une annonce.
Éléments liés à la requête
| Chaîne | Description | Obligatoire/facultatif |
|---|---|---|
catalogId | L'identifiant de votre catalogue de produits pour votre site Web. | Obligatoire |
customerId | L'identifiant unique du client recevant les annonces. | Facultatif |
filterMode | Optional way of defining the structure of your request. See Ad generation filtering for more information. | Facultatif, préféré |
maxNumberOfAds | Le nombre maximum d'annonces que vous souhaitez renvoyer, dans la limite de 10. | 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é |
placement | L'emplacement unique lié à votre requête d'annonces. | Obligatoire |
productFilters | Tous les filtres de produits associés à votre requête, comme une catégorie, un emplacement ou une taille. | Obligatoire |
sessionId | The unique identifier of the customer's session. Used for attribution in standard integrations. Review Integration workflow options for more information. | Obligatoire dans le cas d'intégrations standard |
memoryToken | Used for pagination. Use a token provided in a previous ad request to ensure Epsilon Retail Media only serves new ads to your customers. If provided, Epsilon Retail Media will exclude previously served ads in the ad response. Review Pagination to learn more. | Facultatif |
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 | Specifies specific audience segments that the shopper belongs to. Only relevant is using Audience Targeting Option 3 | Facultatif |
Éléments renvoyés
| Chaîne | Description | Exemple de valeur |
|---|---|---|
ads.customPayload | Cette charge utile personnalisée doit être transférée du fichier catalogue à la génération d'annonces. Le champ doit contenir un objet JSON valide sérialisé dans un tableau d'octets et encodé en Base64. L'objet JSON doit être conforme à un schéma. | Personnalisation par intégration |
ads.sellerId | ID 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.id | L'identifiant unique de l'annonce. Il est propre à chaque requête adressée à Epsilon Retail Media et ne peut pas être mis en cache. | display_yCaCIy_kKaJnRnzrenBkVSytwr8yNTgxMzM4 |
ads.gtin | Le code produit de l'annonce. Il s'agit du code produit synchronisé dans votre catalogue de produits. | 25813383 |
ads.discount | Obsolète, peut être ignoré. | { "amount": 0, "minPrice": 0, "maxPerCustomer": 0 } |
ads.position | La position de l'annonce 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.memoryToken | Utilisé pour la pagination et le chaînage des requêtes d'annonces. If provided in your next ad request for the same context, Epsilon Retail Media will exclude previously served ads in the ad response. Review Pagination to learn more. | |
ads.metadata | Object containing the advertiser info required to help advertisers comply with local advertising legislation such as the Digital Services Actin Europe.
| "metadata": { "advertiserInfo": { "advertiser": "Bob's advertising agency", "onBehalfOf": "Brand company inc" } ... |
banners | Comprises of banner objects. View the Banner ad (static) reference to learn more. | "banners": [], |
metadata.warnings | Objet 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 100 and were truncated" ] |