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. Il vous faudra effectuer trois appels API. Un pour les annonces de produits, un autre pour votre bannière publicitaire X, et enfin un pour le contenu statique.

Annonce de produit – É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, un emplacement par exemple. Doit en outre inclure votre filtre de page de marque de `brandpage:<VALUE>` La valeur correspond au suffixe unique de l'URL de la page de marque. Si une page de marque est définie pour le suffixe, CitrusAd enverra le contenu dans la charge utile.	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

Annonce de produit – É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
`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

Bannière X – Éléments liés à la requête

Chaîne	Description	Obligatoire/facultatif
`bannerSlotIds`	Un tableau JSON des slotIds de bannière associés à la requête.	Obligatoire
`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'espaces de bannière que vous souhaitez voir renvoyés.	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, un emplacement par exemple. Doit en outre inclure votre filtre de page de marque de `brandpage:<VALUE>` La valeur correspond au suffixe unique de l'URL de la page de marque. Si une page de marque est définie pour le suffixe, CitrusAd enverra le contenu dans la charge utile.	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
`slotId`	Celui-ci contient tout SlotId requis dans le contexte. Il peut y en avoir un ou plusieurs.	Obligatoire

Bannière X – Éléments renvoyés

Chaîne	Description	Exemple de valeur
`backgroundColour`	La couleur d'arrière-plan de la bannière. Seules les valeurs HEX sont autorisées.	`6e6c6c`
`backgroundImage`	Le lien de l'image d'arrière-plan de la bannière.	`https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3`
`backgroundImagePosition`	Cela définit le type de position de l'image d'arrière-plan. Si non renseigné, vous devez utiliser la valeur par défaut, qui est `leftaligned` .	`leftaligned` `rightaligned` `fill` `repeating`
`bannerText`	Le texte affiché dans la bannière. Il peut inclure des balises HTML.	`<strong>Double Fudge Ice Cream</strong>`
`bannerTextColour`	Couleur du texte de la bannière : valeurs HEX uniquement. Citrus n'envoie pas le `#`.	`1dc711`
`citrusAdId`	L'identifiant unique de l'annonce. Il est propre à chaque requête adressée à CitrusAd et ne peut pas être mis en cache.	`shotgun_wIpZraEXcIu0daC5YMQewPil2S83NzE0MTA3`
`citrusCampaignName`	Le nom de campagne de l'annonce.	`CitrusAd-Example-Category-Banner-X-Ad-ae536b0d5c3ded28ea624ab4285facd6`
`citrusContentStandardId`	L'identifiant standard de contenu lié à l'espace.	`8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c`
`citrusExpiry`	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`
`citrusSlotId`	L'ID de l'espace spécifique de la bannière associé à votre requête.	`Category_Top`
`contentStandardId`	L'identifiant standard de contenu lié à l'espace. Duplicata de `citrusContentStandardId`	`8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c`
`ctaFlag`	Il permet de définir l'affichage ou non d'un appel à l'action.	`true` `false`
`ctaLink`	L'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`
`ctaText`	Le texte d'appel à l'action.	`Shop now`
`ctaTextAccessibility	Le texte d'accessibilité de l'appel à l'action pour les utilisateurs ayant recours à un lecteur d'écran.	`for Double Fudge Ice Cream`
`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).	`"gtins": [ "7714107", "7163379", "7733636", "7733657", "7733628" ],`
`headingText`	Texte 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`
`heroImageAltText`	Le texte alternatif pour l'image Hero dans les rares cas où elle ne s'afficherait pas.	`Image of double fudge iced cream`
`heroImage`	Le lien de l'image Hero de la bannière.	`https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3`
`position`	La position de la bannière dans la réponse CitrusAd. Vous devez respecter cette position dans le cas où des campagnes de location fixe sont utilisées.	1
`secondaryBackgroundImage`	Le lien de l'image d'arrière-plan secondaire.	`https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3`
`secondaryBackgroundImagePosition`	Cela définit le type de position de l'image d'arrière-plan secondaire.	`leftaligned` `rightaligned`
`secondaryHeroImageAltText`	Le texte alternatif pour l'image Hero secondaire dans les rares cas où elle ne s'afficherait pas.	`Image of [brand] logo`
`secondaryHeroImage`	Le lien de l'image Hero secondaire.	`https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3`
`secondaryHeroMode`	Cela définit le mode d'affichage de l'image Hero secondaire. Si non renseigné, vous devez utiliser la valeur par défaut, qui est `block` .	`block` `landscape`
`slotId`	L'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`
`tags`	Ce 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.	`{}`

Éléments demandés sur la page de marque

Chaîne	Description	Obligatoire/facultatif
`catalogId`	L'identifiant de votre catalogue de produits pour votre site Web.	Obligatoire
`placement`	L'emplacement unique lié à votre requête d'annonces.	Obligatoire
`brandPageId`	L'ID unique de la page de marque. La valeur correspond au suffixe unique de l'URL de la page de marque.	Obligatoire.

Annonce de produit – Éléments renvoyés

Chaîne	Description	Exemple de valeur
`pageContentText`	Contenu de la page saisi par l'annonceur. Généralement un paragraphe ou deux qui mettent en avant le contenu de la page de marque.	Milk Choc Chunk ravira les amateurs de cookies, avec des gaufrettes croustillantes enrobées de chocolat blanc et agrémentées de morceaux de cookies sur une base de chocolat au lait. Disponible en barre de 170 g et de 45 g.
`pageHeaderText`	Titre de la page de marque	Nouveaux cookies au chocolat

📘
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, CitrusAd ne diffusera pas la propriété heroImage .