Anúncios em vídeo do OpenRTB

Este guia descreve os requisitos de integração para a compra de RTB usando o protocolo do OpenRTB. Este guia precisa ser usado em conjunto com a Integração do OpenRTB, em que os campos discutidos aqui são descritos em detalhes.

Se você comprar em apps iOS com snippets HTML que incluem tags <video>, precisará incluir o atributo playsinline na tag de vídeo. Caso contrário, os usuários têm uma experiência muito ruim, em que os anúncios em vídeo que deveriam ser exibidos no criativo parecem aparecer em tela cheia. Os anúncios que não respeitarem essa política serão bloqueados.

Requisitos do comprador

Os novos compradores de RTB precisam desenvolver os bidders usando o buffer de protocolo mais recente e as informações descritas nas seções a seguir. Para fazer o download do protocolo, consulte a página de dados de referência. Para informações sobre como desenvolver um bidder, consulte Processar a solicitação e Criar a resposta.

Macros com suporte

As seguintes macros são compatíveis com criativos de vídeo in-stream:

• %%CACHEBUSTER%%
• %%WINNING_PRICE%%

A substituição da macro é permitida no URL do vídeo, mas não no XML VAST real.

Macros de cliques (como CLICK_URL_ESC) não são necessárias porque o Authorized Buyers inclui rastreadores de cliques em um wrapper VAST. Portanto, as macros de clique não são compatíveis com anúncios em vídeo in-stream. Para mais informações sobre macros compatíveis, consulte Especificar macros em Criar a resposta.

Detalhes do objeto de vídeo

O protocolo OpenRTB usa uma mensagem Video, definida no arquivo openrtb-proto.txt, para identificar solicitações de vídeo e fornecer outras informações específicas do vídeo sobre a solicitação.

Consulte a lista de campos de mensagens de vídeo no Guia de integração do OpenRTB para ver descrições e exemplos detalhados.

Outros campos da solicitação de lance de vídeo

Os indicadores abaixo não são todos exclusivos de criativos de vídeo, mas são partes importantes da solicitação de lance.

Campos do objeto Imp

Esse objeto descreve um posicionamento de anúncio ou uma impressão que estão sendo leiloadas.

banner	Um objeto de banner. Obrigatório se a impressão for oferecida como uma oportunidade de anúncio de banner.
video	Indica o tipo de impressão oferecida (neste caso, vídeo). O vídeo em banner é permitido quando o objeto imp inclui os objetos banner e video.
tagid	É o identificador da posição ou da tag de anúncio específica que foi usada para iniciar o leilão. Isso pode ser útil para depurar problemas ou otimizar o comprador.
bidfloor	Lance mínimo para essa impressão expresso em CPM.
bidfloorcur	Uma única moeda, extraída do billing_id. incluído

Consulte a seção Objeto Imp no guia do OpenRTB para ver mais detalhes.

Campos do objeto do dispositivo

Os campos no objeto Device fornecem informações sobre o dispositivo de destino.

ua	String do user agent do navegador.
ip	Endereço IPv4 mais próximo do dispositivo.
geo	O local do dispositivo é o local atual do usuário definido por um objeto Geo.
devicetype	É o tipo geral de dispositivo.
ifa	É o ID sancionado para uso do anunciante (por exemplo, não com hash). O ifa oferece suporte a dispositivos de smart TV, como Roku, Apple TV, Fire TV e Xbox.

Consulte a seção Objeto do dispositivo no guia do OpenRTB para saber mais.

Objeto do site

Os campos do objeto Site fornecem informações sobre o site com conteúdo com anúncios.

page	URL da página em que a impressão será exibida.
publisher	Detalhes sobre o objeto Publisher do site.
content	Detalhes sobre Content no site.

Consulte a seção de objetos Site no guia do OpenRTB para ver mais detalhes.

Objeto do usuário

Os campos do objeto User fornecem informações sobre o site com conteúdo com anúncios.

id	ID específico da troca para o usuário. É recomendável usar pelo menos id ou buyerid.
data	Detalhes sobre o objeto Publisher do site.

Consulte a seção Objeto do usuário no guia do OpenRTB para saber mais detalhes.

Campos de inventário da solicitação de lance

A solicitação de lance de vídeo também contém informações sobre os tipos de conteúdo e quaisquer anúncios complementares especificados.

mimes

Lista de permissões de tipos MIME de conteúdo compatíveis.

companionad

Matriz de objetos Banner se os anúncios complementares estiverem disponíveis.

Campos de resposta do lance

Os principais campos em uma resposta de lance de vídeo incluem:

id

ID da solicitação de lance à qual esta é uma resposta.

seatbid

Matriz de objetos Seatbid. Um ou mais são necessários para fazer um lance.

seat

Um objeto Seatbid. ID do assento do comprador (por exemplo, o anunciante ou a agência) em nome de quem o lance é feito.

bid

Matriz de um ou mais objetos Bid, cada um relacionado a uma impressão.

Pré-segmentação

Para receber inventário de vídeo, os compradores do OpenRTB precisam ter uma configuração de pré-segmentação que inclua inventário de vídeo.

