Referencia de banner x

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.

Artículos solicitados

CadenaDescripciónObligatorio/opcional
BannerSlotIdsUna matriz JSON de las slotIDs de banner que se solicitan.Obligatorio
catalogIdEl identificador de su catálogo de productos para su sitio web.Obligatorio
contentStandardIdEl identificador estándar de contenido para su sitio web.Obligatorio
customerIdEl identificador único para el cliente que recibe anuncios.Opcional
filterModeMétodo opcional para definir la estructura de su solicitud. Consulte Filtrado de generación de anuncios para obtener más información.Opcional, preferente
maxNumberOfAdsEl número máximo de cada posición de banner que desea devolver.Obligatorio
optionsMétodo opcional para definir la estructura de su solicitud. Consulte Filtrado de generación de anuncios para obtener más información.Opcional, preferente
placementLa ubicación única para la que solicita anuncios.Obligatorio
productFiltersCualquier filtro de producto relevante para su solicitud, como filtro de categoría, ubicación o tamaño.Obligatorio para ubicaciones de categoría
searchTermEl término de búsqueda introducido por su cliente en su sitio web.Obligatorio para ubicaciones de búsqueda
sessionIdEl 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
slotIdContiene cualquier slotID solicitada en el contexto. Puede haber una o varias.Obligatorio

Artículos devueltos

CadenaDescripciónValor de ejemplo
backgroundColourEl color de fondo del banner: solo valores HEX.6e6c6c
backgroundImageEl enlace a la imagen de fondo del banner.[<https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3>](https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3`)
backgroundImagePositionAquí se define el tipo de posición de la imagen de fondo. Si no hay ningún valor, deberá indicar por defecto leftaligned .leftaligned
rightaligned
fill
repeating
bannerTextEl texto que se muestra en el banner. Puede incluir etiquetas HTML.<strong>Double Fudge Ice Cream</strong>
bannerTextColourEl color del texto del encabezado (solo valores HEX). Citrus no envía el #.1dc711
citrusAdIdEl identificador único del anuncio.
Esta es única para cada solicitud realizada a CitrusAd y no se puede almacenar en caché.
shotgun_wIpZraEXcIu0daC5YMQewPil2S83NzE0MTA3
citrusCampaignNameEl nombre de la campaña del anuncio.CitrusAd-Example-Category-Banner-X-Ad-ae536b0d5c3ded28ea624ab4285facd6
citrusContentStandardIdLa ID de contenido estándar relacionada con la posición.8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c
citrusExpiryEl 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
citrusSlotIdLa ID de la posición específica para el banner que ha solicitado.Category_Top
contentStandardIdLa ID de contenido estándar relacionada con la posición. Duplicado de citrusContentStandardId8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c
ctaFlagEsto define si una CTA se muestra o no.true
false
ctaLinkLa URL reenviada desde la CTA (es como una linkUrl para banners). Solo se muestra si ctaFlag es true<https://www.retailer.com/groceries/en-GB/search?query=double-fudge>
ctaTextEl texto dentro de la CTA.Shop now
ctaTextAccessibilityEl texto de accesibilidad de la CTA para usuarios de lectores de pantalla.for Double Fudge Ice Cream
gtinsUna serie de hasta 20 códigos de producto seleccionados de los productos anunciados de la campaña.

Los minoristas pueden utilizar esta lista para automatizar las páginas del creador de listas al hacer clic en el banner o automatizar ciertas funcionalidades de renderizado (etiquetas, precios, comprobación secundaria del nivel de existencias).
[ "7714107", "7163379", "7733636", "7733657", "7733628" ],
headingTextTexto de encabezado para lector de pantalla.Banner Advertisement for Fudge Double Ice Cream with a product image and shop now button
heroImageAltTextTexto alternativo para la imagen principal en el raro caso de que no se muestre.Image of double fudge iced cream
heroImageEl enlace a la imagen principal del banner.[<https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3>](https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3`)
positionLa posición del banner en la respuesta de CitrusAd. Debe respetar esta posición en caso de que se utilicen campañas de tenencia fija.1
secondaryBackgroundImageEl enlace a la imagen de fondo secundaria.[<https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3>](https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3`)
secondaryBackgroundImagePositionAquí se define el tipo de posición de la imagen de fondo secundaria.leftaligned
rightaligned
secondaryHeroImageAltTextEl texto alternativo para la imagen principal secundaria en el raro caso de que no se muestre.Image of [brand] logo
secondaryHeroImageEl enlace a la imagen principal secundaria.[<https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3>](https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3`)
secondaryHeroModeAquí se define el modo de visualización de la imagen destacada secundaria. Si no hay ningún valor, deberá indicar por defecto block .block
landscape
slotIdLa ID de posición del banner que ha solicitado. Cuando se solicitan varios banners, se pueden usar para hacer referencia a las ID solicitadas.Category_Top
tagsEste campo devuelve las etiquetas de terceros introducidas por el anunciante en su campaña. Actualmente, esto no es compatible con el banner x, aunque la respuesta de la API esté formateada.{}
sellerIdEl 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

📘

Si hay un campo no configurado como parte de la campaña del anuncio, no se mostrará. Es decir, si el anunciante no ha configurado un heroImage, CitrusAd no servirá la heroImage propiedad.