> 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/pt-br/references/banner-x-reference-1.md). # Referência de banner X Abaixo descrevem-se as propriedades possíveis em uma requisição padrão conforme descrito em [Solicitando anúncios](/retail-media-interface/integration/pt-br/generating-ads/banner-x-responsive/requesting-banner-x-ads.md) para sua requisição, e a resposta se você receber um anúncio. ## Itens solicitados | String | Descrição | Obrigatório/opcional | | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | | `BannerSlotIds` | Um array json dos slotIds de espaço de banner que estão sendo solicitados. | Obrigatório | | `catalogId` | Seu identificador de catálogo de produtos para o seu site. | Obrigatório | | `contentStandardId` | O identificador padrão de conteúdo para o seu site. | Obrigatório | | `customerId` | O identificador exclusivo para o cliente que está recebendo os anúncios. | Opcional | | `filterMode` | Maneira opcional de definir a estrutura da sua requisição. Veja [Filtragem de geração de anúncios](/retail-media-interface/integration/pt-br/data-api/api-overview/ad-generation-filtering-1.md) para mais informações. | Opcional, preferencial | | `maxNumberOfAds` | O número máximo de cada espaço de banner que você gostaria que fosse retornado. | Obrigatório | | `options` |

Maneira opcional de definir a estrutura da sua requisição. Veja Filtragem de geração de anúncios para mais informações.

Este também é o objeto onde você pode solicitar informações do anunciante para cumprir a legislação de publicidade local, como a da Europa Lei de Serviços Digitais .

| Opcional, preferencial | | `placement` | O posicionamento exclusivo para o qual você está solicitando anúncios. | Obrigatório | | `productFilters` | Quaisquer filtros de produtos relevantes para a sua requisição. Como um filtro de categoria, localização ou tamanho. | Obrigatório para posicionamentos de categoria | | `searchTerm` | O termo de busca digitado pelo seu cliente no seu site. | Obrigatório para posicionamentos de busca | | `sessionId` | O identificador exclusivo da sessão do cliente. Usado para atribuição em integrações padrão. Revise [Opções de fluxo de trabalho de integração](/retail-media-interface/integration/pt-br/data-api/api-overview/integration-workflow-options-1.md)para mais informações. | Obrigatório em integrações padrão | | `slotId` | Isso contém qualquer SlotId solicitado no contexto. Pode haver um ou muitos. | Obrigatório | | `dtmCookieId` | Cookies criados e armazenados pelo site, usados para rastrear o comportamento do usuário no mesmo domínio. | Opcional | | `audience` | Especifica segmentos de público-alvo específicos aos quais o comprador pertence. Relevante apenas se estiver usando [Opção 3 de direcionamento de público-alvo](/retail-media-interface/integration/pt-br/data-api/audience-targeting-new/integration-option-3-sync-audiences-only.md) | Opcional | ## Itens retornados | String | Descrição | Exemplo de valor | | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ads.backgroundColour` | A cor de fundo do banner - apenas valores HEX. | `6e6c6c` | | `ads.backgroundImage` | O link da imagem de fundo do banner. | `[]\() | | `ads.backgroundImagePosition` | Isso define o tipo de posição da imagem de fundo. Se não houver valor, você precisará definir como padrão para `leftaligned` . |

leftaligned
rightaligned
fill
repeating

| | `ads.bannerText` | O texto exibido no banner. Pode incluir tags HTML | `Double Fudge Ice Cream` | | `ads.bannerTextColour` | A cor do texto do banner - apenas valores HEX. A Citrus não envia o `#`. | `1dc711` | | `ads.citrusAdId` |

O id exclusivo do anúncio.
Isso é exclusivo para cada requisição feita para Epsilon Retail Media e não pode ser armazenado em cache.

| `shotgun_wIpZraEXcIu0daC5YMQewPil2S83NzE0MTA3` | | `ads.citrusCampaignName` | O nome da campanha do anúncio. | `Epsilon-Example-Category-Banner-X-Ad-ae536b0d5c3ded28ea624ab4285facd6` | | `ads.citrusContentStandardId` | O id padrão de conteúdo relacionado ao espaço. | `8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c` | | `ads.citrusExpiry` | A expiração do anúncio. Este é o último momento em que um clique pode ser reportado para Epsilon Retail Media | `2021-06-01T23:48:16.573967987Z` | | `ads.citrusSlotId` | O id do espaço específico para o banner que você solicitou. | `Category_Top` | | `ads.contentStandardId` | O id padrão de conteúdo relacionado ao espaço. Duplicata de `citrusContentStandardId` | `8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c` | | `ads.ctaFlag` | Isso define se uma CTA é exibida ou não. |

