The below outlines the properties possible in a standard request as outlined in Requesting ads for your request, and the response if you receive an ad.
Artículos solicitados
| Cadena | Descripción | Obligatorio/opcional |
|---|---|---|
BannerSlotIds | Una matriz JSON de las slotIDs de banner que se solicitan. | Obligatorio |
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 | Optional way of defining the structure of your request. See Ad generation filtering for more information. | Opcional, preferente |
maxNumberOfAds | El número máximo de cada posición de banner que desea devolver. | Obligatorio |
options | Optional way of defining the structure of your request. See Ad generation filtering for more information. This is also the object where you can request advertiser information in order to comply with local advertising legislation like Europe’s Digital Services Act . | Opcional, preferente |
placement | La ubicación única para la que solicita anuncios. | Obligatorio |
productFilters | Cualquier filtro de producto relevante para su solicitud, como filtro de categoría, ubicación o tamaño. | Obligatorio para ubicaciones de categoría |
searchTerm | El término de búsqueda introducido por su cliente en su sitio web. | Obligatorio para ubicaciones de búsqueda |
sessionId | The unique identifier of the customer's session. Used for attribution in standard integrations. Review Integration workflow optionsfor more information. | Obligatorio en integraciones estándar |
slotId | Contiene cualquier slotID solicitada en el contexto. Puede haber una o varias. | Obligatorio |
dtmCookieId | Cookies creadas y almacenadas por el sitio web, utilizadas para rastrear el comportamiento de los usuarios en el mismo dominio. | Opcional |
audience | Specifies specific audience segments that the shopper belongs to. Only relevant is using Audience Targeting Option 3 | Opcional |
Artículos devueltos
| Cadena | Descripción | Valor de ejemplo |
|---|---|---|
ads.backgroundColour | El color de fondo del banner: solo valores HEX. | 6e6c6c |
ads.backgroundImage | El 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`) |
ads.backgroundImagePosition | Aquí se define el tipo de posición de la imagen de fondo. Si no hay ningún valor, deberá indicar por defecto leftaligned . | leftalignedrightalignedfillrepeating |
ads.bannerText | El texto que se muestra en el banner. Puede incluir etiquetas HTML. | <strong>Double Fudge Ice Cream</strong> |
ads.bannerTextColour | El color del texto del encabezado (solo valores HEX). Citrus no envía el #. | 1dc711 |
ads.citrusAdId | La ID única del anuncio. Es única para cada solicitud realizada a Epsilon Retail Media y no se puede almacenar en caché. | shotgun_wIpZraEXcIu0daC5YMQewPil2S83NzE0MTA3 |
ads.citrusCampaignName | El nombre de la campaña del anuncio. | Epsilon-Example-Category-Banner-X-Ad-ae536b0d5c3ded28ea624ab4285facd6 |
ads.citrusContentStandardId | La ID de contenido estándar relacionada con la posición. | 8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c |
ads.citrusExpiry | El vencimiento del anuncio. Este es el último punto en el que se puede informar de un clic a Epsilon Retail Media. | 2021-06-01T23:48:16.573967987Z |
ads.citrusSlotId | La ID de la posición específica para el banner que ha solicitado. | Category_Top |
ads.contentStandardId | La ID de contenido estándar relacionada con la posición. Duplicado de citrusContentStandardId | 8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c |
ads.ctaFlag | Esto define si una CTA se muestra o no. | truefalse |
ads.ctaLink | La 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> |
ads.ctaText | El texto dentro de la CTA. | Shop now |
ads.ctaTextAccessibility | El texto de accesibilidad de la CTA para usuarios de lectores de pantalla. | for Double Fudge Ice Cream |
ads.gtins | Una 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 cuando se hace clic en el banner o automatizar ciertas funcionalidades de renderizado (redondeles, precios, comprobación secundaria del nivel de existencias). | [ "7714107", "7163379", "7733636", "7733657", "7733628" ], |
ads.headingText | Texto de encabezado para lector de pantalla. | Banner Advertisement for Fudge Double Ice Cream with a product image and shop now button |
ads.heroImageAltText | Texto alternativo para la imagen principal en el raro caso de que no se muestre. | Image of double fudge iced cream |
ads.heroImage | El 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`) |
ads.position | La posición del banner en la respuesta de Epsilon Retail Media. Debe respetar esta posición en caso de que se utilicen campañas de posición fija. | 1 |
ads.secondaryBackgroundImage | El 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`) |
ads.secondaryBackgroundImagePosition | Aquí se define el tipo de posición de la imagen de fondo secundaria. | leftalignedrightaligned |
ads.secondaryHeroImageAltText | El texto alternativo para la imagen principal secundaria en el raro caso de que no se muestre. | Image of [brand] logo |
ads.secondaryHeroImage | El 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`) |
ads.secondaryHeroMode | Aquí se define el modo de visualización de la imagen destacada secundaria. Si no hay ningún valor, deberá indicar por defecto block . | blocklandscape |
ads.slotId | La 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 |
ads.tags | Este 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. | {} |
ads.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 |
ads.metadata | Object containing the advertiser info required to help advertisers comply with local advertising legislation such as the Digital Services Act in Europe.
| "metadata": { "advertiserInfo": { "advertiser": "Bob's advertising agency", "onBehalfOf": "Brand company inc" } ... |
ads.adm | Objeto que contiene los detalles del anuncio de vídeo, incluidas las etiquetas VAST. | "\n<VAST version="4.0">\n <Ad id="1">\n \n \n" |
ads.companionProducts | Detalles del producto complementario. | “companionProducts”: [ "Banana14-simfk15" "Oranges5-qgxeb6", "Incaberries20-ppscn21" |
metadata.warnings | Objeto que contiene información de advertencia sobre la solicitud de anuncio. Actualmente solo avisa si se supera el número máximo de segmentos. | "metadata": { "warnings": [ "Audience Segment IDs exceeded the limit of {maxSegmentIds} and were truncated" ] } |
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 una
heroImage, Epsilon Retail Media no mostrará la propiedadheroImage.

