RTB Protocol

This article presents the SSP heart of the Verizon Media Ad Platform API and the Real-Time Bidding protocol.

Ad requests originate from publisher apps and sites; both mobile web and mobile applications. For each inbound request to the Verizon Media SSP, bid requests are broadcast to interested bidders, responses are evaluated, the winner is notified, and ad markup is served. The most common form of this interaction is shown in the figure below.

Transport

Transport is the communications channel between SSP and the bidders and is configured in the following way:

  • The Verizon Media SSP sends bid requests via HTTP POST.
  • Multiple exchange nodes attempt to establish persistent HTTP connections to each bidder.
  • Any HTTP 1.1 connection is considered persistent. All connections will include the “keep-alive” headers.

Protocol

Below is SSP’s implementation of the OpenRTB 2.3 spec. Protocol pertains to the actual auction conversation between our SSP and bidders as well as the mechanism for serving the winning ad.

Bid Request

SSP RTB bid requests always carry a single impression request. The Verizon Media SSP supports the concept of multiple seats per bidder.

BidRequest

Attribute Usage Additional Information

id

Supported

 

at

Supported

Although optional, always included on SSP RTB bid requests.
1=First Price auctions 2=Second Price Plus. Most auctions are Second Price Plus.

tmax

Not supported

Set at exchange level, therefore not passed in requests 

wseat

Not supported

 

allimps

Not supported

 

cur

Not supported

Always USD

bcat

Supported

May be suppressed. SSP uses custom categories in addition to the standard IAB advertising categories.
Please see Custom Categories for a full list.

badv

Supported

May be suppressed. May contain subdomains but not full URLs (e.g., "focus.ford.com" as well as "ford.com")

test

Not supported

 

ext

--

Nexage custom attributes:

  omidpn

Supported

Identifier of the OM SDK integration (i.e., "Verizon Media") if certification applies to impression opportunity

omidpv

Supported

Version of the OM SDK integration (i.e., "1.2.5") if certification applies to impression opportunity

 

Imp

Attribute Usage Additional Information

id

Supported

 

displaymanager

Supported

 

displaymanagerver

Supported

 

instl

Supported

 

tagid

Not supported

 

bidfloorcur

Not supported

 

iframebuster

Not supported

 

secure

Supported

 

ext

--

Nexage custom attributes:

nex_sd

Supported

