Open RTB Bid Request Specifications
Esta página descreve os diferentes componentes dos pedidos RTB que receberá para licitar.
Cabeçalhos dos pedidos de propostas
- Cabeçalho HTTP da versão OpenRTB: x-openrtb-version: 2.4
- cabeçalho HTTP Keep-Alive**: Connection: Keep-Alive
- Content JSON: Content-Type: application/json
- Cabeçalho de codificação de dados: Accept-Encoding
Pedido de Proposta
When requesting bids for a specific context, the platform will perform an HTTP request with a timeout of 300ms and send the following object encoded as JSON in the request body. HTTP is recommended due to extra latency when using HTTPS.
| Atributo | Descrição |
|---|
| em | Tipo de leilão, primeiro preço = 1 (int) |
| id | ID exclusivo da solicitação de cotação (string) |
| imp | Objeto que representa a impressão oferecida (objeto). |
| local | Detalhes através de um objeto Site sobre o sítio Web do editor (objeto). |
| dispositivo | Detalhes através de um objeto Dispositivo sobre o dispositivo do utilizador ao qual a impressão será entregue (objeto). |
| utilizador | Detalhes, através de um objeto User, sobre o utilizador humano do dispositivo; o público publicitário (objeto). |
| ext | Espaço reservado para extensões específicas da bolsa. |
imp
| Atributo | Descrição |
|---|
| id | ID de impressão único neste pedido de cotação (string) |
| piso de licitação | Lance mínimo para esta impressão (CPM) / clique (CPC) e moeda da conta, opcional (flutuante). |
| bidfloorcur | Moeda para o valor mínimo da proposta especificado utilizando códigos alfa ISO-4217, facultativo (string) |
| nativo | Um objeto Nativo; necessário se esta impressão for oferecida como uma oportunidade de anúncio nativo (objeto). |
| bandeira | Um objeto de banner; necessário se esta impressão for oferecida como uma oportunidade de anúncio de banner (objeto). |
| instl | Um objeto intersticial; necessário se esta impressão for oferecida como uma oportunidade de anúncio intersticial (objeto). |
| seguro | Sinalizador para indicar se a impressão requer activos criativos e marcação de URL HTTPS seguros, em que 0 = não seguro, 1 = seguro. Se omitido, o estado seguro é desconhecido, mas o suporte HTTP não seguro pode ser assumido, opcional (número inteiro) |
| el | Email codificado em Base64 (string) |
imp.banner
| Atributo | Descrição |
|---|
| w | Largura da faixa em píxeis (número inteiro). |
| h | Altura do banner em pixels (número inteiro). |
imp.instl
| Atributo | Descrição |
|---|
| instl | Sinalizador que especifica se o anúncio é popunder/intersticial (número inteiro): 1=verdadeiro, 0=falso |
imp.native (Notificações nativas e push)
| Atributo | Descrição |
|---|
| pedido | Carga útil do pedido em conformidade com a especificação de anúncios nativos - uma cadeia JSON codificada do pedido de anúncios nativos, incluindo o seu objeto nativo de nível superior (objeto JSON) |
| ver | Versão da API Dynamic Native Ads com a qual request está em conformidade (string) |
imp.native.request
| Atributo | Descrição |
|---|
| ver | Versão da versão do Native Markup em utilização (string) |
| contexto | O contexto em que o anúncio aparece. Neste caso, é 1 (contexto centrado no conteúdo, como feed de notícias, artigo, galeria de imagens, galeria de vídeos ou semelhante), opcional (número inteiro) |
| plcmttype | O design/formato/layout do bloco de anúncios que está a ser oferecido. Atualmente, suportamos 4 (Widget de recomendação) e 500 (Push Notification) (número inteiro) |
| plcmtcnt | O número de colocações idênticas nesta Estrutura (número inteiro) |
| activos | Um conjunto de objectos de activos. Qualquer resposta da proposta tem de estar em conformidade com o conjunto de elementos expressos no pedido de proposta (conjunto de objectos JSON) |
| seq | 0 para o primeiro anúncio, 1 para o segundo anúncio, e assim por diante. Note-se que, em geral, esta opção NÃO deve ser utilizada em combinação com plcmtcnt - ou está a leiloar várias colocações idênticas (nesse caso, plcmtcnt>1, seq=0) ou está a realizar leilões separados para itens distintos no feed (nesse caso, plcmtcnt=1, seq=>=1) |
imp.native.request.assets
| Atributo | Descrição |
|---|
| id | ID único do ativo, atribuído pela bolsa. Normalmente, um contador para a matriz (número inteiro) |
| necessário | Definido como 1 se o ativo for obrigatório ou 0 se o ativo for opcional** (número inteiro) |
| plcmtcnt | O número de colocações idênticas nesta Estrutura (número inteiro) |
| imagem | Objeto de imagem para activos de imagem* (objeto JSON) |
| título | Objeto de título para activos de título* (objeto JSON) |
| dados | Objeto de dados para nome da marca, descrição, classificações, preços, etc.* (objeto JSON) |
| vídeo | Objeto de vídeo para activos de vídeo. Consulte a definição do objeto de pedido de vídeo. Tenha em atenção que os anúncios de vídeo in-stream (ou seja, preroll, etc.) não fazem parte do Native. Os anúncios nativos podem conter um vídeo como o próprio criativo do anúncio (objeto). |
* Apenas um dos objectos {img, title, data} deve estar presente em cada objeto do ativo
** Os activos são assinalados conforme necessário, de acordo com a configuração da zona do editor onde o anúncio pode ser apresentado
imp.native.request.assets.img
| Atributo | Descrição |
|---|
| tipo | ID de tipo do elemento de imagem suportado pelo editor. Suportamos: 1 (Imagem de ícone) (número inteiro), 3 (Pré-visualização de imagem grande para o anúncio) (número inteiro) |
| w | Largura da imagem em píxeis, opcional (número inteiro) |
| h | Altura da imagem em píxeis, opcional (número inteiro) |
| wmin | A largura mínima requerida da imagem em píxeis (número inteiro) |
| hmin | A altura mínima requerida da imagem em píxeis (número inteiro) |
imp.native.request.assets.title
| Atributo | Descrição |
|---|
| len | Comprimento máximo do texto no elemento título. (número inteiro) |
imp.native.request.assets.data
| Atributo | Descrição |
|---|
| tipo | ID do tipo do elemento suportado pelo editor (número inteiro). Suportamos: 1 (sponsored - Mensagem patrocinada por onde a resposta deve conter o nome da marca do patrocinador), 2 (desc - Texto descritivo associado ao produto ou serviço que está a ser anunciado) |
| len | Comprimento máximo do texto na resposta do elemento (número inteiro) |
| <!-- | |
| ### imp.native.request.assets.video | |
| Atributo | Descrição |
|---|
| mímicas | Lista de tipos de mime suportados (matriz de strings) |
| mentalização | Duração mínima do anúncio de vídeo em segundos (int). |
| duração máxima | Duração máxima do anúncio de vídeo em segundos(int). |
| protocolos | Lista de protocolos de resposta a ofertas de vídeo suportados (matriz int) |
| linearidade | Indica se a impressão deve ser linear, não linear, etc. (int) |
| boxe permitido | Indica se é permitido o letter-boxing de conteúdos 4:3 numa janela 16:9 (int) |
| --> | |
imp.video
| Atributo | Descrição |
|---|
| mímicas | Lista de tipos de mime suportados (matriz de strings) |
| protocolos | Lista de protocolos de resposta a ofertas de vídeo suportados (matriz int) |
| saltar | Indica se o leitor permite que o vídeo seja saltado, sendo 0 = não, 1 = sim |
| saltar depois | Número de segundos que um vídeo tem de ser reproduzido antes de ser possível saltar; apenas aplicável se o anúncio puder ser saltado |
| saltar | Os vídeos com uma duração total superior a este número de segundos podem ser saltados; apenas aplicável se o anúncio for saltável |
Nota: Se o editor fornecer "skip" no pedido, mas não "skipafter", o vídeo pode ser saltado após 5 segundos. A resposta definirá "skipoffset" para 5. Se o editor fornecer "skip" mas não "skipmin", o vídeo poderá ser saltado independentemente da sua duração.
local
| Atributo | Descrição |
|---|
| id* | ID único do sítio (string) |
| domínio* | Nome de domínio do sítio (string) |
| gato | ID da categoria IAB (cadeia de caracteres) |
| página | URL completo da página onde o anúncio será apresentado (string) |
| palavras-chave | As palavras-chave podem ser utilizadas para garantir que as zonas de anúncios obtêm o tipo correto de publicidade. As palavras-chave devem ser uma sequência de palavras separadas por vírgulas |
| ext | Espaço reservado para extensões específicas da bolsa para o OpenRTB. |
*Estes atributos são obrigatórios para os formatos Ligação direta e Cliques de e-mail.
site.ext
| Atributo | Descrição |
|---|
| gato de troca | ID da categoria personalizada da ExoClick (número inteiro) |
| idzone | ID da zona de anúncios personalizada da ExoClick (número inteiro) |
| palavra-chave | Palavra-chave correspondente, se existir (string) |
O atributo idzone é utilizado para identificar a origem do tráfego na ExoClick.
dispositivo
| Atributo | Descrição |
|---|
| ua | Agente do utilizador do navegador (string) |
| geo | A localização do dispositivo é assumida como a localização atual do utilizador definida por um objeto Geo. |
| ip | Endereço IP do utilizador (string)* |
| ipv6 | Endereço IPv6 do utilizador (cadeia)* |
| língua | Idioma do navegador que utiliza a norma ISO-639-1-alpha-2 (string) |
| os | Sistema operativo (string) |
| js | Suporte para JavaScript, em que 0 = não, 1 = sim (número inteiro) |
| ext | Espaço reservado para extensões específicas da bolsa para o OpenRTB |
dispositivo.geo
| Atributo | Descrição |
|---|
| país | País ISO3 |
dispositivo.ext
| Atributo | Descrição |
|---|
| endereço_remoto | Endereço IP principal do utilizador (string) |
| x_forwarded_for | Endereço IP X-FORWARDED-FOR do utilizador ou vazio se não estiver definido (string) |
utilizador
| Atributo | Descrição |
|---|
| id | ID único do utilizador (string) |
ext
| Atributo | Necessário? | Descrição |
|---|
| submarino | Não | O sub será um número inteiro que representa o ID da zona de onde o pedido foi originado. |
regs.ext
| Atributo | Descrição |
|---|
| dsaplicar | Sinalizador para indicar se a DSA é aplicada ao pedido. 1 = Necessário (int) |
| dsa | Extensão para informação de transparência DSA (objeto) |
regs.ext.dsa
| Atributo | Descrição |
|---|
| necessário | Sinalizador para indicar se a informação DSA deve ser disponibilizada. 0 = Não necessário, 1 = Suportado, serão aceites respostas de licitação com ou sem o objeto DSA, 2 = Necessário, não serão aceites respostas de licitação sem o objeto DSA, 3 = Necessário, não serão aceites respostas de licitação sem o objeto DSA, o editor é uma plataforma online (int) |
| datatopub | O editor pode precisar dos dados de transparência para efeitos de auditoria. 0 = não enviar dados de transparência, 1 = opcional para enviar dados de transparência, 2 = enviar dados de transparência (int) |
Nota: *Se receber dsaapply: 1 e required: 2 ou 3, é obrigatório adicionar atributos dsa com valores na resposta, caso contrário a resposta será rejeitada.
Exemplos
You can find a complete list of all the types of requests you can receive in our Advertiser Request example page.