Open RTB Bid Request Specifications
This page explains how to make requests for bids
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 | Array of Imp objects representing the impressions offered(object). |
| 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 | Placeholder for extensions to 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 | Minimum bid for this impression (CPM) / click (CPC) and account currency (float) |
| bidfloorcur | Não | Currency for minimum bid value specified using ISO-4217 alpha codes (string) |
| nativo | Only for native and push imps | A Native object opportunity (object). |
| bandeira | Only for banner imps | A Banner object opportunity (object). |
| instl | Only for pop, direct link and email click imps | A Fullscreen object opportunity (object). |
| vídeo | Only for video | A Video object opportunity (object) |
| seguro | Recomendado | Flag to indicate if the impression requires secure HTTPS URL creative assets and markup, where 0 = non-secure, 1 = secure (recommended option). If omitted, the secure state is unknown, but non-secure HTTP support can be assumed (integer) |
| el | Não | Email codificado em Base64 (string) |
| ext | Não | Placeholder for exchange-specific extensions |
imp.banner
| Atributo | Necessário? | Descrição |
|---|
| w | Sim | Width of the banner (integer) |
| h | Sim | Height of the banner (integer) |
| mímicas | Não | List of supported mime types (string array). We support: image/jpeg, image/jpg, image/png, image/png, image/gif, image/webp, video/mp4 |
| ext | Não | Placeholder for exchange-specific extensions (object) |
imp.banner.ext
| Atributo | Necessário? | Descrição |
|---|
| image_output | Não | Indicates output format for image banners* (string) |
| video_output | Não | Indicates output format for video banners* (string) |
*Defines format of adm field for the banner format. Options are xml or html. Default values is xml in case field not provided.
imp.instl
| Atributo | Necessário? | Descrição |
|---|
| instl | Sim | 0 = direct link/email clicks, 1 = popunder |
imp.native (for Native and Push Notification Ads)
| 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 | The number of identical placements in this Layout. Max: 10 (integer) (integer) |
| 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 | Unique asset ID, assigned by exchange. Typically a counter for the array (integer) 1: Image asset ID, 2: Title asset ID, 3: Description asset ID |
| necessário | Não | Set to 1 if asset is required or 0 if asset is optional (integer) |
| plcmtcnt | Não | O número de colocações idênticas nesta Estrutura (número inteiro) |
| imagem | Sim | Image object for image assets** (JSON object) |
| título | Não | Title object for title assets** (JSON object) |
| 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.
** Only one of the {img, title, data} objects should be present in each asset object
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) |
*Push Notification icon dimensions: 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 |
Note: If you provide only "skip" in the request but not "skipafter", the video will be skippable after 5 seconds. The response will set "skipoffset" to 5. If you provide "skip" but not "skipmin," the video will be skippable regardless of its duration.
imp.ext
| Atributo | Necessário? | Descrição |
|---|
| video_cta | Não | Indicates if CTAs should be provided, where 0 = no, 1 = yes (default 1) |
To see an example of CTA, please check our Response example page.
local
| Atributo | Necessário? | Descrição |
|---|
| id | Required | ID único do sítio (string) |
| domínio | Required | Nome de domínio do sítio (string) |
| name | Required | Name of the site (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 | Keywords can be used to ensure ad zones get the right type of advertising. Keywords should be a string of comma-separated words. |
| 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) |
app
| Atributo | Necessário? | Descrição |
|---|
| id | Required | Unique App ID (string) |
| gato | Não | ID da categoria IAB (cadeia de caracteres) |
| palavras-chave | Não | Keywords can be used to ensure ad zones get the right type of advertising. Keywords should be a string of comma-separated words (string) |
| publisher | Não | Details about the Publisher (object) |
Note: You cannot send "app" object together with "site" or vice versa.
app.publisher
| Atributo | Necessário? | Descrição |
|---|
| domínio | Recomendado | Highest level domain of the publisher (e.g., "publisher.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) |
Note: If you cannot generate a user ID string, you can leave it empty (""). The request will get a response as long as "user" object is included in the request.
ext
| Atributo | Necessário? | Descrição |
|---|
| submarino | Não | The Sub ID. This should be a number between six and ten digits: Do not use zeroes at the beginning of Sub IDs. |
| exportação | Não | A resposta pode ser "json" ou "xml" (string). Por defeito, é "json". |
Nota: As Sub IDs devem ser um número entre 1 e Int32: Não utilize zeros no início dos Sub IDs.
Exemplos
You can find a detailed list of Request examples in our example page