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 | 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 que vous souhaitez renvoyer, dans la limite de 15. | Obligatoire |
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 |
memoryToken | Utilisé pour la pagination. Utilisez un jeton fourni dans une requête d'annonce précédente pour garantir que CitrusAd diffuse uniquement des nouvelles publicités à vos clients. Si c'est le cas, CitrusAd exclura les annonces précédemment diffusées dans la réponse publicitaire. Consultez Pagination pour en savoir plus. | Facultatif |
Éléments renvoyés
| Chaîne | Description | Exemple de valeur |
|---|---|---|
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 |
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 |
id | L'identifiant unique de l'annonce. Il est propre à chaque requête adressée à CitrusAd et ne peut pas être mis en cache. | display_yCaCIy_kKaJnRnzrenBkVSytwr8yNTgxMzM4 |
gtin | Le code produit de l'annonce. Il s'agit du code produit synchronisé dans votre catalogue de produits. | 25813383 |
discount | Obsolète, peut être ignoré. | { "amount": 0, "minPrice": 0, "maxPerCustomer": 0 } |
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 |
memoryToken | Utilisé pour la pagination et le chaînage des requêtes d'annonces. S'il est fourni lors de votre prochaine requête d'annonce pour le même contexte, CitrusAd exclura les annonces précédemment diffusées dans la réponse publicitaire. Consultez Pagination pour en savoir plus. |