Session depth (i.e., n'th ad of this user session; 0 = greater than 10)

nex_cpi

Supported

CPI tracking strings:  { "cts": "string", "dids": "string" }

nex_screen

Supported

Allow bids: 0 = without restriction, 1=have "adomain" AND "iurl", 2="adomain", 3="iurl";
4="adomain" OR "iurl".  Options 1-4 also require "cid".

 

Banner

Attribute Usage Additional Information

v

Not supported

 

h

Supported

 

w

Supported

 

hmin

Not supported

 

wmin

Not supported.

 

hmax

Not supported

 

wmax

Not supported

 

pos

Supported

 

battr

Supported

 

btype

Supported

 

mimes

Not supported

 

topframe

Not supported

 

expdir

Not supported

 

api

Supported

 

ext

--

Currently no extensions

 

Video

Attribute Usage Additional Information

h

Supported

 

w

Supported

 

pos

Supported

 

battr

Supported

 

mimes

Supported

 

linearity

Supported

 

minduration

Supported

 

maxduration

Supported

 

protocol

Supported

Scheduled for deprecation in upcoming OpenRTB version

protocols

Supported

 

startdelay

Supported

 

sequence

Not supported

 

maxextended

Not supported

 

minbitrate

Not supported

 

maxbitrate

Supported

 

boxingallowed

Not supported

 

playbackmethod

Supported

 

delivery

Not supported

 

companionad

Not supported

 

api

Supported

 

ext

--

Nexage custom attributes:

skippable

Supported

Used to communicate mandatory skippability

skipthreshold

Supported

Video length skip threshold for mandatory skippable video ads

skipoffset

Supported

Time when the skip button appears

 

Native

Attribute Usage Additional Information

request

Supported

 

ver

Supported

 

api

Supported

 

battr

Not supported

 

ext

--

Currently no extensions

 

Site

Attribute Usage Additional Information

id

Supported

May be aliased

name

Supported

May be aliased or suppressed 

domain

Supported

May be suppressed

cat

Supported

 

sectioncat

Not supported

 

pagecat

Not supported

 

keywords

Supported

 

mobile

Supported

 

page

Supported

May be suppressed

ref

Supported

May be suppressed

search

Supported

 

privacypolicy

Not supported

 

ext

--

Nexage custom attributes:

  nex_???

Supported

Extended attributes called "???" passed as an extended site attribute

 

App

Attribute Usage Additional Information

id

Supported

May be aliased

name

Supported

May be aliased or suppressed

domain

Supported

May be suppressed

cat

Supported

 

sectioncat

Not supported

 

pagecat

Not supported

 

keywords

Supported

 

ver

Not supported

 

bundle

Supported

 

paid

Not supported

 

storeurl

Supported

 

privacypolicy

Not supported

 

ext

--

Nexage custom attributes:

  nex_???

Supported

Extended attributes called "???" passed as an extended App attribute

 

Publisher

Attribute Usage Additional Information

id

Supported

May be aliased

name

Supported

May be aliased or suppressed

domain

Not supported

 

cat 

Not supported

 

ext

--

Nexage custom attributes:

  nex_else

Supported

For bidders with expanded Data contracts

  imp.hb

Supported

1 for header bidding, not present on non-header bidding requests

 

Content

Attribute Usage Additional Information

id

Not supported

 

episode

Not supported

 

title

Not supported

 

series

Not supported

 

season

Not supported

 

url

Not supported

 

cat

Not supported

 

videoquality

Not supported

 

keywords

Not supported

 

contentrating

Not supported

 

userrating

Not supported

 

context

Not supported

 

livestream

Not supported

 

sourcerelationship

Not supported

 

len

Not supported

 

qagmediarating

Not supported

 

embeddable

Not supported

 

language

Not supported

 

ext

 

Currently no extensions

 

Producer

Attribute Usage Additional Information

id 

Not supported

 

name

Not supported

 

domain

Not supported

 

cat

Not supported

 

ext

 

Currently no extensions

 

Device

Attribute Usage Additional Information

ua

Supported

 

ip

Supported

 

ipv6

Not supported

 

dnt

Supported

Available for iOS 6+ only; 0/1 value is inverted from the iOS setting

lmt

Supported

Same as dnt

ifa

Supported

 

didsha1

Supported

 

didmd5

Supported

 

dpidsha1

Supported

 

dpidmd5

Supported

 

macsha1

Supported

 

macmd5

Supported

 

carrier

Supported

 

make

Supported

 

model

Supported

 

os

Supported

 

osv

Supported

 

js

Supported

 

language

Supported

 

h

Not supported

 

w

Not supported

 

pxratio

Not supported

 

ppi

Supported

 

hwv

Supported

 

connectiontype

Supported

 

devicetype

Supported

 

flashver

Not supported

 

ext

--

Nexage custom attributes:

  nex_ifasha1

Supported

iOS Advertiser ID hashed as SHA1

  nex_ifamd5

Supported

iOS Advertiser ID hashed as MD5

  nex_???

Supported

Extended attributes called "???" passed as an extended Device attribute

 

Geo

Attribute Usage Additional Information

lat

Supported

Supported when device location services are enabled

lon

Supported

Supported when device location services are enabled

country 

Supported

 

city

Supported

 

zip

Supported

 

metro

Supported

Supported when device location services are enabled

region

Supported

Supported for USA states only; only the region part of the ISO-3116-2 codes are included

regionfips104

Not supported

 

utcoffset

Not supported

 

type

Supported

Hard coded for User.Geo objects.

ext

--

Currently no extensions

 

User

Attribute Usage Additional Information

id

Supported

 

buyeruid

Supported

 

yob

Supported

 

gender

Supported

 

keywords

Supported

 

customdata

Not supported

 

ext

--

Nexage custom attributes:

  nex_eth

Supported

Ethnicity as "0" (African-American), "1" (Asian), "2" (Hispanic), "3" (White), or "4" (Other)

  nex_marital

Supported

Case sensitive marital status as "S", "M", "D", or "O" for single, married, divorced, or other

  nex_kids

Supported

Case sensitive indicator of any kids within the household as "Y" or "N" for yes or no

  nex_hhi

Supported

Household income in local base units (e.g., Dollars, Euros, Yen) annually

  nex_dma

Supported

Designated Market Area (DMA) by Nielsen Media Research of the consumer's home base. 

  nex_???

Supported

Extended attributes called "???" passed as an extended User attribute

  consent

Supported

IAB Consent string provided when the request is subject to GDPR

 

Data
Attribute Usage Additional Information

id

Not supported

 

name

Not supported

 

segment

Not supported

 

ext

--

Currently no extensions

 

Segment

Attribute Usage Additional Information

id

Not supported

 

name

Not supported

 

value

Not supported

 

ext

--

Currently no extensions

 

Regs

Attribute Usage Additional Information

coppa

Supported

 

ext

--

Nexage custom attribute:

  gdpr

Supported

0 - indicates request not subject to GDPR, 1 - indicates request is subject to GDPR

 

Pmp

Attribute Usage Additional Information

private_auction

Not supported

Omitted by design because PMP's may contain both public and private deals

deals

Supported

 

ext

--

Currently no extensions

 

Deal

Attribute Usage Additional Information

id

Supported

 

at

Supported

 

bidfloor

Supported

 

bidfloorcur

Not supported

Assumed to be "USD"

wseat

Supported

 

wadomain

Supported

 

ext

--

Currently no extensions

For information on video bid responses see Mobile Video Specs and SSL Requirements for Buyers.

For information on how SSP has implemented other versions of the OpenRTB spec, reach out to your Demand Services Manager.