> For the complete documentation index, see [llms.txt](https://docs.exoclick.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.exoclick.com/rtb/pt/anunciantes/open-rtb/adv-open-rtb-2.4-request.md). # Pedido de lance Open RTB 2.4 Esta página descreve os diferentes componentes das solicitações RTB que você receberá para dar lances. ## Cabeçalhos da solicitação de lance * **Cabeçalho HTTP da versão OpenRTB**: `x-openrtb-version: 2.4` * **Cabeçalho HTTP Keep-Alive**: `Connection: Keep-Alive` * **JSON do conteúdo**: `Content-Type: application/json` * **Cabeçalho de codificação de dados**: `Accept-Encoding` ## Objeto da solicitação de lance Ao solicitar lances para um contexto específico, a plataforma fará uma solicitação HTTP com um tempo limite de **300ms** e enviará o seguinte objeto codificado como JSON no corpo da solicitação. **HTTP** é recomendado devido à latência extra ao usar HTTPS. | Atributo | Descrição | | -------- | ------------------------------------------------------------------------------------------------------------------ | | em | Tipo de leilão, primeiro preço = 1 (int) | | id | ID exclusivo da solicitação de lance (string) | | imp | Objeto que representa a impressão oferecida (objeto). | | site | Detalhes, por meio de um objeto Site, sobre o site do editor (objeto). | | device | Detalhes, por meio de um objeto Device, sobre o dispositivo do usuário ao qual a impressão será entregue (objeto). | | user | Detalhes, por meio de um objeto User, sobre o usuário humano do dispositivo; o público-alvo do anúncio (objeto). | | ext | Espaço reservado para extensões específicas da exchange. | ## imp | Atributo | Descrição | | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | id | ID exclusivo da impressão dentro desta solicitação de lance (string) | | bidfloor | Lance mínimo para esta impressão (CPM) / clique (CPC) e moeda da conta, opcional (float). | | bidfloorcur | Moeda para o valor mínimo do lance especificado usando códigos alfa ISO-4217, opcional (string) | | native | Um objeto Native; obrigatório se esta impressão for oferecida como uma oportunidade de anúncio nativo (objeto). | | banner | Um objeto banner; obrigatório se esta impressão for oferecida como uma oportunidade de anúncio em banner (objeto). | | instl | Um objeto intersticial; obrigatório se esta impressão for oferecida como uma oportunidade de anúncio intersticial ou popunder (objeto).(objeto). | | secure | Sinalizador para indicar se a impressão requer ativos criativos e marcação de URL HTTPS segura, onde 0 = não seguro, 1 = seguro. Se omitido, o estado de segurança é desconhecido, mas o suporte a HTTP não seguro pode ser assumido, opcional (inteiro) | | el | E-mail codificado em Base64 (string) | ### imp.banner | Atributo | Descrição | | -------- | --------------------------------------------------------------------------------------- | | w | Largura do banner em pixels (inteiro). | | h | Altura do banner em pixels (inteiro). | | mimes | Tipos MIME suportados. Valores de exemplo: image/jpg, image/png, video/mp4, image/webp. | ### imp.instl | Atributo | Descrição | | -------- | ------------------------------------------------------------------------------------------------ | | instl | Sinalizador que especifica se o anúncio é popunder/intersticial (inteiro): 1=verdadeiro, 0=falso | ### imp.native (Native & Push Notifications) | Atributo | Descrição | | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | request | Carga útil da solicitação em conformidade com a Especificação de Anúncio Nativo - uma **string codificada em JSON** da solicitação de Anúncios Nativos, incluindo seu **native** objeto de nível superior (objeto JSON) | | ver | Versão da API Dynamic Native Ads à qual **request** se conforma (string) | ### imp.native.request | Atributo | Descrição | | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ver | Versão da Native Markup em uso (string) | | contexto | O contexto em que o anúncio aparece. Neste caso, é **1** (*um contexto centrado em conteúdo, como feed de notícias, artigo, galeria de imagens, galeria de vídeos ou similar*), opcional (inteiro) | | plcmttype | O design/formato/layout da unidade de anúncio oferecida. Atualmente, suportamos **4** (*Widget de recomendação*) e **500** (*Notificação push*) (inteiro) | | plcmtcnt | O número de posições idênticas neste layout (inteiro) | | assets | Uma matriz de **Objetos de ativo**. Qualquer resposta de lance deve estar em conformidade com a matriz de elementos expressa na solicitação de lance (matriz de objetos JSON) | | seq | 0 para o primeiro anúncio, 1 para o segundo anúncio e assim por diante. Observe que isso geralmente NÃO seria usado em combinação com plcmtcnt - ou você está leiloando várias posições idênticas (nesse caso, plcmtcnt>1, seq=0) ou está realizando leilões separados para itens distintos no feed (nesse caso, plcmtcnt=1, seq=>=1) | ### imp.native.request.assets | Atributo | Descrição | | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | id | ID exclusivo do ativo, atribuído pela exchange. Normalmente um contador para a matriz (inteiro) | | obrigatório | Defina como **1** se o ativo for obrigatório ou **0** se o ativo for opcional\*\* (inteiro) | | plcmtcnt | O número de posições idênticas neste layout (inteiro) | | img | Objeto de imagem para ativos de imagem\* (objeto JSON) | | title | Objeto de título para ativos de título\* (objeto JSON) | | data | Objeto de dados para nome da marca, descrição, classificações, preços etc.\* (objeto JSON) | | video | Objeto de vídeo para ativos de vídeo. Consulte a definição do objeto de solicitação de vídeo. Observe que anúncios em vídeo in-stream (ou seja, pré-roll etc.) não fazem parte de Native. Os anúncios nativos podem conter um vídeo como o próprio criativo do anúncio (objeto). | \* Somente um dos objetos {img, title, data} deve estar presente em cada objeto de ativo \*\* Os ativos são sinalizados como obrigatórios de acordo com a configuração da zona do editor onde seu anúncio pode ser exibido ### imp.native.request.assets.img | Atributo | Descrição | | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | type | ID de tipo do elemento de imagem suportado pelo editor. Suportamos: **1** (*Imagem de ícone*) (inteiro), **3** (*Pré-visualização de imagem grande para o anúncio*) (inteiro) | | w | Largura da imagem em pixels, opcional (inteiro) | | h | Altura da imagem em pixels, opcional (inteiro) | | wmin | A largura mínima solicitada da imagem em pixels (inteiro) | | hmin | A altura mínima solicitada da imagem em pixels (inteiro) | ### imp.native.request.assets.title | Atributo | Descrição | | -------- | ------------------------------------------------------------ | | len | Comprimento máximo do texto no elemento de título. (inteiro) | ### imp.native.request.assets.video | Atributo | Descrição | | ------------- | ---------------------------------------------------------------------------------- | | mimes | Lista de tipos MIME suportados (matriz de strings). | | minduration | Duração mínima do anúncio em vídeo em segundos (inteiro). | | maxduration | Duração máxima do anúncio em vídeo em segundos (inteiro). | | protocols | Lista de protocolos de resposta de lance em vídeo suportados (matriz de inteiros). | | linearity | Indica se a impressão deve ser linear, não linear etc. (inteiro). | | boxingallowed | Indica se é permitido encaixotar conteúdo 4:3 em uma janela 16:9 (inteiro). | ### imp.native.request.assets.data | Atributo | Descrição | | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | type | ID de tipo do elemento suportado pelo editor (inteiro). Suportamos: **1** (*sponsored - mensagem 'Patrocinado por', em que a resposta deve conter o nome da marca do patrocinador*), **2** (*desc - texto descritivo associado ao produto ou serviço anunciado*) | | len | Comprimento máximo do texto na resposta do elemento (inteiro) | ### imp.video | Atributo | Descrição | | --------- | -------------------------------------------------------------------------------------------------------------------------------- | | mimes | Lista de tipos mime suportados (matriz de strings) | | protocols | Lista de protocolos de resposta de lance de vídeo suportados (matriz de int) | | skip | Indica se o player permitirá que o vídeo seja pulado, onde 0 = não, 1 = sim | | skipafter | Número de segundos que um vídeo deve ser reproduzido antes que o pulo seja habilitado; aplicável apenas se o anúncio for pulável | | skipmin | Vídeos com duração total superior a este número de segundos podem ser puláveis; aplicável apenas se o anúncio for pulável | {% hint style="info" %} Se o editor fornecer "skip" na solicitação, mas não "skipafter", o vídeo poderá ser pulado após 5 segundos. A resposta definirá "skipoffset" como 5.\ Se o editor fornecer "skip" mas não "skipmin", o vídeo poderá ser pulado independentemente de sua duração. {% endhint %} ## site | Atributo | Descrição | | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | id\* | ID exclusivo do site (string) | | domain\* | Nome de domínio do site (string) | | cat | ID de categoria IAB (matriz de strings) | | page | URL completa da página onde o anúncio será exibido (string) | | keywords | As palavras-chave podem ser usadas para garantir que as zonas de anúncio recebam o tipo certo de publicidade. As palavras-chave devem ser uma string de palavras separadas por vírgulas | | ext | Espaço reservado para extensões específicas da exchange para OpenRTB. | \*Esses atributos são obrigatórios para os formatos Direct Link e Email Clicks. ### site.ext | Atributo | Descrição | | ----------- | --------------------------------------------------------- | | exchangecat | ID de categoria personalizada do ExoClick (inteiro) | | idzone | ID de zona de anúncio personalizado do ExoClick (inteiro) | | keyword | Palavra-chave correspondente, se houver (string) | O atributo idzone é usado para identificar a origem no ExoClick de onde o tráfego está vindo. ## device | Atributo | Descrição | | -------- | ----------------------------------------------------------------------------------------------------------------------- | | ua | User agent do navegador (string) | | sua | Informações estruturadas do user agent, que podem ser usadas quando um cliente suporta User-Agent Client Hints (objeto) | | geo | Localização do dispositivo presumida como a localização atual do usuário, definida por um objeto Geo. | | ip | Endereço IP do usuário (string)\* | | ipv6 | Endereço IPv6 do usuário (string)\* | | language | Idioma do navegador usando ISO-639-1-alpha-2 (string) | | os | Sistema operacional (string) | | js | Suporte a JavaScript, onde 0 = não, 1 = sim (inteiro) | | ext | Espaço reservado para extensões específicas da exchange para OpenRTB | \*Apenas um de ip ou ipv6 estará presente na solicitação de lance. ### device.geo | Atributo | Descrição | | -------- | --------- | | country | País ISO3 | ### device.ext | Atributo | Descrição | | ----------------- | -------------------------------------------------------------------------------- | | remote\_addr | Endereço IP principal do usuário (string) | | x\_forwarded\_for | Endereço IP X-FORWARDED-FOR do usuário ou vazio se não estiver definido (string) | ### device.sua Informações estruturadas do User Agent. `device.sua` é considerada a representação mais precisa dos atributos do dispositivo. | Atributo | Descrição | | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | browsers | Envie marcas e versões derivadas do cabeçalho Sec-CH-UA-Full-Version-List. (Matriz de `BrandVersion` objetos) | | platform | Envie uma marca derivada do cabeçalho Sec-CH-UA-Platform e a versão derivada do cabeçalho Sec-CH-UA-Platform-Version. (`BrandVersion` Objeto) | | mobile | Derive este valor do cabeçalho Sec-CH-UA-Mobile. (inteiro) | | architecture | Recupere este valor do cabeçalho Sec-CH-UA-Arch. (string) | | bitness | Recupere este valor do cabeçalho Sec-CH-UA-Bitness. (string) | | model | Recupere este valor do cabeçalho Sec-CH-UA-Model. (string) | | source | A origem dos dados usada para criar este objeto, [Lista: Origem do User-Agent](https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list--user-agent-source-) no AdCOM 1.0 (inteiro; padrão 0) | ### device.sua.browsers | device.sua.platform | Atributo | Descrição | | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | brand | O valor pode ser obtido dos cabeçalhos User-Agent Client Hints, representando ou a marca do user agent (do Sec-CH-UA-Full-Version) ou a marca da plataforma (do Sec-CH-UA-Platform). (string) | | version | Uma sequência de componentes da versão, em ordem hierárquica decrescente \[maior, menor, micro, …] (matriz de strings) | ## user | Atributo | Descrição | | -------- | -------------------------------- | | id | ID exclusivo do usuário (string) | ## ext | Atributo | Obrigatório? | Descrição | | -------- | ------------ | -------------------------------------------------------------------------------------------- | | sub | Não | O sub será um número inteiro representando o ID da zona de onde a solicitação foi originada. | ## regs.ext | Atributo | Descrição | | -------- | -------------------------------------------------------------------------------- | | dsaapply | Sinalizador para indicar se o DSA se aplica à solicitação. 1 = Obrigatório (int) | | dsa | Extensão para informações de transparência do DSA (objeto) | ### regs.ext.dsa | Atributo | Descrição | | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | obrigatório | Sinalizador para indicar se as informações de DSA devem ser disponibilizadas. 0 = Não necessário, 1 = Suportado, respostas de lance com ou sem objeto DSA serão aceitas, 2 = Obrigatório, respostas de lance sem objeto DSA não serão aceitas, 3 = Obrigatório, respostas de lance sem objeto DSA não serão aceitas, o Editor é uma Plataforma Online (int) | | datatopub | O editor pode precisar dos dados de transparência para fins de auditoria. 0 = não enviar dados de transparência, 1 = opcional enviar dados de transparência, 2 = enviar dados de transparência (int) | {% hint style="warning" %} Se você receber **dsaapply: 1** e **required: 2 or 3**, é obrigatório adicionar atributos dsa com valores na resposta, caso contrário a resposta será rejeitada. {% endhint %} ## Exemplos Você pode encontrar uma lista completa de todos os tipos de solicitações que pode receber em nossa [página de exemplo de Solicitação do Anunciante](/rtb/pt/anunciantes/open-rtb/open-rtb-advertiser-code-examples.md). --- # 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://docs.exoclick.com/rtb/pt/anunciantes/open-rtb/adv-open-rtb-2.4-request.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.