API para socios

Filtrado de generación de anuncios

Cuando solicite anuncios, debe intentar dar soporte al filtrado de sus clientes por marca, categoría, restricciones dietéticas, etc. Si su sitio de comercio electrónico admite el filtrado que utiliza la funcionalidad y/o, CitrusAd puede admitirlo con el parámetro adicional filterMode en su solicitud.

Hay dos tipos de filtrado, como se describe a continuación.

andOr filtrado (recomendado)

andOr el filtrado es útil para contextos en los que el usuario ha aplicado un filtro profundo a su búsqueda. Permite un formato de contexto más sencillo, al mismo tiempo que admite un filtrado profundo. Este método sigue la estructura descrita a continuación: Permite un formato de contexto más sencillo, al mismo tiempo que admite un filtrado profundo. Este método sigue la estructura descrita a continuación:

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

Una solicitud de ejemplo tiene el siguiente aspecto:

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
}

Este enfoque suele ser más fácil para los minoristas a la hora de encadenar las solicitudes por tipo cuando los clientes aplican filtros profundos a sus búsquedas.

🚧

Debe especificar el filterMode de andOr para que esta funcionalidad se ejecute correctamente.

orAnd filtrado (modo predeterminado)

El método predeterminado para filtros de producto sigue la estructura que se describe a continuación:

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

El mismo ejemplo presentado anteriormente se enviaría como una solicitud similar a la siguiente:

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
}

📘

No es necesario especificar un filterMode de orAnd para esta funcionalidad, ya que es el comportamiento predeterminado.