true
false

| | `ads.ctaLink` | A url encaminhada a partir da CTA (isso é como linkUrl para banners). Servido apenas se ctaFlag for `true` | ` | | `ads.ctaText` | O texto dentro da CTA. | `Shop now` | | `ads.ctaTextAccessibility` | Texto de acessibilidade da CTA para usuários de leitores de tela. | `for Double Fudge Ice Cream` | | `ads.gtins` |

Um array de até 20 códigos de produtos selecionados a partir dos produtos anunciados da campanha.

Os varejistas podem usar esta lista para automatizar páginas de listagem quando o banner for clicado, ou automatizar certas funcionalidades de renderização (selos, precificação, verificação secundária de nível de estoque).

| `[
"7714107",
"7163379",
"7733636",
"7733657",
"7733628"
],` | | `ads.headingText` | Texto de cabeçalho para usuários de leitores de tela. | `Banner Advertisement for Fudge Double Ice Cream with a product image and shop now button` | | `ads.heroImageAltText` | Texto alternativo para a imagem principal no raro evento de ela não ser exibida. | `Image of double fudge iced cream` | | `ads.heroImage` | O link da imagem da imagem principal do banner. | `[]\() | | `ads.position` | A posição do banner na Epsilon Retail Media resposta. Você deve respeitar esta posição caso campanhas de posicionamento fixo sejam utilizadas. | 1 | | `ads.secondaryBackgroundImage` | O link da imagem da imagem de fundo secundária. | `[]\() | | `ads.secondaryBackgroundImagePosition` | Isso define o tipo de posição da imagem de fundo secundária. |

leftaligned
rightaligned

| | `ads.secondaryHeroImageAltText` | Texto alternativo para a imagem hero secundária no evento raro de ela não ser exibida. | `Image of [brand] logo` | | `ads.secondaryHeroImage` | O link da imagem hero secundária. | `[]\() | | `ads.secondaryHeroMode` | Isso define o modo de exibição da imagem hero secundária. Se não houver valor, você precisará usar como padrão `block` . |

block
landscape

| | `ads.slotId` | O ID do espaço do banner que você solicitou. Ao solicitar vários banners, isso pode ser usado para referenciar os IDs solicitados. | `Category_Top` | | `ads.tags` | Este campo retorna quaisquer tags de terceiros inseridas pelo anunciante em sua campanha. Atualmente, isso não é suportado pelo banner x, embora a resposta da API esteja formatada. | `{}` | | `ads.sellerId` | O Id exclusivo do vendedor. Só será preenchido se um sellerId estiver definido em uma equipe. sellerIds são normalmente usados ao integrar vendedores do marketplace. | `73nns-32sxr-32ss` Personalizado por integração | | `ads.metadata` |

Objeto contendo as informações do anunciante necessárias para ajudar os anunciantes a cumprir a legislação de publicidade local, como o Lei de Serviços Digitais na Europa.

advertiser é transportado do Nome da empresa na equipe do fornecedor.

onBehalfOf é transportado do Financiador do anúncio na equipe do fornecedor.

| `"metadata": {
"advertiserInfo": {
"advertiser": "Bob's advertising agency",
"onBehalfOf": "Brand company inc"
}
...` | | `ads.adm` | Objeto contendo os detalhes do anúncio em vídeo, incluindo tags 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` | Detalhes dos produtos complementares. |

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

| | `metadata.warnings` | Objeto contendo informações de aviso sobre a solicitação de anúncio. Atualmente, só avisa se o número máximo de segmentos for excedido. | `"metadata": {
"warnings": [
"Audience Segment IDs exceeded the limit of {maxSegmentIds} and were truncated"
]
}` | {% hint style="info" %} Se houver um campo não configurado como parte da campanha do anúncio, ele não será veiculado. Ou seja, se o anunciante não tiver configurado um `heroImage`, Epsilon Retail Media não veiculará a `heroImage` propriedade. {% 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/pt-br/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.