A continuación se describen las propiedades posibles en una solicitud estándar y la respuesta si recibe un anuncio.
Artículos solicitados
| Cadena | Descripción | Obligatorio/opcional |
|---|---|---|
catalogId | El identificador de su catálogo de productos para su sitio web. | Obligatorio |
customerId | El identificador único para el cliente que recibe anuncios. | Opcional |
filterMode | Método opcional para definir la estructura de su solicitud. Consulte Filtrado de generación de anuncios para obtener más información. | Opcional, preferente |
maxNumberOfAds | El número máximo de anuncios que le gustaría que se devolvieran hasta 15. | Obligatorio |
options | Método opcional para definir la estructura de su solicitud. Consulte Filtrado de generación de anuncios para obtener más información. | Opcional, preferente |
placement | La ubicación única para la que solicita anuncios. | Obligatorio |
productFilters | Cualquier filtro de producto relevante para su solicitud, como categoría, ubicación o tamaño. | Obligatorio |
sessionId | El identificador único de la sesión del cliente. Se usa para la atribución en integraciones estándar. Revise las opciones de flujo de trabajo de integración para obtener más información. | Obligatorio en integraciones estándar |
memoryToken | Usado para paginación. Use el token proporcionado en una solicitud de anuncios anterior para garantizar que CitrusAd solo envíe nuevos anuncios a sus clientes. Si se indica, CitrusAd excluirá los anuncios previamente proporcionados en la respuesta del anuncio. Revise Paginación para obtener más información. | Opcional |
Artículos devueltos
| Cadena | Descripción | Valor de ejemplo |
|---|---|---|
customPayload | Esta carga personalizada debe enrutarse desde el archivo de catálogo hasta la generación de anuncios. El campo debe contener un objeto JSON válido serializado en una matriz de bytes y codificado en Base64. El objeto JSON debe ajustarse a un esquema. | Personalizado por integración |
sellerId | El identificador único del vendedor. Solo se completará si se establece un sellerId en un equipo. Los SellerIds suelen usarse al incorporar vendedores del mercado. | 73nns-32sxr-32ss Personalizado por integración |
id | El identificador único del anuncio. Esta es única para cada solicitud realizada a CitrusAd y no se puede almacenar en caché. | display_yCaCIy_kKaJnRnzrenBkVSytwr8yNTgxMzM4 |
gtin | El código de producto del anuncio. Este será el código de producto sincronizado en su catálogo de productos. | 25813383 |
discount | El valor anterior se puede ignorar. | { "amount": 0, "minPrice": 0, "maxPerCustomer": 0 } |
position | La posición del anuncio en la respuesta de CitrusAd. Debe respetar esta posición en caso de que se utilicen campañas de tenencia fija. | 1 |
memoryToken | Se utiliza para la paginación y el encadenamiento de solicitudes de anuncios. Si se indica en su siguiente solicitud de anuncio para el mismo contexto, CitrusAd excluirá los anuncios previamente proporcionados en la respuesta del anuncio. Revise Paginación para obtener más información. |