A continuación se describen las propiedades posibles en una solicitud estándar, tal y como se describe en Solicitud de anuncios para su solicitud y la respuesta, si recibe un anuncio.
Los anuncios de banner se solicitan en el mismo endpoint
/generateque los anuncios de producto. Se puede usar una única solicitud para recuperar ambos tipos de anuncios.
Artículos solicitados
| Cadena | Descripción | Obligatorio/opcional |
|---|---|---|
bannerSlots | Una matriz de posiciones de banner para las que desea recibir anuncios publicitarios. Al especificar un MaxNumberOfAds para las posiciones de banner, puede recuperar más de un banner para la posición. Tal caso de uso sería para ubicaciones de carrusel. | Obligatorio |
bannerSlotIds | Una matriz de posiciones de banner para las que desea recibir anuncios publicitarios | Obligatorio, reemplazado por bannerSlots |
catalogId | El identificador de su catálogo de productos para su sitio web. | Obligatorio |
contentStandardId | El identificador estándar de contenido 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 de producto que le gustaría que se devolvieran hasta 15. | Obligatorio, permite que los anuncios de productos se muestren en la misma solicitud. Si no se desean anuncios de productos, fijar en 0 |
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 |
Artículos devueltos
| Cadena | Descripción | Valor de ejemplo |
|---|---|---|
altText | Texto alternativo para la imagen principal en el raro caso de que no se muestre. | Advertisement for <BRAND>. Art of the Burger. Create your delicious masterpiece. Shop Now. |
contentStandardId | El identificador estándar de contenido para su sitio web. | `4ffb80ba-b9a9-4567-8069-79b2eca93473 |
expiry | El vencimiento del anuncio. Este es el último punto en el que se puede informar de un clic a CitrusAd. | 2021-06-01T23:48:16.573967987Z |
id | El identificador único del anuncio. Esta es única para cada solicitud realizada a CitrusAd y no se puede almacenar en caché. | banner_j2vfi9pN2BiQZk4X9sC55PgNu5k3ODIzOTlfMDAwODc2ODQwMDEwNzM= |
imageUrl | El enlace de la imagen del banner. | [<https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3>](https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3`) |
gtins | Una serie de hasta 20 códigos de producto seleccionados de los productos anunciados de la campaña. | [ "7714107", "7163379", "7733636", "7733657", "7733628" ], |
linkUrl | La URL reenviada desde el banner cuando el cliente hace clic en el mismo. | <https://www.retailer.com/groceries/en-GB/search?query=double-fudge> |
slotId | La ID de la posición específica para el banner que ha solicitado. | Category_Top |
tags | Este campo devuelve las etiquetas de terceros introducidas por el anunciante en su campaña. | { "dv": "<script src=\"<https://cdn.doubleverify.com/dvtp_src.js?ctx=111111&cmp=11111111&sid=111111&plc=111111&adsrv=111&btreg=&btadsrv=&crt=&tagtype=&dvtagver=6.1.src\>" type=\"text/javascript\"></script>" } |
text | Se usa en integraciones personalizadas como un campo de texto adicional. | |
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 |
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 |