Pedido de lance Open RTB 2.5

Esta página explica como fazer pedidos de lances.

Cabeçalhos sugeridos para pedidos de lance

• Cabeçalho HTTP da versão OpenRTB: x-openrtb-version: 2.5
• Cabeçalho HTTP Keep-Alive: Connection: Keep-Alive
• Conteúdo JSON: Content-Type: application/json

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

Objeto da solicitação 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	Matriz de objetos Imp que representam as impressões oferecidas (objeto).
site	Sim	Detalhes sobre o site do editor (objeto).
aplicação	Sim	Detalhes sobre a aplicação do editor (objeto).
device	Sim	Detalhes sobre o dispositivo do utilizador ao qual a impressão será entregue (objeto).
user	Não	Detalhes sobre o utilizador humano do dispositivo; o público-alvo publicitário (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).
banner	Apenas para impressões de página inteira	Um objeto de banner (objeto).
secure	Não; Recomendado 1	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)

imp.banner

Atributo	Obrigatório?	Descrição
w	Sim	Largura do banner (inteiro)
h	Sim	Altura do banner (inteiro)
mimes	Sim	Tipos MIME - image/jpg, image/png, video/mp4 ou image/webp

imp.video

Atributo	Obrigatório?	Descrição
mimes	Sim	Tipos MIME de conteúdo suportados (por exemplo, "video/mp4") (matriz de strings)
minduration	Não	Duração mínima do anúncio em vídeo em segundos (inteiro)
maxduration	Não	Duração máxima do anúncio em vídeo em segundos (inteiro)
protocols	Não	Matriz de protocolos de vídeo suportados (inteiro)
linearity	Não	Indica se a impressão deve ser linear, não linear, etc. Se não for especificado nenhum, assuma que todos são permitidos (inteiro)
boxingallowed	Não	Indica se é permitida a letterboxing de conteúdo 4:3 numa janela 16:9, onde 0 = não, 1 = sim (inteiro)
pos	Não	Posição do anúncio no ecrã (inteiro)
h	Não	Largura do reprodutor de vídeo em píxeis independentes do dispositivo (DIPS) (inteiro)
w	Não	Altura do reprodutor de vídeo em píxeis independentes do dispositivo (DIPS) (inteiro)
ext	Não	Espaço reservado para extensões específicas da exchange ao OpenRTB (objeto)

imp.video.ext

Atributo	Obrigatório?	Descrição
zone_type	Não	Tipo de zona dentro dos formatos de anúncios do ExoClick (por exemplo: video_slider)
cta	Não	Especifica se a zona de anúncio mostra um componente CTA (inteiro)

site

Atributo	Obrigatório?	Descrição
id	Recomendado	ID exclusivo do site (string)
nome	Não	Nome do site (string)
domain	Recomendado	Nome de domínio 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úncio recebam o tipo certo de publicidade. As palavras-chave devem ser uma string de palavras separadas por vírgulas

site.ext

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

aplicação

Atributo	Obrigatório?	Descrição
id	Recomendado	ID único da aplicação (string)
nome	Não	Nome da aplicação (string)
domain	Recomendado	Nome do domínio 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)
editor	Não	Detalhes sobre o editor (objeto)

device

Atributo	Obrigatório?	Descrição
ua	Sim	User agent do navegador (string)
sua	Não	Informações estruturadas do user agent, que podem ser usadas quando um cliente suporta User-Agent Client Hints (objeto)
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 IPv4 do utilizador (string)*
ipv6	Sim	Endereço IPv6 do usuário (string)*
language	Recomendado	Idioma do navegador (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)

device.sua

Informações estruturadas do User Agent. device.sua é considerada a representação mais precisa dos atributos do dispositivo.

Atributo	Obrigatório?	Descrição
browsers	Recomendado	Os implementadores devem enviar marcas e versões derivadas do cabeçalho Sec-CH-UA-Full-Version-List. (Matriz de BrandVersion objetos)
platform	Recomendado	Os implementadores devem enviar uma marca derivada do cabeçalho Sec-CH-UA-Platform e uma versão derivada do cabeçalho Sec-CH-UA-Platform-Version. (BrandVersion Objeto)
mobile	Recomendado	Os implementadores devem derivar este valor do cabeçalho Sec-CH-UA-Mobile. (inteiro)
architecture	Recomendado	Os implementadores devem obter este valor do cabeçalho Sec-CH-UA-Arch. (string)
bitness	Recomendado	Os implementadores devem obter este valor do cabeçalho Sec-CH-UA-Bitness. (string)
model	Recomendado	Os implementadores devem obter este valor do cabeçalho Sec-CH-UA-Model. (string)
source	Recomendado	A origem dos dados usada para criar este objeto, Lista: Origem do User-Agent no AdCOM 1.0 (inteiro; padrão 0)

device.sua.browsers | device.sua.platform

Atributo	Obrigatório?	Descrição
brand	Obrigatório	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	Recomendado	Uma sequência de componentes da versão, em ordem hierárquica decrescente [maior, menor, micro, …] (matriz de strings)

user

Atributo	Obrigatório?	Descrição
id	Não	ID exclusivo do usuário (string)
ext	Não	Espaço reservado para extensões específicas da exchange ao OpenRTB (objeto)

user.ext

Atributo	Obrigatório?	Descrição
consentimento	Não	Esta é a string de consentimento exigida pelas normas da IAB. Apenas consentimento negativo, por agora (string)

regs

Atributo	Obrigatório?	Descrição
ext	Não	Espaço reservado para extensões específicas da exchange ao OpenRTB (objeto)

regs.ext

Atributo	Obrigatório?	Descrição
gdpr	Não	É 0 se o chamador acreditar que o utilizador não está sujeito ao RGPD, e 1 se o utilizador estiver sujeito ao RGPD. Se nenhum dos dois, este parâmetro ficará indefinido.

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.