Le tableau ci-dessous décrit les propriétés possibles dans une requête standard, comme indiqué dans la section Requêtes d'annonces, ainsi que la réponse si vous recevez une annonce.
Les requêtes des bannières publicitaires sont effectuées sur le même point de terminaison
/generate
que les annonces de produits. Une seule requête peut être utilisée pour récupérer les deux types d'annonces.
Éléments liés à la requête
Chaîne | Description | Obligatoire/facultatif |
---|---|---|
bannerSlots | Un ensemble d'espaces de bannière pour lesquels vous souhaitez recevoir des bannières publicitaires. En précisant un MaxNumberOfAds pour les espaces de bannière, vous pouvez récupérer plusieurs bannières pour chaque espace. Ce cas concerne notamment les carrousels (diaporamas). | Obligatoire |
bannerSlotIds | Un ensemble d'espaces de bannière pour lesquels vous souhaitez recevoir des bannières publicitaires | Obligatoire, supplanté par bannerSlots |
catalogId | L'identifiant de votre catalogue de produits pour votre site Web. | Obligatoire |
contentStandardId | L'identifiant standard du contenu de votre site Web. | Obligatoire |
customerId | L'identifiant unique du client recevant les annonces. | Facultatif |
filterMode | Méthode facultative vous permettant de définir la structure de votre requête. Consultez la section Filtrer la génération d'annonces pour plus d'informations. | Facultatif, préféré |
maxNumberOfAds | Le nombre maximum d'annonces de produits que vous souhaitez renvoyer, dans la limite de 15. | Obligatoire, permet de diffuser des annonces de produits dans la même requête. Si vous ne souhaitez pas diffuser d'annonce de produit, définissez le paramètre sur 0 |
options | Méthode facultative vous permettant de définir la structure de votre requête. Consultez la section Filtrer la génération d'annonces pour plus d'informations. | 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 | L'identifiant unique de la session du client. Il est utilisé à des fins d'attribution dans les intégrations standard. Consultez la section Options de workflow d'intégration pour plus d'informations. | Obligatoire dans le cas d'intégrations standard |
Éléments renvoyés
Chaîne | Description | Exemple de valeur |
---|---|---|
altText | Le texte alternatif pour l'image Hero dans les rares cas où elle ne s'afficherait pas. | Advertisement for <BRAND>. Art of the Burger. Create your delicious masterpiece. Shop Now. |
contentStandardId | L'identifiant standard du contenu de votre site Web. | `4ffb80ba-b9a9-4567-8069-79b2eca93473 |
expiry | Le délai d'expiration de l'annonce. Il s'agit du dernier point lors duquel un clic peut être déclaré à CitrusAd. | 2021-06-01T23:48:16.573967987Z |
id | L'identifiant unique de l'annonce. Il est propre à chaque requête adressée à CitrusAd et ne peut pas être mis en cache. | banner_j2vfi9pN2BiQZk4X9sC55PgNu5k3ODIzOTlfMDAwODc2ODQwMDEwNzM= |
imageUrl | Le lien de l'image de la bannière. | [<https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3 >](https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3`) |
gtins | Un tableau contenant un maximum de 20 codes produit sélectionnés parmi les produits présentés dans une campagne. | [ "7714107", "7163379", "7733636", "7733657", "7733628" ], |
linkUrl | L'URL transférée depuis la bannière lorsque le client clique sur cette dernière. | <https://www.retailer.com/groceries/en-GB/search?query=double-fudge > |
slotId | L'ID de l'espace spécifique de la bannière associé à votre requête. | Category_Top |
tags | Ce champ renvoie toutes les balises tierces saisies par l'annonceur dans sa campagne. | { "dv": "<script src=\"<https://cdn.doubleverify.com/dvtp_src.js?ctx=111111&cmp=11111111&sid=111111&plc=111111&adsrv=111&btreg=&btadsrv=&crt=&tagtype=&dvtagver=6.1.src\>" type=\"text/javascript\"></script>" } |
text | Utilisé dans le cadre d'intégrations sur mesure, comme un champ de texte supplémentaire. | |
position | La position de l'annonce dans la réponse CitrusAd. Vous devez respecter cette position dans le cas où des campagnes de location fixe sont utilisées. | 1 |
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 |