> 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/product-ad-reference-1.md). # Referência de anúncio de produto Abaixo estão descritas as propriedades possíveis em uma solicitação padrão e a resposta se você receber um anúncio. ## Itens solicitados | String | Descrição | Obrigatório/opcional | | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- | | `catalogId` | O seu identificador do catálogo de produtos 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 solicitação. Consulte Filtragem na geração de anúncios para obter mais informações. | Opcional, preferencial | | `maxNumberOfAds` | O número máximo de anúncios que você gostaria que fossem retornados, até 10. | Obrigatório | | `options` |

Maneira opcional de definir a estrutura da sua solicitação. Consulte Filtragem na geração de anúncios para obter mais informações.

Este também é o objeto no qual você pode solicitar informações do anunciante para cumprir com 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 solicitação. Como uma categoria, localização ou tamanho. | Obrigatório | | `sessionId` | O identificador exclusivo da sessão do cliente. Usado para atribuição em integrações padrão. Analise as Opções de fluxo de trabalho de integração para obter mais informações. | Obrigatório em integrações padrão | | `memoryToken` |

Usado para paginação. Use um token fornecido em uma solicitação de anúncio anterior para garantir que Epsilon Retail Media veicule apenas novos anúncios para os seus clientes.

Se fornecido, Epsilon Retail Media excluirá anúncios veiculados anteriormente na resposta do anúncio. Analise Paginação para saber mais.

| Opcional | | `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 específicos aos quais o comprador pertence. Relevante apenas se estiver usando a [Opção de direcionamento de público 3](/retail-media-interface/integration/pt-br/data-api/audience-targeting-new/integration-option-3-sync-audiences-only.md) | Opcional | ## Itens retornados | String | Descrição | Valor de exemplo | | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | | `ads.customPayload` |

Este payload personalizado que deve ser repassado do arquivo do catálogo para a geração de anúncios.

O campo deve conter um objeto JSON válido serializado em um array de bytes e codificado em Base64. O objeto JSON deve aderir a um esquema.

| Personalizado por integração | | `ads.sellerId` | O Id exclusivo do vendedor. Só será preenchido se um sellerId estiver configurado em uma equipe. Os sellerIds são usados tipicamente ao integrar vendedores do marketplace. | `73nns-32sxr-32ss` Personalizado por integração | | `ads.id` |

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

| `display_yCaCIy_kKaJnRnzrenBkVSytwr8yNTgxMzM4` | | `ads.gtin` | O código do produto do anúncio. Este será o código do produto sincronizado no seu catálogo de produtos. | `25813383` | | `ads.discount` | Legado, pode ser ignorado. | `{
"amount": 0,
"minPrice": 0,
"maxPerCustomer": 0
}` | | `ads.position` | A posição do anúncio na Epsilon Retail Media resposta. Você deve respeitar esta posição caso campanhas de Posicionamento fixo sejam utilizadas. | 1 | | `ads.memoryToken` |

Usado para paginação e encadeamento de solicitações de anúncios.

Se fornecido na sua próxima solicitação de anúncio para o mesmo contexto, Epsilon Retail Media excluirá anúncios veiculados anteriormente na resposta do anúncio. Analise Paginação para saber mais.

| | | `ads.metadata` |

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

advertiser é extraído do Nome da empresa na equipe do fornecedor.

onBehalfOf é extraído do Financiador do anúncio na equipe do fornecedor.

| `"metadata": {
"advertiserInfo": {
"advertiser": "Bob's advertising agency",
"onBehalfOf": "Brand company inc"
}
...` | | `banners` | Compreende objetos de banner. Veja a [Referência de anúncio em banner (estático)](/retail-media-interface/integration/pt-br/references/banner-ad-static-reference.md) para saber mais. | `"banners": [],` | | `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 100 and were truncated"
]` | --- # 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/product-ad-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.