Exemplo de solicitação e resposta de lance

Solicitação de lance

Mostrar

{
  id: "XIsz9QAHfAYKj3oDMQ3QOg",
  imp: [{
    id: "1",
    banner: {
      w: 300,
      h: 250,
      format:     [{
        w: 300,
        h: 250
      },{
        w: 250,
        h: 250
      }],
      battr:     [5]
    },
    video: {
      mimes:     [video/mp4],
      linearity: 1,
      protocols:     [2,3,5,6],
      w: 300,
      h: 250,
      skip: 1,
      battr:     [5],
      playbackmethod:     [6],
      plcmt: 3
    },
    displaymanager: "GOOGLE",
    tagid: "2111189154",
    bidfloor: 0.01,
    bidfloorcur: "USD",
    secure: 1,
    native: {
      request_native: {
        ver: "1.2",
        assets:       [{
          id: 1,
          required: 1,
          title: {
            len: 25
          }
        },{
          id: 2,
          data: {
            type: 2,
            len: 90
          }
        },{
          id: 3,
          data: {
            type: 12,
            len: 15
          }
        },{
          id: 4,
          data: {
            type: 1,
            len: 25
          }
        },{
          id: 5,
          img: {
            type: 3,
            wmin: 1200,
            hmin: 627
          }
        },{
          id: 6,
          img: {
            type: 2,
            wmin: 100,
            hmin: 100
          }
        },{
          id: 7,
          img: {
            type: 1,
            wmin: 100,
            hmin: 100
          }
        },{
          id: 8,
          data: {
            type: 3,
            len: 5
          }
        },{
          id: 9,
          video: {
            mimes:           [video/mp4]
          }
        }],
        eventtrackers:       [{
          event: 1,
          methods:         [1]
        }],
        adx_ext: {
          style_id: 188961,
          style_height: 250,
          style_width: 300
        }
      },
      ver: "1.2",
      battr:     [5]
    },
    metric:   [{
      type: "click_through_rate",
      value: 0.0006341254338622093,
      vendor: "EXCHANGE"
    },{
      type: "video_completion_rate",
      value: 0.017279919236898422,
      vendor: "EXCHANGE"
    },{
      type: "viewability",
      value: 0.7,
      vendor: "EXCHANGE"
    },{
      type: "session_depth",
      value: 1,
      vendor: "EXCHANGE"
    }],
    adx_ext: {
      billing_id:     [12345567890],
      publisher_settings_list_id:     [5509324247698256194,14109776396365339331],
      allowed_vendor_type:     [3,42,79,4463,4513,4538,4625],
      ampad: "AMP_AD_ALLOWED_AND_NOT_EARLY_RENDERED"
    }
  }],
  site: {
    page: "https:/example.com/school",
    publisher: {
      id: "pub-783270600012345",
      adx_ext: {
        country: "IN"
      }
    },
    content: {
      contentrating: "DV-G",
      language: "en"
    },
    mobile: 1,
    adx_ext: {
      amp: "DIALECT_HTML"
    }
  },
  device: {
    ua: "Mozilla/5.0 (iPad; CPU OS 12_1_4 like Mac OS X) FBOP/5;FBRV/0]",
    ip: "121.222.242.0",
    geo: {
      lat: -26.487831115722656,
      lon: 153.0424346923828,
      country: "AUS",
      region: "AU-QLD",
      zip: "4562",
      utcoffset: 600
    },
    make: "apple",
    model: "ipad",
    os: "iOS",
    osv: "12.1.1",
    w: 768,
    h: 1024,
    pxratio: 2,
    devicetype: 5
  },
  user: {
    id: "CAESEK6jGeddIeo_opp-WrY",
    buyeruid: "anFTbmRJMVF3VXy0",
    customdata: "anFTbmRJMVVXy0",
    data:   [{
      id: "DetectedVerticals",
      name: "DoubleClick",
      segment:     [{
        id: "1263",
        value: "0.5"
      },{
        id: "625",
        value: "0.1"
      }]
    }]
  },
  at: 2,
  tmax: 122,
  cur: [USD],
  bcat: [IAB7-39],
  adx_ext: {
    google_query_id: "ANy-zJFcyG8sUO0_hYbujPqNXbB3bPA"
  }
}

Resposta do lance

Mostrar

{
  "id": "AB1abcDEfghijklMno2pqr",
  "seatbid": [
    {
      "seat": "Example Seat",
      "bid": [
        {
          "id": "12345678901234567890",
          "impid": "1",
          "price": 15,
          "adid": "AB1234-1234",
          "adm": "https://example.com/AdX/win?tag=AbcdEfGhIJ0kLMN2OPQ2RST3UVXyZAB2Cde114eF
          "cid": "12345678901",
          "crid": "1234",
          "adomain": [
            "www.example.com"
          ]
        }
      ]
    }
  ],
  "cur": "USD",
  "bidid": "1234567890123456789"
}

Glossário

Consulte o glossário de vídeos do Authorized Buyers.