API partenaire

Filtrer la génération d'annonces

Lorsque vous émettez des requêtes d'annonces, votre objectif est la prise en charge du filtrage de vos clients par marques, catégories, restrictions alimentaires, etc. Si votre site d'e-commerce prend en charge le filtrage avec la fonctionnalité and/or (et/ou), CitrusAd peut également le prendre en charge grâce au paramètre filterMode supplémentaire dans votre requête.

Il existe deux types de filtrage, comme indiqué ci-dessous.

andOr Filtrage (recommandé)

andOr Le filtrage est utile lorsque l'utilisateur a grandement filtré sa recherche. Cela simplifie le formatage du contexte tout en assurant un filtrage en profondeur. Cette méthode suit la structure décrite ci-dessous :

"productFilters": [
     [ "" OR "" ] AND [ "" OR "" ] AND [ "" OR "" ] 
    ],
    "options": {
     "filterMode": "AndOr"
    },

Voici un exemple de requête :

POST $BASE_URL/v1/ads/generate HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>
{
    "customerId": "wertg5432a",
    "sessionId": "ec9-4e07-881d-3e9", 
    "placement": "category",
    "catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
    "productFilters": [
     	 ["category:bread"],
    	 ["brand:brandA","brand:brandB"],
    	 ["price:below $10"],
    	 ["nutrition:organic","nutrition:vegan"]
    ],
    "options": {
   							 "filterMode": "AndOr"
 							 },
    "maxNumberOfAds": 3
}

Cette approche facilite généralement le chaînage des demandes par type pour les détaillants lorsque les clients filtrent grandement leurs recherches.

🚧

Vous devez spécifier le filterMode de andOr pour que cette option fonctionne correctement.

orAnd Filtrage (mode par défaut)

La méthode de filtrage de génération d'annonces par défaut suit la structure suivante :

"productFilters": [
     [ "" AND "" ], OR [ "" AND "" ], OR [ "" AND "" ] 
    ],
    "options": {
     "filterMode": "OrAnd"
    },

Le même exemple présenté ci-dessus peut être envoyé sous forme de requête ainsi :

POST $BASE_URL/v1/ads/generate HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>
{
    "customerId": "wertg5432a",
    "sessionId": "ec9-4e07-881d-3e9", 
    "placement": "category",
    "catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
    "productFilters": [
     	 ["category:bread","brand:brandA","price:below $10","nutrition:organic"],
     	 ["category:bread","brand:brandB","price:below $10","nutrition:organic"],
     	 ["category:bread","brand:brandA","price:below $10","nutrition:vegan"],
     	 ["category:bread","brand:brandB","price:below $10","nutrition:vegan"],       
    ],
    "options": {
   							 "filterMode": "OrAnd"
 							 },
    "maxNumberOfAds": 3
}

📘

Vous n'avez pas besoin de spécifier un filterMode de orAnd pour cette fonctionnalité, car il s'agit du comportement par défaut.