Pedido de lance Open RTB 2.4

Esta página explica como fazer pedidos de 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

Os seguintes objetos devem ser enviados codificados em JSON no corpo do pedido:

Pedido de lance

Atributo	Obrigatório?	Descrição
em	Sim	Tipo de leilão, primeiro preço = 1 (int)
id	Sim	ID exclusivo da solicitação de lance (string)
imp	Sim	Array de objetos Imp que representam as impressões oferecidas (objeto).
site	Sim	Detalhes, por meio de um objeto Site, sobre o site do editor (objeto).
app	Sim	Detalhes, através de um objeto App, sobre a aplicação do publisher* (objeto).
device	Sim	Detalhes, por meio de um objeto Device, sobre o dispositivo do usuário ao qual a impressão será entregue (objeto).
user	Não	Detalhes, por meio de um objeto User, sobre o usuário humano do dispositivo; o público-alvo do anúncio (objeto).
ext	Não	Espaço reservado para extensões do OpenRTB.

Apenas um dos objetos {site, app} deve estar presente em cada pedido.

imp

Atributo	Obrigatório?	Descrição
id	Sim	ID exclusivo da impressão dentro desta solicitação de lance (string)
bidfloor	Não	Lance mínimo para esta impressão (CPM) / clique (CPC) e moeda da conta (float)
bidfloorcur	Não	Moeda para o valor mínimo do lance, especificada com códigos alfabéticos ISO-4217 (string)
native	Apenas para imps nativos e push	Uma oportunidade de objeto Native (objeto).
banner	Apenas para imps de banner e intersticiais de página inteira	Uma oportunidade de objeto Banner (objeto).
instl	Apenas para imps pop, links diretos, e-mail e cliques em intersticiais de página inteira	Uma oportunidade de objeto Fullscreen (objeto).
video	Apenas para vídeo	Uma oportunidade de objeto Video (objeto)
secure	Recomendado	Marcador para indicar se a impressão requer ativos criativos e marcação com URL HTTPS segura, onde 0 = não seguro, 1 = seguro (opção recomendada). Se omitido, o estado de segurança é desconhecido, mas pode-se assumir suporte a HTTP não seguro (inteiro)
el	Não	E-mail codificado em Base64 (string)
ext	Não	Espaço reservado para extensões específicas da exchange

imp.banner

