Especificações do pedido de concurso RTB aberto
Esta página explica como efetuar pedidos de propostas
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
The following objects should be sent encoded as JSON in the request body:
Pedido de Proposta
| Atributo | Necessário? | Descrição |
|---|
| em | Sim | Tipo de leilão, primeiro preço = 1 (int) |
| id | Sim | ID exclusivo da solicitação de cotação (string) |
| imp | Sim | Matriz de objectos Imp que representam as impressões oferecidas (objeto). |
| local | Sim | Detalhes através de um objeto Site sobre o sítio Web do editor (objeto). |
| dispositivo | Sim | Detalhes através de um objeto Dispositivo sobre o dispositivo do utilizador ao qual a impressão será entregue (objeto). |
| utilizador | Não | Detalhes, através de um objeto User, sobre o utilizador humano do dispositivo; o público publicitário (objeto). |
| ext | Não | Espaço reservado para extensões do OpenRTB. |
imp
| Atributo | Necessário? | Descrição |
|---|
| id | Sim | ID de impressão único neste pedido de cotação (string) |
| piso de licitação | Não | Lance mínima para esta impressão (CPM) / clique (CPC) e moeda da conta (flutuante) |
| bidfloorcur | Não | Moeda para o valor mínimo da proposta especificado utilizando códigos alfa ISO-4217 (string) |
| nativo | Apenas para imps nativos e push | Uma oportunidade de objeto nativo (objeto). |
| bandeira | Apenas para banners imps | Uma oportunidade de objeto de banner (objeto). |
| instl | Apenas para imagens pop, de ligação direta e de clique por correio eletrónico | Uma oportunidade de objeto de ecrã inteiro (objeto). |
| vídeo | Apenas para vídeo | Uma oportunidade de objeto de vídeo (objeto) |
| seguro | Recomendado | 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 (opção recomendada). Se omitido, o estado seguro é desconhecido, mas o suporte HTTP não seguro pode ser assumido (número inteiro) |
| el | Não | Email codificado em Base64 (string) |
| ext | Não | Espaço reservado para extensões específicas da bolsa |
imp.banner
| Atributo | Necessário? | Descrição |
|---|
| w | Sim | Largura da faixa (número inteiro) |
| h | Sim | Altura da faixa (número inteiro) |
| mímicas | Não | Lista de tipos de mime suportados (matriz de strings). Suportamos: image/jpeg, image/jpg, image/png, image/png, image/gif, image/webp, video/mp4 |
| ext | Não | Espaço reservado para extensões específicas da bolsa (objeto) |
imp.banner.ext
| Atributo | Necessário? | Descrição |
|---|
| saída de imagem | Não | Indica o formato de saída para banners de imagem* (string) |
| saída de vídeo | Não | Indica o formato de saída para banners de vídeo* (string) |
*Define o formato do campo adm para o formato do banner. As opções são xml ou html. O valor por defeito é xml no caso de o campo não ser fornecido.
imp.instl
| Atributo | Necessário? | Descrição |
|---|
| instl | Sim | 0 = cliques em links diretos/e-mails, 1 = popunder |
imp.native (para anúncios nativos e de notificações push)
| Atributo | Necessário? | Descrição |
|---|
| pedido | Sim | 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 | Não | Versão da API Dynamic Native Ads com a qual request está em conformidade (string) |
imp.native.request
| Atributo | Necessário? | Descrição |
|---|
| ver | Sim | Versão da versão do Native Markup em utilização (string) |
| contexto | Não | 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 | Sim | 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 | Não | O número de colocações idênticas neste Layout. Máximo: 10 (número inteiro) (número inteiro) |
| activos | Sim | 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 | Não | 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 | Necessário? | Descrição |
|---|
| id | Sim | ID único do ativo, atribuído pela bolsa. Normalmente, um contador para a matriz (número inteiro) 1: ID do ativo imagem, 2: ID do ativo título, 3: ID do ativo descrição |
| necessário | Não | Definido como 1 se o ativo for obrigatório ou 0 se o ativo for facultativo (número inteiro) |
| plcmtcnt | Não | O número de colocações idênticas nesta Estrutura (número inteiro) |
| imagem | Sim | Objeto de imagem para activos de imagem** (objeto JSON) |
| título | Não | Objeto de título para activos de título** (objeto JSON) |
| dados | Não | Objeto de dados para nome da marca, descrição, classificações, preços, etc.* (objeto JSON) |
*The amount of bids received for your Native request will be based on the value you set in "plcmtcnt". For example, a bid request with "plcmtcnt":3 will receive 3 different bid objects. You can find an example of this in the Response example page.
** Apenas um dos objectos {img, title, data} deve estar presente em cada objeto de ativo
imp.native.request.assets.img
| Atributo | Necessário? | Descrição |
|---|
| tipo | Não | 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 | Não | Largura da imagem em píxeis, opcional (número inteiro) |
| h | Não | Altura da imagem em píxeis, opcional (número inteiro) |
| wmin | Sim | A largura mínima requerida da imagem em píxeis (número inteiro) |
| hmin | Sim | A altura mínima requerida da imagem em píxeis (número inteiro) |
*Dimensões do ícone de notificação rápida: 192px x 192px
imp.native.request.assets.title
| Atributo | Necessário? | Descrição |
|---|
| len | Sim | Comprimento máximo do texto no elemento título. (número inteiro) |
imp.native.request.assets.data
| Atributo | Necessário? | Descrição |
|---|
| tipo | Sim | 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 | Não | Comprimento máximo do texto na resposta do elemento (número inteiro) |
imp.video
| Atributo | Necessário? | Descrição |
|---|
| mímicas | Não | Lista de tipos de mime suportados (matriz de strings) |
| protocolos | Não | Lista de protocolos de resposta a ofertas de vídeo suportados (matriz int) |
| saltar | Não | Indica se o leitor permite que o vídeo seja saltado, sendo 0 = não, 1 = sim |
| saltar depois | Não | 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 | Não | 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 fornecer apenas "skip" no pedido, mas não "skipafter", o vídeo pode ser saltado após 5 segundos. A resposta definirá "skipoffset" para 5. Se fornecer "skip" mas não "skipmin", o vídeo poderá ser saltado independentemente da sua duração.
imp.ext
| Atributo | Necessário? | Descrição |
|---|
| vídeo_cta | Não | Indica se as AIC devem ser fornecidas, sendo 0 = não, 1 = sim (predefinição 1) |
To see an example of CTA, please check our Response example page.
local
| Atributo | Necessário? | Descrição |
|---|
| id | Necessário | ID único do sítio (string) |
| domínio | Necessário | Nome de domínio do sítio (string) |
| nome | Necessário | Nome do sítio (string) |
| gato | Não | ID da categoria IAB (cadeia de caracteres) |
| página | Recomendado | URL completo da página onde o anúncio será apresentado (string) |
| palavras-chave | Não | 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 | Não | Espaço reservado para extensões específicas da bolsa para o OpenRTB. |
site.ext
| Atributo | Necessário? | Descrição |
|---|
| gato de troca | Não | ID da categoria personalizada da ExoClick (número inteiro) |
| idzone | Não | ID da zona de anúncios personalizada da ExoClick (número inteiro) |
aplicação
| Atributo | Necessário? | Descrição |
|---|
| id | Necessário | ID único da aplicação (string) |
| gato | Não | ID da categoria IAB (cadeia de caracteres) |
| palavras-chave | Não | 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 cadeia de palavras separadas por vírgulas (cadeia) |
| editor | Não | Detalhes sobre o Editor (objeto) |
Nota: Não é possível enviar o objeto "app" juntamente com "site" ou vice-versa.
app.publisher
| Atributo | Necessário? | Descrição |
|---|
| domínio | Recomendado | Domínio de nível mais elevado do editor (por exemplo, "editor.com") (string) |
dispositivo
| Atributo | Necessário? | Descrição |
|---|
| ua | Sim | Agente do utilizador do navegador (string) |
| geo | Não | A localização do dispositivo é assumida como a localização atual do utilizador definida por um objeto Geo. |
| ip | Sim | Endereço IP do utilizador (string)* |
| ipv6 | Recomendado | Endereço IPv6 do utilizador (cadeia)* |
| língua | Recomendado | Idioma do navegador que utiliza a norma ISO-639-1-alpha-2 (string) |
| os | Não | Sistema operativo (string) |
| js | Não | Suporte para JavaScript, em que 0 = não, 1 = sim (número inteiro) |
| ext | Não | Espaço reservado para extensões específicas da bolsa para o OpenRTB |
Nota: Só precisa de incluir ip ou ipv6 no seu pedido, não ambos. Se utilizar ipv6, remova o atributo ip, e vice-versa. A inclusão de ambos pode causar erros.
dispositivo.geo
| Atributo | Necessário? | Descrição |
|---|
| país | Não | País ISO3 |
dispositivo.ext
| Atributo | Necessário? | Descrição |
|---|
| endereço_remoto | Não | Endereço IP principal do utilizador (string) |
| x_forwarded_for | Não | Endereço IP X-FORWARDED-FOR do utilizador ou vazio se não estiver definido (string) |
utilizador
| Atributo | Necessário? | Descrição |
|---|
| id | Sim | ID único do utilizador (string) |
Nota: Se não for possível gerar uma cadeia de ID de utilizador, pode deixá-la vazia (""). O pedido obterá uma resposta desde que o objeto "user" esteja incluído no pedido.
ext
| Atributo | Necessário? | Descrição |
|---|
| submarino | Não | O Sub ID. Este deve ser um número entre seis e dez dígitos: Não utilizar zeros no início dos Sub IDs. |
| exportação | Não | A resposta pode ser "json" ou "xml" (string). Por defeito, é "json". |
Note: Sub IDs should be a number between 1 and Int32: Do not use zeroes at the beginning of Sub IDs.
Exemplos
You can find a detailed list of Request examples in our example page