> For the complete documentation index, see [llms.txt](https://help.citrusad.com/retail-media-interface/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.citrusad.com/retail-media-interface/integration/es/references/banner-x-reference-1.md). # Referencia de banner X A continuación se describen las propiedades posibles en una solicitud estándar según se detalla en [Solicitud de anuncios](/retail-media-interface/integration/es/generating-ads/banner-x-responsive/requesting-banner-x-ads.md) para su solicitud, y la respuesta si recibe un anuncio. ## Elementos solicitados | String | Descripción | Obligatorio/opcional | | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | | `BannerSlotIds` | Un array JSON de los slotIds del espacio de banner que se están solicitando. | 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 del cliente al que se le sirven anuncios. | Opcional | | `filterMode` | Forma opcional de definir la estructura de su solicitud. Consulte [Filtrado de generación de anuncios](/retail-media-interface/integration/es/data-api/api-overview/ad-generation-filtering-1.md) para obtener más información. | Opcional, preferido | | `maxNumberOfAds` | El número máximo de cada espacio de banner que desea que se devuelva. | Obligatorio | | `options` |

Forma opcional de definir la estructura de su solicitud. Consulte Filtrado de generación de anuncios para obtener más información.

Este es también el objeto en el que puede solicitar información del anunciante para cumplir con la legislación publicitaria local como la de Europa Ley de Servicios Digitales .

| Opcional, preferido | | `placement` | La ubicación única para la que está solicitando anuncios. | Obligatorio | | `productFilters` | Cualquier filtro de producto relevante para su solicitud. Tal como un 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` | El identificador único de la sesión del cliente. Se utiliza para la atribución en integraciones estándar. Revise [Opciones del flujo de trabajo de integración](/retail-media-interface/integration/es/data-api/api-overview/integration-workflow-options-1.md)para obtener más información. | Obligatorio en integraciones estándar | | `slotId` | Esto contiene cualquier SlotId solicitado en el contexto. Puede haber uno o varios. | Obligatorio | | `dtmCookieId` | Cookies creadas y almacenadas por el sitio web, utilizadas para rastrear el comportamiento del usuario en el mismo dominio. | Opcional | | `audience` | Especifica segmentos de audiencia específicos a los que pertenece el comprador. Solo es relevante si se utiliza [Opción 3 de segmentación de audiencia](/retail-media-interface/integration/es/data-api/audience-targeting-new/integration-option-3-sync-audiences-only.md) | Opcional | ## Elementos devueltos | String | Descripción | Valor de ejemplo | | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ads.backgroundColour` | El color de fondo del banner: solo valores HEX. | `6e6c6c` | | `ads.backgroundImage` | El enlace de la imagen de fondo del banner. | `[]\() | | `ads.backgroundImagePosition` | Esto define el tipo de posición de la imagen de fondo. Si no hay ningún valor, deberá predeterminar a `leftaligned` . |

leftaligned
rightaligned
fill
repeating

| | `ads.bannerText` | El texto mostrado en el banner. Puede incluir etiquetas HTML | `Double Fudge Ice Cream` | | `ads.bannerTextColour` | El color del texto del banner: solo valores HEX. Citrus no envía el `#`. | `1dc711` | | `ads.citrusAdId` |

El id único del anuncio.
Esto es único 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` | El id estándar de contenido relacionado con el espacio. | `8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c` | | `ads.citrusExpiry` | El vencimiento del anuncio. Este es el último momento en el que se puede informar de un clic a Epsilon Retail Media | `2021-06-01T23:48:16.573967987Z` | | `ads.citrusSlotId` | El id del espacio específico para el banner que ha solicitado. | `Category_Top` | | `ads.contentStandardId` | El id estándar de contenido relacionado con el espacio. Duplicado de `citrusContentStandardId` | `8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c` | | `ads.ctaFlag` | Esto define si se muestra o no una CTA. |

true
false

| | `ads.ctaLink` | La URL reenviada desde la CTA (esto es como linkUrl para banners). Solo se sirve si ctaFlag es `true` | ` | | `ads.ctaText` | El texto dentro de la CTA. | `Shop now` | | `ads.ctaTextAccessibility` | Texto de accesibilidad de la CTA para usuarios de lectores de pantalla. | `for Double Fudge Ice Cream` | | `ads.gtins` |

Un array 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 de listados cuando se hace clic en el banner, o automatizar cierta funcionalidad de representación (distintivos, precios, verificación del nivel de stock secundario).

| `[
"7714107",
"7163379",
"7733636",
"7733657",
"7733628"
],` | | `ads.headingText` | Texto del encabezado para usuarios de lectores 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 de la imagen principal del banner. | `[]\() | | `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 Ubicación fija. | 1 | | `ads.secondaryBackgroundImage` | El enlace de la imagen de fondo secundaria. | `[]\() | | `ads.secondaryBackgroundImagePosition` | Esto define el tipo de posición de la imagen de fondo secundaria. |

leftaligned
rightaligned

| | `ads.secondaryHeroImageAltText` | Texto alternativo para la imagen principal secundaria en el raro caso de que no se muestre. | `Image of [brand] logo` | | `ads.secondaryHeroImage` | El enlace de la imagen principal secundaria. | `[]\() | | `ads.secondaryHeroMode` | Esto define el modo de visualización de la imagen principal secundaria. Si no hay ningún valor, deberá predeterminar a `block` . |

block
landscape

| | `ads.slotId` | El ID de espacio del banner que ha solicitado. Al solicitar varios banners, esto se puede utilizar para hacer referencia a los ID solicitados. | `Category_Top` | | `ads.tags` | Este campo devuelve cualquier etiqueta de terceros ingresada por el anunciante en su campaña. Actualmente esto no es algo admitido por banner x, aunque la respuesta de la API está formateada. | `{}` | | `ads.sellerId` | El Id único del vendedor. Solo se completará si se establece un sellerId en un equipo. Los sellerIds se utilizan normalmente al incorporar vendedores del marketplace. | `73nns-32sxr-32ss` Personalizado por integración | | `ads.metadata` |

Objeto que contiene la información del anunciante requerida para ayudar a los anunciantes a cumplir con la legislación publicitaria local como la Ley de Servicios Digitales en Europa.

advertiser se toma del Nombre de la empresa en el equipo del proveedor.

onBehalfOf se toma del Financiador del anuncio en el equipo del proveedor.

| `"metadata": {
"advertiserInfo": {
"advertiser": "Bob's advertising agency",
"onBehalfOf": "Brand company inc"
}
...` | | `ads.adm` | Objeto que contiene los detalles del anuncio de video, incluidas las etiquetas VAST. | "\n\\n \\n \\n \Epsilon Retail Media\\n \!\[CDATA\[]] \\n \\n \!\[CDATA\[]] \\n \\\n \\\n \\n \VAST-4.0-Short-Intro.mp4\\n \\n \\n \VAST-4.0-Short-Intro.mp4\\n \\n \\\n \\n \!\[CDATA\[]] \\n \!\[CDATA\[]] \\n \\n \\n \!\[CDATA\[]] \\n \\\n \\n \\n \\n \\n \\n \\n\" | | `ads.companionProducts` | Detalles de los productos complementarios. |

“companionProducts”: \[
"Banana14-simfk15"
"Oranges5-qgxeb6",
"Incaberries20-ppscn21"

| | `metadata.warnings` | Objeto que contiene información de advertencia sobre la solicitud de anuncio. Actualmente solo advierte si se supera el número máximo de segmentos. | `"metadata": {
"warnings": [
"Audience Segment IDs exceeded the limit of {maxSegmentIds} and were truncated"
]
}` | {% hint style="info" %} Si hay un campo que no está configurado como parte de la campaña del anuncio, no se servirá. Es decir, si el anunciante no ha configurado un `heroImage`, Epsilon Retail Media no servirá la `heroImage` propiedad. {% endhint %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://help.citrusad.com/retail-media-interface/integration/es/references/banner-x-reference-1.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.