Atributo	Obrigatório?	Descrição
w	Sim	Largura do banner (inteiro)
h	Sim	Altura do banner (inteiro)
mimes	Não	Lista de tipos MIME suportados (array 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 exchange (objeto)

imp.banner.ext

Atributo	Obrigatório?	Descrição
image_output	Não	Indica o formato de saída para banners de imagem* (string)
video_output	Não	Indica o formato de saída para banners de vídeo* (string)

*Define o formato do campo adm para o formato de banner. As opções são xml ou html. O valor predefinido é xml caso o campo não seja fornecido.

imp.instl

Atributo	Obrigatório?	Descrição
instl	Sim	0 = cliques em links diretos/e-mail, 1 = popunder/intersticial de página inteira

imp.native (para anúncios nativos e de notificação push)

Atributo	Obrigatório?	Descrição
request	Sim	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	Não	Versão da API Dynamic Native Ads à qual request se conforma (string)

imp.native.request

Atributo	Obrigatório?	Descrição
ver	Sim	Versão da Native Markup em uso (string)
contexto	Não	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	Sim	O design/formato/layout da unidade de anúncio oferecida. Atualmente, suportamos 4 (Widget de recomendação) e 500 (Notificação push) (inteiro)
plcmtcnt	Não	O número de posicionamentos idênticos neste layout. Máx.: 10 (inteiro) (inteiro)
assets	Sim	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	Não	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	Obrigatório?	Descrição
id	Sim	ID único do asset, atribuído pela exchange. Normalmente, um contador para o array (inteiro) 1: ID do asset de imagem, 2: ID do asset de título, 3: ID do asset de descrição
obrigatório	Não	Defina como 1 se o ativo for obrigatório ou 0 se o asset for opcional (inteiro)
plcmtcnt	Não	O número de posições idênticas neste layout (inteiro)
img	Sim	Objeto Image para assets de imagem** (objeto JSON)
title	Não	Objeto Title para assets de título** (objeto JSON)
data	Não	Objeto de dados para nome da marca, descrição, classificações, preços etc.* (objeto JSON)

*A quantidade de lances recebidos para o seu pedido Native será baseada no valor que definir em "plcmtcnt". Por exemplo, um pedido de lance com "plcmtcnt":3 receberá 3 objetos de lance diferentes. Pode encontrar um exemplo disto em página de exemplo da resposta.

** Apenas um dos objetos {img, title, data} deve estar presente em cada objeto asset

imp.native.request.assets.img

Atributo	Obrigatório?	Descrição
type	Não	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	Não	Largura da imagem em pixels, opcional (inteiro)
h	Não	Altura da imagem em pixels, opcional (inteiro)
wmin	Sim	A largura mínima solicitada da imagem em pixels (inteiro)
hmin	Sim	A altura mínima solicitada da imagem em pixels (inteiro)

*Dimensões do ícone de notificação push: 192px x 192px

imp.native.request.assets.title

Atributo	Obrigatório?	Descrição
len	Sim	Comprimento máximo do texto no elemento de título. (inteiro)

imp.native.request.assets.data

Atributo	Obrigatório?	Descrição
type	Sim	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	Não	Comprimento máximo do texto na resposta do elemento (inteiro)

imp.video

Atributo	Obrigatório?	Descrição
mimes	Não	Lista de tipos mime suportados (matriz de strings)
protocols	Não	Lista de protocolos de resposta de lance de vídeo suportados (matriz de int)
skip	Não	Indica se o player permitirá que o vídeo seja pulado, onde 0 = não, 1 = sim
skipafter	Não	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	Não	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

Se fornecer apenas "skip" no pedido, mas não "skipafter", o vídeo poderá ser ignorado após 5 segundos. A resposta definirá "skipoffset" como 5. Se fornecer "skip" mas não "skipmin", o vídeo poderá ser ignorado independentemente da sua duração.

imp.ext

Atributo	Obrigatório?	Descrição
video_cta	Não	Indica se os CTAs devem ser fornecidos, onde 0 = não, 1 = sim (predefinição 1)

Para ver um exemplo de CTA, consulte o nosso página de exemplo da resposta.

site

Atributo	Obrigatório?	Descrição
id	Obrigatório	ID exclusivo do site (string)
domain	Obrigatório	Nome de domínio do site (string)
name	Obrigatório	Nome do site (string)
cat	Não	ID de categoria IAB (matriz de strings)
page	Recomendado	URL completa da página onde o anúncio será exibido (string)
keywords	Não	As palavras-chave podem ser usadas para garantir que as zonas de anúncios recebem o tipo certo de publicidade. As palavras-chave devem ser uma string de palavras separadas por vírgulas.
ext	Não	Espaço reservado para extensões específicas da exchange para OpenRTB.

site.ext

Atributo	Obrigatório?	Descrição
exchangecat	Não	ID de categoria personalizada do ExoClick (inteiro)
idzone	Não	ID de zona de anúncio personalizado do ExoClick (inteiro)

app

Atributo	Obrigatório?	Descrição
id	Obrigatório	ID único da aplicação (string)
cat	Não	ID de categoria IAB (matriz de strings)
keywords	Não	As palavras-chave podem ser usadas para garantir que as zonas de anúncios recebem o tipo certo de publicidade. As palavras-chave devem ser uma string de palavras separadas por vírgulas (string)
publisher	Não	Detalhes sobre o publisher (objeto)

app.publisher

Atributo	Obrigatório?	Descrição
domain	Recomendado	Domínio de nível mais alto do publisher (por ex., "publisher.com") (string)

device

Atributo	Obrigatório?	Descrição
ua	Sim	User agent do navegador (string)
geo	Não	Localização do dispositivo presumida como a localização atual do usuário, definida por um objeto Geo.
ip	Sim	Endereço IP do usuário (string)*
ipv6	Recomendado	Endereço IPv6 do usuário (string)*
language	Recomendado	Idioma do navegador usando ISO-639-1-alpha-2 (string)
os	Não	Sistema operacional (string)
js	Não	Suporte a JavaScript, onde 0 = não, 1 = sim (inteiro)
ext	Não	Espaço reservado para extensões específicas da exchange para OpenRTB

Só precisa de incluir ip ou ipv6 no seu pedido, não ambos. Se usar ipv6, remova o atributo ip, e vice-versa. Incluir ambos pode causar erros.

device.geo

Atributo	Obrigatório?	Descrição
country	Não	País ISO3

device.ext

Atributo	Obrigatório?	Descrição
remote_addr	Não	Endereço IP principal do usuário (string)
x_forwarded_for	Não	Endereço IP X-FORWARDED-FOR do usuário ou vazio se não estiver definido (string)

user

Atributo	Obrigatório?	Descrição
id	Sim	ID exclusivo do usuário (string)

Se não conseguir gerar uma string de ID de utilizador, pode deixá-la vazia (""). O pedido receberá uma resposta desde que o objeto "user" seja incluído no pedido.

ext

Atributo	Obrigatório?	Descrição
sub	Não	O Sub ID. Deve ser um número entre um e dez dígitos: não use zeros no início dos Sub IDs.
exportação	Não	O tipo de resposta pode ser "json" ou "xml" (string). O valor predefinido é "json".

Exemplos

Pode encontrar uma lista detalhada de exemplos de pedidos no nosso página de exemplo