A continuación se describen las propiedades posibles en una solicitud estándar tal como se describe en Solicitar anuncios. Tendrá que realizar tres llamadas API. Una para anuncios de productos, otra para su anuncio de banner x y, por último, otra para el contenido estático.

Elementos solicitados para el anuncio de producto

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 una ubicación. Además, debe incluir su filtro de página de marca de `brandpage:<VALUE>` El valor es el sufijo único de la URL de la página de la marca. Si hay una página de marca configurada para el sufijo, CitrusAd enviará contenido en la carga.	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 de anuncio de producto

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
`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

Artículos solicitados de banner x

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`	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 cada posición de banner que desea devolver.	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 una ubicación. Además, debe incluir su filtro de página de marca de `brandpage:<VALUE>` El valor es el sufijo único de la URL de la página de la marca. Si hay una página de marca configurada para el sufijo, CitrusAd enviará contenido en la carga.	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
`slotId`	Contiene cualquier slotID solicitada en el contexto. Puede haber una o varias.	Obligatorio

Artículos devueltos de banner x

Cadena	Descripción	Valor de ejemplo
`backgroundColour`	El color de fondo del banner: solo valores HEX.	`6e6c6c`
`backgroundImage`	El enlace a la imagen de fondo del banner.	`https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3`
`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` .	`leftaligned` `rightaligned` `fill` `repeating`
`bannerText`	El texto que se muestra en el banner. Puede incluir etiquetas HTML.	`<strong>Double Fudge Ice Cream</strong>`
`bannerTextColour`	El color del texto del encabezado (solo valores HEX). Citrus no envía el `#`.	`1dc711`
`citrusAdId`	El identificador único del anuncio. Esta es única para cada solicitud realizada a CitrusAd y no se puede almacenar en caché.	`shotgun_wIpZraEXcIu0daC5YMQewPil2S83NzE0MTA3`
`citrusCampaignName`	El nombre de la campaña del anuncio.	`CitrusAd-Example-Category-Banner-X-Ad-ae536b0d5c3ded28ea624ab4285facd6`
`citrusContentStandardId`	La ID de contenido estándar relacionada con la posición.	`8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c`
`citrusExpiry`	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`
`citrusSlotId`	La ID de la posición específica para el banner que ha solicitado.	`Category_Top`
`contentStandardId`	La ID de contenido estándar relacionada con la posición. Duplicado de `citrusContentStandardId`	`8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c`
`ctaFlag`	Esto define si una CTA se muestra o no.	`true` `false`
`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`
`ctaText`	El texto dentro de la CTA.	`Shop now`
`ctaTextAccessibility	El texto de accesibilidad de la CTA para usuarios de lectores de pantalla.	`for Double Fudge Ice Cream`
`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 al hacer clic en el banner o automatizar ciertas funcionalidades de renderizado (etiquetas, precios, comprobación secundaria del nivel de existencias).	`"gtins": [ "7714107", "7163379", "7733636", "7733657", "7733628" ],`
`headingText`	Texto de encabezado para lector de pantalla.	`Banner Advertisement for Fudge Double Ice Cream with a product image and shop now button`
`heroImageAltText`	Texto alternativo para la imagen principal en el raro caso de que no se muestre.	`Image of double fudge iced cream`
`heroImage`	El enlace a la imagen principal del banner.	`https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3`
`position`	La 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
`secondaryBackgroundImage`	El enlace a la imagen de fondo secundaria.	`https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3`
`secondaryBackgroundImagePosition`	Aquí se define el tipo de posición de la imagen de fondo secundaria.	`leftaligned` `rightaligned`
`secondaryHeroImageAltText`	El texto alternativo para la imagen principal secundaria en el raro caso de que no se muestre.	`Image of [brand] logo`
`secondaryHeroImage`	El enlace a la imagen principal secundaria.	`https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3`
`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` .	`block` `landscape`
`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`
`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.	`{}`

Elementos solicitados de la página de la marca

Cadena	Descripción	Obligatorio/opcional
`catalogId`	El identificador de su catálogo de productos para su sitio web.	Obligatorio
`placement`	La ubicación única para la que solicita anuncios.	Obligatorio
`brandPageId`	El identificador único de la página de la marca. El valor es el sufijo único de la URL de la página de la marca.	Obligatorio.

Artículos devueltos de anuncio de producto

Cadena	Descripción	Valor de ejemplo
`pageContentText`	Contenido de la página introducido por el anunciante. Por lo general, un párrafo o dos que resuma el contenido de la página de marca.	Milk Choc Chunk hará las delicias de los amantes de las galletas, con crujientes barquillos cubiertos de chocolate blanco, coronados con trozos de galleta sobre una base de chocolate con leche. Disponible en bloques de 170 g y en barritas de 45 g.
`pageHeaderText`	El encabezado de la página de la marca	Nuevas galletas de chocolate

📘
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.