5.7 Upgrade Guide¶

BidSwitch supports Open RTB 2.6 through its 5.7 protocol. The following details and tables provides an overview of the differences when upgrading from 5.3 (ORTB 2.5) to 5.7 (ORTB 2.6). You can also find examples in the Bid Request JSON Examples section.

Due to the nature of the Open RTB 2.6 specification, BidSwitch supports this in a slightly different manner than previous versions. Previously each new 2.x version built on prior versions by adding new fields, but a large part of 2.6 reorganises the existing JSON structure, and many of the moved fields require validation.

In order to prevent duplicating fields, their validation, and sending bloated bid requests, you must inform BidSwitch when you are ready for open RTB 2.6 and we will configure your account to receive the new format.

Moved Fields¶

Mapping Table - Moved Fields¶
5.3 Field	5.7 Equivalent
`source.ext.schain`	`source.schain` see the Source Object section for details.
`regs.ext.gdpr`	`regs.gdpr` see the Regs Object section for details.
`regs.ext.us_privacy`	`regs.us_privacy`
`user.ext.consent`	`user.consent` see the User Object section for details.
`user.ext.eids`	`user.eids`
`video.ext.rewarded`	`imp.rwdd` see the Impression Object section for details.
`imp.ext.ssai`	`imp.ssai`
`site.ext.inventorypartnername`	`site.inventorypartnername`
`app.ext.inventorypartnername`	`app.inventorypartnername`

Request Fields¶

New Request Fields¶
Object	Equivalent
Bid Request 5.7	Added `wlang`, `wlangb`, and `cattax`
Site Object	Added `site.kwarray`, `site.cattax`, `site.sectioncat`, `site.pagecat`, and `site.search`
App Object	`app.kwarray`, `app.cattax`, `app.sectioncat`, and `app.pagecat`
Impression Object	`imp.rwdd`, `imp.clickbrowser`, `imp.ssai`, `imp.qty`, `imp.dt`, `imp.refresh`, `imp.qty.multiplier`, `imp.qty.sourcetype`, `imp.qty.vendor`, `imp.refresh.refsettings`, `imp.refresh.count`’, `imp.refresh.refsettings.reftype`, `imp.refresh.refsettings.minint`, `imp.ext.skadn.productpage`
Banner Object	Added `banner.vcm` and `banner.id`, see the section.
Video Object	`video.rqddurs`, `video.maxseq`, `video.poddur`, `video.podid`, `video.podseq`, `video.slotinpod` and `video.mincpmpersec`
Audio Object	`audio.rqddurs`, `audio.maxseq`, `audio.poddur`, `audio.podid`, `audio.podseq`, `audio.slotinpod`, and `audio.mincpmpersec`
Format Object	`format.wmin`, `format.hratio` and `format.wratio`
Deal Object	`pmp.deals.wadomain`
Content Object	`content.langb`, `content.cattax`, `content.network`, `content.channel`, `content.producer`, and `content.kwarray`
Device Object	`device.sua`, `device.ppi`
Regs Object	`regs.gpp`, `regs.gpp_sid`
DOOH Object	`dooh.id`, `dooh.name`, `dooh.venuetype`, `dooh.venuetypetax`, `dooh.publisher`, `dooh.domain`, `dooh.keywords`, `dooh.content`

Response Fields¶

New/Updated Response Fields¶
Object	New Fields
Bid Response 5.7	`seatbid.group`
Bid Object	`seatbid.bid.slotinpod`, `seatbid.bid.mtype`, `seatbid.bid.dur`, `seatbid.bid.ext.duration`, `seatbid.bid.ext.skadn.productpageid`, `seatbid.bid.ext.skadn.sourceidentifier`

Deprecated Fields¶

Deprecated Fields¶
Object	Deprecated Fields
User object	Deprecated `user.gender` and `user.yob`
Device Object	Deprecated `device.didsha1`, `device.didmd5`, `device.dpidsha1`, `device.dpidmd5`, `device.macsha1`, and `device.macmd5`
Video Object	Deprecated `video.placement`, replaced with `video.plcmt`