Magnite Streaming — OpenRTB Specification for Bidders

Object

Online

Mobile Web

In App

CTV

Bid Object

x

x

x

x

Impression Object

x

x

x

x

Video Object

x

x

x

x

Site Object

x

x

App Object

x

x

Content Object

x

x

x

x

Publisher Object

x

x

x

x

Device Object

x

x

x

x

Geo Object

x

x

x

x

User Object

x

x

Regulations Object

x

x

x

x

PMP Object

x

x

x

x

Direct Deals Object

x

x

x

x

Source

x

x

x

x

Field Name

IAB Open RTB Description

Type

Sample Value

Notes

id

Unique ID of the bid request, provided by the exchange.

String

"3074b60c-0464-4125-a752-136f78c4d00b"

IAB required.

imp

See Impressions Object below

IAB required. 

Magnite CTV exchange: Always present.

site

See Site Object below

IAB recommended for websites.

Magnite CTV exchange: Always present for web browser supply. Supply which is being accessed by a mobile device web browser is represented with a Site object.

app

See App Object below

IAB recommended for in application supply.

Magnite CTV exchange: Always present for application supply

device

See Device object below

IAB required. 

Magnite CTV exchange: Always present.

user

See User object below

IAB recommended.

at

Auction type, where 1 = First Price, 2 = Second Price.

Integer

2

Magnite CTV exchange: Always present.

tmax

Maximum time in milliseconds the exchange allows for bids to be received including Internet latency to avoid timeout.

Integer

250

Magnite CTV exchange: Currently conducts 250 millisecond auctions (June 2015). Some very small percentage of supply may be offered with tmax as low as 150-160 msecs (June 2019).

wseat

White list of buyer seats (e.g., advertisers, agencies) allowed to bid on this impression. IDs of seats and knowledge of the buyer’s customers to which they refer must be coordinated between bidders and the exchange a priori. At most, only one of wseat and bseat should be used in the same request. Omission of both implies no seat restrictions.

Array of strings

["test", "DspCo-GP", "testUFRseat"] or  ["DspCo-GP"]

cur

Array of allowed currencies for bids on this bid request using ISO-4217 alpha codes. Recommended only if the exchange accepts multiple currencies.

Array of strings

["USD"]

IAB required. 

Magnite CTV exchange: Always present.

bcat

Blocked advertiser categories using the IAB content categories.

Array of strings

["IAB1-1", "IAB1-2"]

Magnite CTV exchange: Uses IAB categories

badv

Block list of advertisers by their domains

Array of strings

["iloveny.com", "sprite.com"]

regs

See Regulations object below

Magnite CTV exchange: Always present.

Field Name

IAB Open RTB Description

Type

 Sample Value

Notes

id

Impression identifier: A unique identifier for this impression within the context of the bid request

String

"1"

IAB required. 

Magnite CTV exchange: Always present.    

 June 2014: Magnite CTV currently follows the IAB suggestion that "… [this] value starts with 1, and increments up to n for n impressions…" 

video

See Video object below

IAB required for video impressions 

Magnite CTV exchange: Always present.

displaymanager

Name of ad mediation partner, SDK technology, or native player responsible for rendering ad (typically video or mobile). Used by some ad servers to customize ad code by partner.

String

"testDisplayManager" or "acudeo"

IAB recommended

displaymanagerver

Version of ad mediation partner, SDK technology, or native player responsible for rendering ad (typically video or mobile). Used by some ad servers to customize ad code by partner

String

"2.1.04"

IAB recommended

bidfloor

Minimum bid for this impression expressed in CPM

Float

9.38

bidfloorcur

Currency specified using ISO-4217 alpha codes. This may be different from bid currency returned by bidder if this is allowed by the exchange.

String

"USD"

instl

Interstitial flag: 1 if the ad is interstitial or full screen; else 0 (i.e., no).

Integer

0

Magnite CTV exchange: Always present

tagid

Identifier for specific ad placement or ad tag that was used to initiate the auction. This can be useful for debugging operational issues, or for optimization by the buyer.

String

Magnite CTV exchange: Always present

secure

Secure creatives required flag: Flag to indicate if the impression requires secure HTTPS URL creative assets and markup, where 0 = non-secure, 1 = secure.

Integer

0

Magnite CTV exchange: Always present

If omitted, the secure state is unknown, but non-secure HTTP support can be assumed.

exp

Impression Expiration: Advisory as to the number of seconds that may elapse between the auction and the actual impression.

Integer

1800

Magnite CTV exchange: For publishers who cache their creatives and associated pixels for later use, the Magnite CTV VMP provides the ability to extend the impression pixel wait time before the pixel expires.  Via this field, the bidder is alerted to the fact that the publisher-specific and declared impression pixel expiration time setting within the Magnite CTV console, for the inventory being made available, allowing DSPs to set their pixels with the same value to avoid reporting discrepancies.

ext.viewabilityvendors

Field indicating which viewability vendors’ SDK/tools are integrated with the supply partner for the specific piece of supply offered in the bid request, allowing buyers to include appropriate elements to leverage in the VAST documents returned.

Array of strings

["doubleverify.com ", comscore.com”]

Available options and string values:

 o Integral Ad Science: "‘integralads.com”
 o Comscore “comscore.com”
 o Sizmek “sizmek.com”
 o Adform “adform.com”
 o WhiteOps “whiteops.com”
 o DoubleVerify “doubleverify.com”
 o AVID Open Source SDK “avidopensdk.cp,"
 o MOAT “moat.com”

ext.ssai

SSAI type - Indicates if server-side ad insertion server-side ad insertion (e.g., stitching an ad into an audio or video stream) is in use and the impact of this on asset and tracker retrieval, where

 0 = not in use (or not declared).  This is the default value.
 1 = all client-side,
 2 = assets stitched server-side but tracking pixels fired client-side,
 3 = all server-side stitching an ad into a video stream

Integer

2

Adopted from OpenRTB v3.0 definition.

pmp

See Private Marketplace Object below

Magnite CTV exchange: Present only if the bid request is an offering under any of the three IAB defined Private Market Plac types:Automated Guaranteed, Unreserved Fixed Rate, or Invitation-Only Auction.

Field Name

IAB Open RTB Description

Type

 Sample Value

Notes

mimes

Content MIME types supported.

Array of strings

["application/x-shockwave-flash",  "video/x-flv"]
 or
  [ "video/mp4", "application/javascript" ]

IAB required.

minduration

Minimum video ad duration in seconds

Integer

0

IAB recommended.

Magnite CTV exchange: Always present.

maxduration

Maximum video ad duration in seconds

Integer

30

IAB recommended. Magnite CTV exchange: Always present.

protocols

Array of supported video protocols.

Array of integers

[2,5]

IAB recommended.

 Magnite CTV exchange: The following are supported by the exchange when supported by the publisher in the bid request.
 1 VAST 1.0
 2 VAST 2.0
 3 VAST 3.0
 4 VAST 1.0 Wrapper
 5 VAST 2.0 Wrapper
 6 VAST 3.0 Wrapper
 7 VAST 4.0
 8 VAST 4.0 Wrapper

w

Width of the video player in device independent pixels (DIPS).

Integer

720

IAB recommended.

Magnite CTV exchange: Almost always present.  The exchange requires publishers/suppliers to provide this value.

h

Height of the video player in device independent pixels (DIPS).

Integer

480

IAB recommended.

Magnite CTV exchange: Almost always present.  The exchange requires publishers/suppliers to provide this value.

startdelay

Indicates the start delay in seconds for preroll, midroll, or postroll ad placement.

Integer

0

IAB recommended

linearity

Indicates if the impression must be linear, nonlinear, etc. If none specified, assume all are allowed.

Integer

1

“In-stream” or “linear” (value = 1) video refers to pre-roll, post-roll, or mid-roll video ads where the user is forced to watch ad in order to see the video content. “Overlay” or “non-linear” (value = 2) refers to ads that are shown on top of the video content.

placement

Placement type for the impression.

Integer

1

1 In-Stream
 Played before, during or after the streaming video content that the consumer has requested (e.g., Pre-roll, Mid-roll, Post-roll)
 2 In-Banner
 Exists within a web banner that leverages the banner space to deliver a video experience as opposed to another static or rich media format. The format relies on the existence of display ad inventory on the page for its delivery.
 3 In-Article
 Loads and plays dynamically between paragraphs of editorial content; existing as a standalone branded message.
 4 In-Feed
 Found in content, social, or product feeds
 5 Interstitial/Slider/Floating
 Covers the entire or a portion of screen area but is always on screen while displayed (i.e. cannot be scrolled out of view). Note that a full-screen interstitial (e.g., in mobile) can be distinguished from a floating/slider unit by the imp.instl field.

skip

Skippable Video: Indicates if the player will allow the video to be skipped, where 0 = no, 1 = yes. If a bidder sends markup/creative that is itself skippable, the Bid object should include the attr array with an element of 16 indicating skippable video.

Integer

0

Magnite CTV exchange: Always present.

skipmin

Skippable video minimum duration: Videos of total duration greater than this number of seconds can be skippable; only applicable if the ad is skippable.

Integer

15

Magnite CTV exchange: Always present if skip = 1.

skipafter

Number of seconds a video must play before skipping is enabled; only applicable if the ad is skippable.

Integer

7

Magnite CTV exchange: Always present if skip = 1.

battr

Blocked creative attributes

Array of integers

maxextended

Maximum extended ad duration if extension is allowed.
 If blank or 0, extension is not allowed.
 If -1, extension is allowed, and there is no time limit imposed.
 If greater than 0, then the value represents the number of seconds of extended play supported beyond the maxduration value.

Integer

10

minbitrate

Integer

 15000

maxbitrate

Maximum bit rate in Kbps.

Integer

 20000

boxingallowed

Indicates if letter-boxing of 4:3 content into a 16:9 window is allowed, where 0 = no, 1 = yes.

Integer

1

playbackmethod

Playback methods that may be in use. If none are specified, any method may be used. Only one method is typically used in practice. As a result, this array may be converted to an integer in a future version of the specification. It is strongly advised to use only the first element of this array in preparation for this change.

Array of integers

[1,2]

delivery

Supported delivery methods (e.g., streaming, progressive). If none specified, assume all are supported.

Array of integers

Magnite CTV exchange: Where publishers support streaming creative types (e.g. HLS, DASH), indication of streaming delivery is now indicated with this field. In addition to this field, new streaming MIME types may be seen in the available mime list, specifically "application/vnd.apple.mpegurl” for HLS stream, “application/dash+xml” for MPEG-DASH, and "application/vnd.ms-sstr+xml” for Microsoft Smooth Streaming.)

pos

Ad position on screen

Integer

1

api

List of supported API frameworks for this impression. If an API is not explicitly listed, it is assumed not to be supported

Array of integers

1

Magnite CTV exchange: Supported APIs are:
 1 VPAID 1.0
 2 VPAID 2.0

Field Name

IAB Open RTB Description

Type

 Sample Value

Notes

id

Exchange-specific site ID.

String

"bbea2e39-ad5a-

4211-bfd6-906b4b2ec0e0"

IAB recommended

name

Site name (may be aliased at the publisher’s request).

String

"Magnite CTV TEST SUPPLY site"

domain

Domain of the site (e.g., “mysite.foo.com”).

String

"Magnite CTV.com"

cat

Array of IAB content categories of the site

Array of strings

["IAB1-1", "IAB1-2"]

Magnite CTV exchange: Uses IAB categories.  See the Content Categories list section of the IAB OpenRTB specification for acceptable values.

page

URL of the page where the impression will be shown.

String

http://www.magnite.com/a/video/page.html

ref

Referrer URL that caused navigation to the current page.

String

http://www.magnite CTV.com

privacypolicy

Indicates if the site has a privacy policy, where 0 = no, 1 = yes.

Integer

1

publisher

See Publisher Object below

content

See Content Object below

Field Name

IAB Open RTB Description

Type

 Sample Value

Notes

id

Application ID: Exchange-specific app ID.

String

" h3vde-ed4sh "

IAB recommended.

Magnite CTV exchange: Always present.

name

App name

String

" MusicBox - Audiocaster Radio Music "

May be aliased or masked at the publisher’s request

bundle

A platform-specific application identifier intended to be unique to the app and independent of the exchange. On Android, this should be a bundle or package name (e.g., com.foo.mygame). On iOS, it is typically a numeric ID.

String

"com.Magnite CTV.sample"

Magnite CTV exchange: For iOS, a DSP may ask Magnite CTV to send either the iTunes numeric TrackId string or the package name.  Please work with Magnite CTV Technical Operations team at magnite-rtb@magnite.com to make your selection.

domain

Domain of the application.

String

"foo.com"

storeurl

App store URL for an installed app; for IQG 2.1 compliance.

String

"https://play.google.com/store/apps/details?id=XXXXXXXXX"

cat

Array of IAB content categories of the app.

Array of strings

["IAB1-1", "IAB1-2"]

ver

Application version

string

"1.0.0"

privacypolicy

Indicates if the app has a privacy policy, where 0 = no, 1 = yes.

Integer

1

paid

0 = app free, 1 = version.

Integer

1

publisher

See Publisher Object

content

See Content Object

Field Name

IAB Open RTB Description

Type

 Sample Value

Notes

Id

ID uniquely identifying the content

String

"e31f206a239be5379d639c7fa75183ab"

episode

Episode number.

Integer

6

title

Content title.

String

Video Examples: “Search Committee” (television), “A New Hope” (movie)

series

Content series

String

Video Examples: “The Office” (television), “Star Wars” (movie)

season

Content season

String

"Season 3"

genre

Content genre

String

Genre that best describes the content. Example: “drama”

ext.network

Content network

String

"BigSportsNetwork"

Extension object to support content network.

 This field is relevant to CTV supply and especially CTV/OTT multichannel video programming distributors (“MVNPs”), where these publishers have a number of “channels”, all of which are under a parent Network umbrella branding.  See companion field, ext.channel, below.
 The primary use case for this parameter is for supply from traditional linear TV publisher structures, as may be seen in the examples in the previous column.

ext.channel

Content channel

String

"BigSportsNetNews"

 "BigSportsNetwork2"

 "XBCNY4"

Extension object to support content channel.

 This field is relevant to CTV supply and especially CTV/OTT multichannel video programming distributors (“MVNPs”).  It is used to pass the name of the channel, as the examples in the previous column illustrate.

url

URL of the content, for buy-side contextualization or review.

String

http://www.videohub.com/the.flv

cat

Array of IAB content categories for the content. See Table 6.1 Content Categories.

Array of strings

["IAB1-1", "IAB1-2"]

prodq

Production quality

Integer

In ORTB v2.5, replaces videoquality

videoquality

Video quality per the IAB’s classification. See Table 6.14 Video Quality.

Integer

1

In ORTB v2.5, videoquality deprecated in favor of prodq.

keywords

Comma separated list of keywords describing the content.

String

contentrating

Content rating (e.g., MPAA).

String

userrating

User rating of the content (e.g., number of stars, likes, etc.).

String

"4star"

context

Type of content (game, video, text, etc.).

String

1

sourcerelationship

0 = indirect, 1 = direct.

Integer

1

livestream

0 = not live, 1 = content is live (e.g., stream, live blog).

Integer

0

Len

Length of content in seconds; appropriate for video or audio.

Integer

15

embeddable

Indicator of whether or not the content is embeddable (e.g., an embeddable video player), where 0 = no, 1 = yes.

Integer

0

Id

ID uniquely identifying the content

string

"e31f206a239be5379d639c7fa75183ab"

episode

Episode number.

integer

6

title

Content title.

string

Video Examples: “Search Committee” (television), “A New Hope” (movie)

series

Content series

string

Video Examples: “The Office” (television), “Star Wars” (movie)

season

Content season

string

"Season 3"

genre

Content genre

string

Genre that best describes the content. Example: “drama”

ext.network

Content network

string

BigSportsNetwork

Extension object to support content network.
 This field is relevant to CTV supply and especially CTV/OTT multichannel video programming distributors (“MVNPs”), where these publishers have a number of “channels”, all of which are under a parent Network umbrella branding.  See companion field, ext.channel, below.
 The primary use case for this parameter is for supply from traditional linear TV publisher structures, as may be seen in the examples in the previous column.

ext.channel

Content channel

string

BigSportsNetNews
 BigSportsNetwork2
 XBCNY4

Extension object to support content channel.
 This field is relevant to CTV supply and especially CTV/OTT multichannel video programming distributors (“MVNPs”).  It is used to pass the name of the channel, as the examples in the previous column illustrate.

url

URL of the content, for buy-side contextualization or review.

string

http://www.videohub.com/the.flv

cat

Array of IAB content categories for the content. See Table 6.1 Content Categories.

Array of strings

["IAB1-1", "IAB1-2"]

prodq

Production quality

integer

In ORTB v2.5, replaces videoquality

videoquality

Video quality per the IAB’s classification. See Table 6.14 Video Quality.

integer

1

In ORTB v2.5, videoquality deprecated in favor of prodq.

keywords

Comma separated list of keywords describing the content.

string

contentrating

Content rating (e.g., MPAA).

string

userrating

User rating of the content (e.g., number of stars, likes, etc.).

string

"4star"

context

Type of content (game, video, text, etc.).

string

1

sourcerelationship

0 = indirect, 1 = direct.

integer

1

livestream

0 = not live, 1 = content is live (e.g., stream, live blog).

integer

0

Len

Length of content in seconds; appropriate for video or audio.

integer

15

embeddable

Indicator of whether or not the content is embeddable (e.g., an embeddable video player), where 0 = no, 1 = yes.

integer

Field Name

IAB Open RTB Description

Type

 Sample Value

Notes

id

Exchange-specific publisher ID.

String

"TestPublisher"

name

Publisher name (may be aliased at the publisher’s request).

String

"Magnite CTV Test Publisher"

cat

Array of IAB content categories that describe the publisher.

Array of strings

["IAB1-1", "IAB1-2"]

domain

Highest level domain of the publisher

String

"Magnite CTV.com"

Field Name

IAB Open RTB Description

Type

 Sample Value

Notes

ua

Browser user agent string.

String

"Mozilla/5.0 (Windows NT 6.1; WOW64; rv:30.0) Gecko/20100101 Firefox/30.0"

IAB recommended

geo

See Geo Object below

IAB recommended

dnt

Do not track: If “0”, then do not track Is set to false, if “1”, then do no track is set to true in browser.

Integer

IAB recommended

lmt

“Limit Ad Tracking” signal commercially endorsed (e.g., iOS, Android), where 0 = tracking is unrestricted, 1 = tracking must be limited per commercial guidelines.

Integer

IAB recommended

ip

IPv4 address closest to device.

String

"64.208.202.10"

IAB recommended. Magnite CTV exchange: All bid requests contain either this field or the ipv6 field.

ipv6

IPv6 address closest to device

String

“2001:0db8:85a3:0000:0000:8a2e:0370:7334”

Magnite CTV exchange: All bid requests contain either this field or the ip field.

make

Device make (e.g., “Apple”).

String

“Apple”

model

Device model (e.g., “iPhone”).

String

“iPhone”

os

Device operating system

String

"Windows"

osv

Device operating system

String

"3.1.2"

h

Physical height of the screen in pixels.

Integer

w

Physical width of the screen in pixels.

Integer

flashver

Version of Flash supported by the browser.

String

language

Browser language using ISO-639-1-alpha-2.

String

“en”

connectiontype

Network connection type.

Integer

dpidsha1

Platform device ID (e.g., Android ID); hashed via SHA1.

String

"017823bd574b2d39265d12237aad30875a7cf75c"

macsha1

MAC address of the device; hashed via SHA1.

String

ifa

ID sanctioned for advertiser use in the clear (i.e., not hashed).

String

" BE269CA1-B1F3-479D-B655-CAE6012AB299”

Magnite CTV exchange: As of September 2017, for CTV supply, this may not always be in the form of the iOS or Android syntax- see second example.

 In 2019, as the following iAB specification was finalized in December 2018, Magnite CTV has been evangelizing the adoption of the UUID ifa form, aka “8-4-4-4-12”, to publishers.
 For full details, please see https://iabtechlab.com/wp-content/uploads/2018/12/OTT-IFA-guidelines.final_Dec2018.pdf.

ext.ifa_type

IFA Type: An extension based on the iAB document adoption in December 2018.  The following values may be seen:

 dpid    The generic “device provided id”. Useful for when the device is providing the IFA, but isn't covered by one of the more specific values below

 rida    Roku Identifier for Advertisers

 aaid    Android Advertising ID

 idfa    Apple's Identifier for Advertisers

 afai    Amazon Fire Advertising ID

 msai    Microsoft Advertising ID

 ppid    Publisher Provided ID

 sspid    If there is no supply provided ifa, the Magnite CTV VMP synthesizes an ifa value, which is only useful for frequency capping, and the ifa_type is automatically set by the platform to “sspid”

 sessionid    A "session" id that is only relevant for the specific playback session

String

“sspid”

For full details, please see https://iabtechlab.com/wp-content/uploads/2018/12/OTT-IFA-guidelines.final_Dec2018.pdf.

Magnite CTV exchange:

IMPORTANT - If a DSP would like to receive this extension, please contact Magnite CTV Technical Operations at Magnite-RTB@Magnite CTV.com and request that this extension be enabled.

devicetype

The general type of device

Integer

2

Magnite CTV exchange:  The supported values:

 1 Mobile/Tablet     * Not used in favor of values 4 and 5.
 2 Personal Computer
 3 Connected TV
 4 Phone
 5 Tablet
 6 Connected Device
 7 Set Top Box

Pro tip: For CTV the differences between the IAB defined values of 3, 6 and 7 are subtle.  The primary use of devicetype in the CTV buying context is to look for one of 3, 6, or 7, and if match, the supply being offered is CTV.   If you need to make finer grain determination of the actual user equipment, e.g. Is it a Roku box?, your bidder best examine the ua field.

Field Name

IAB Open RTB Description

Type

 Sample Value

Notes

lat

Latitude from -90.0 to +90.0, where negative is south.

Float

39.8967

lon

Longitude from -180.0 to +180.0, where negative is west.

Float

-143.8956

type

Source of location data; recommended when passing lat/lon.

Integer

2

IAB recommended                                                                                                                            
 1 GPS/Location Services
 2 IP Address
 3 User provided (e.g., registration data)                                                                                         

ipservice

Service or provider used to determine geolocation from IP address if applicable (i.e., type = 2).

Integer

3

county

Country using ISO-3166-1 Alpha-3.

String

"USA"

region

Region code using ISO-3166-2; 2-letter state code if USA.

String

"CA"

metro

Google metro code; similar to but not exactly Nielsen DMAs.

String

"828"

city

City using United Nations Code for Trade and Transport Locations

String

"US  SRU"

http://www.unece.org/cefact/locode/service/location

zip

Zip/Postal Code

String

"95060"

Field Name

IAB Open RTB Description

Type

 Sample Value

Notes

id

Unique consumer ID of this user on the exchange.

String

"e6f5a0b3181a40

36bcb1178d99428f43"

IAB recommended.
 Magnite CTV exchange: Always present.

buyeruid

Buyer-specific ID for the user as mapped by the exchange for the buyer. At least one of buyeruid or id is recommended.

String

"57839052-49023"

IAB recommended
 Magnite CTV exchange supplies the ID string assigned by the bidder, if an ID has previously been received in the user ID cookie sync process.

ext.gdpr_consent

Extension used for GDPR consent string: Conveys user consent when GDPR regulations are in effect, containing the data structure developed by the GDPR Consent Working Group under the auspices of IAB Europe.

String

“BOQfmh_OQfmiAAKACBENBQ-AAAAdt7_______9______9uz_

Gv_v_f__33e8__9v_h_7_-___u_-33d4-_1vX99yPk1-7fNr1tp3c6uWsSJB”

IAB recommended for EEA supply, as if the request is subject to GDPR regulations (i.e., Regs.ext.gdpr = 1). The default sense of consent under GDPR is “opt-out” and as such, an omitted consent string in a request subject to GDPR would need to be interpreted as equivalent to the user fully opting out of all defined purposes for data use by all parties.

Field Name

IAB Open RTB Description

Type

 Sample Value

Notes

eids

Extended Ids: Array of universal / shared ID values

Array

Magnite CTV exchange: IMPORTANT - If a DSP would like to receive this extension, please contact magnite-rtb@magnite.com

eids.source

Source organization: Domain of organization managing the shared id

String

“adserver.org”

eids.uids

Universal IDs: Array of id values for the user

Array

eids.uids.id

Id for the user

String

“43f888e1-2941-4b9f-8dc9-1ffb631b7786”

eids.uids.

ext.rtiPartner

Real time ID partner code: Partner code for specific user id ‘family’

String

“TDID"

Field Name

 Description

Type

 Sample Value

Notes

coppa

US FTC COPPA flag: Flag indicating if this request is subject to the COPPA regulations established by the USA FTC, where 0 = no, 1 = yes.

Integer

1

Magnite CTV exchange: When set to true (=1), the following information is suppressed:
 ·         Device IDs(ifa/dpidisha1/dpidmd5): not sent
 ·         IP/IPv6: last 8/32 bits zeroed out
 ·         Geo info: not sent
 User info: not sent

ext.gdpr

Extension used for GDPR consent

Integer

"gdpr": 0

In an extension object: Signals whether the request is subject to GDPR regulations.
 ·         0=GDPR does not apply
 ·         1=GDPR applies
 Under OpenRTB conventions for optional attributes, omission indicates Unknown

ext.us_privacy

California Consumer Protection Act (“CCPA”) CCPA flags, as passed by publisher to Magnite CTV

String

“1YNY”

Magnite CTV exchange: In an extension object: Passed the CCPA string data supplied by a publisher.

 For more information, please see https://iabtechlab.com/wp-content/uploads/2019/11/U.S.-Privacy-String-v1.0-IAB-Tech-Lab.pdf
 and
 https://iabtechlab.com/wp-content/uploads/2019/11/OpenRTB-Extension-U.S.-Privacy-IAB-Tech-Lab.pdf

Field Name

IAB Open RTB Description

Type

 Sample Value

Notes

private_auction

Private transaction flag: Indicator of auction eligibility to seats named in the Direct Deals object, where 0 = all bids are accepted, 1 = bids are restricted to the deals specified

Integer

1

The private_auction field is present and set to 1 for all three IAB PMP marketplace types, indicating that this supply offering is not exposed to all bidders.

deals

See Direct Deals Object below

Array of objects

Field Name

IAB Open RTB Description

Type

 Sample Value

Notes

id

Deal ID: A unique identifier for the direct deal.

String

"20140527-FL7483-WK-RB-24702"

IAB required

bidfloor

Deal floor / strike price: Minimum bid for this impression expressed in CPM.

Float

22.8

bidfloorcur

Currency specified using ISO-4217 alpha codes.

String

"USD"

This may be different from bid currency returned by bidder if this is allowed by the exchange.

at

Auction type: Optional override of the overall auction type of the bid request, where 1 = First Price, 2 = Second Price Plus, 3 = the value passed in bidfloor is the agreed upon deal price. Additional auction types can be defined by the exchange.

Integer

1

Magnite CTV supports no additional auction types beyond the IAB defined types.

wseat

Buyer seats allowed: Whitelist of buyer seats (e.g., advertisers, agencies) allowed to bid on this deal. IDs of seats and the buyer’s customers to which they refer must be coordinated between bidders and the exchange a priori. Omission implies no seat restrictions.

Array of strings

["400000000012-TradingDeskY”, "80000000014-AgencyA”]

wadomain

Advertiser domains allowed: Array of advertiser domains (e.g., advertiser.com) allowed to bid on this deal. Omission implies no advertiser restrictions.

Array of strings

["iloveny.com", "sprite.com", “advertiser1.com”]

ext.guaranteed

PMP Automated Guaranteed (“AG”)marketplace type flag: Extension, which indicates that the PMP being offered in the Deal object is PMP Automated Guaranteed marketplace type, in contrast to a PMP Unreserved Fixed Rate (“UFR”).

Integer

1

Magnite CTV exchange:
 IMPORTANT - If a DSP would like to receive this extension, please contact Magnite CTV Technical Operations at magnite-rtb@magnite.com and request that this extension be enabled.

Field Name

IAB Open RTB Description

Type

 Sample Value

Notes

complete

Complete flag: Flag indicating whether the chain contains all nodes involved in the transaction leading back to the owner of the site, app or other medium of the inventory, where 0 = no, 1 = yes.

Integer

1

iAB required.

nodes

Supply Chain Nodes: Array of SupplyChainNode objects in the order of the chain. In a complete supply chain, the first node represents the initial advertising system and seller ID involved in the transaction, i.e. the owner of the site, app, or other medium. In an incomplete supply chain, it represents the first known node. The last node represents the entity sending this bid request.

Array

See examples below

iAB required.

ver

Version of the supply chain specification in use, in the format of “major.minor”. For example, for version 1.0 of the spec, use the string “1.0”.

String

1

iAB required.

Magnite CTV exchange:  Magnite CTV supports version 1.0.

Payment ID chain string containing embedded syntax described in the TAG Payment ID Protocol v1.0.

String

1a4e959a1b50034a:7klg6gdmx0

In ORTB v2.5, pchain is under the source object. For ORTB 2.2, 2.3, 2.4 integrations, pchain is under an extension in the bid object

Final Decision: Entity responsible for the final impression sale decision, where 0 = exchange, 1 = upstream source.

Integer

iAB required.

ext.schain

Extension: Supply Chain: For full details, please see https://github.com/InteractiveAdvertisingBureau

/openrtb/blob/master/supplychainobject.md

JSON object

See next section

iAB recommended.
 Magnite CTV exchange:  Magnite CTV requires all publishers to provide these data.
 For OpenRTB versions 2,2, 2,3 and 2.4, this extension field is found in the base bid request JSON object, i.e. ext.schain

Field Name

IAB Open RTB Description

Type

 Sample Value

Notes

complete

Complete flag: Flag indicating whether the chain contains all nodes involved in the transaction leading back to the owner of the site, app or other medium of the inventory, where 0 = no, 1 = yes.

Integer

1

iAB required.

nodes

Supply Chain Nodes: Array of SupplyChainNode objects in the order of the chain. In a complete supply chain, the first node represents the initial advertising system and seller ID involved in the transaction, i.e. the owner of the site, app, or other medium. In an incomplete supply chain, it represents the first known node. The last node represents the entity sending this bid request.

Array

See examples below

iAB required.

ver

Version of the supply chain specification in use, in the format of “major.minor”. For example, for version 1.0 of the spec, use the string “1.0”.

String

1

iAB required.

Magnite CTV exchange:  Magnite CTV supports version 1.0.

Field Name

IAB Open RTB Description

Type

 Sample Value

Notes

asi

Ad System Id: The canonical domain name of the SSP, Exchange, Header Wrapper, etc. system that bidders connect to. This may be the operational domain of the system, if that is different than the parent corporate domain, to facilitate WHOIS and reverse IP lookups to establish clear ownership of the delegate system. This should be the same value as used to identify sellers in an ads.txt file if one exists.

String

1

iAB required.

sid

Seller Id: The identifier associated with the seller or reseller account within the advertising system. This must contain the same value used in transactions (i.e. OpenRTB bid requests) in the field specified by the SSP/exchange. Typically, in OpenRTB, this is publisher.id.

String

iAB required.

rid

Request Id: The OpenRTB Request Id of the request as issued by this seller.

String

1

iAB optional.

name

Seller Name: The name of the company (the legal entity) that is paid for inventory transacted under the given seller_id. This value is optional and should NOT be included if it exists in the advertising system’s sellers.json file.

String

iAB optional.

domain

Seller Business Domain: The business domain name of the entity represented by this node. This value is optional and should NOT be included if it exists in the advertising system’s sellers.json file.

String

iAB optional.

hp

Handles Payments: Indicates whether this node will be involved in the flow of payment for the inventory. When set to 1, the advertising system in the asi field pays the seller in the sid field, who is responsible for paying the previous node in the chain. When set to 0, this node is not involved in the flow of payment for the inventory. For version 1.0 of SupplyChain, this property should always be 1. It is explicitly required to be included as it is expected that future versions of the specification will introduce non-payment handling nodes. Implementers should ensure that they support this field and propagate it onwards when constructing SupplyChain objects in bid requests sent to a downstream advertising system.

Integer

1

iAB required.

Field Name

IAB Open RTB Description

Type

 Sample Value

Notes

id

Bid request identifier: ID of the bid request to which this is a response.

String

"3074b60c-0464-4125-a752-136f78c4d00b"

IAB required.
 Magnite CTV exchange: Required.

seatbid

Array of seatbid objects; 1or more required if a bid is to be made.

Array of objects

IAB required.
 Magnite CTV exchange: Required.

bidid

Bidder generated response ID to assist with logging/tracking.

String

cur

Bid currency using ISO-4217 alphabetic codes

String

“USD”

Magnite CTV exchange: Required.
 If more than one currency was allowed in the bid request.  If USD was only currency allowed in the bid request, this is the only case where USD is assumed.  
 Best practice:  Always send a currency even if only USD is supported by bidder.

nbr

Reason for not bidding

Integer

Use reason codes in the IAB specification

Field Name

IAB Open RTB Description

Type

 Sample Value

Notes

bid

Array of 1 or more Bid objects (Section 4.2.3) each related to an impression. Multiple bids can relate to the same impression.

Array of objects

IAB required.

 Magnite CTV exchange: Required.

seat

ID of the bidder seat on whose behalf this bid is made.

String

Magnite CTV exchange: Strongly encourages bidders to include this field in all bid responses.   This data is helpful to the Magnite CTV operations team when working with a bidder in investigation of creative and/or other issues.

Field Name

IAB Open RTB Description

Type

 Sample Value

Notes

id

Bidder generated bid ID to assist with logging/tracking.

String

IAB required.
 Magnite CTV exchange: Required.

impid

ID of the Imp object in the related bid request.

String

IAB required.
 Magnite CTV exchange: Required.

price

Bid price expressed as CPM although the actual transaction is for a single unit impression only.  Note that while the type indicates float, integer math is highly recommended when handling currencies (e.g., BigDecimal in Java).

Float

IAB required.

 Magnite CTV exchange: Required.

nurl

Win notice URL called by the exchange if the bid wins (not necessarily indicative of a delivered, viewed, or billable ad); optional means of serving ad markup. Substitution macros may be included in both the URL and optionally returned markup.

String

Magnite CTV exchange:   Check WINNER NOTIFICATION section below for details

adm

Optional means of conveying ad markup in case the bid wins; supersedes the win notice if markup is included in both. Substitution macros (Section 4.4) may be included.

String

adid

ID of a preloaded ad to be served if the bid wins.

String

adomain

Advertiser domain for block list checking (e.g., “ford.com”). This can be an array of for the case of rotating creatives. Exchanges can mandate that only one domain is allowed.

Array of stings

Magnite CTV exchange:  As of 25 April 2016, this field is required in all bid responses.  Please note that the value should be reflective of the actual advertiser, which may not be the domain of the click-thru URL.

Iurl

URL without cache-busting to an image that is representative of the content of the campaign for ad quality/safety checking.

String

Magnite CTV exchange:  Strongly encourages bidders to include this field in all bid responses.

cid

Campaign ID to assist with ad quality checking; the collection of creatives for which iurl should be representative.

String

Magnite CTV exchange:  Strongly encourages bidders to include this field in all bid responses.

crid

Creative ID to assist with ad quality checking.

String

Magnite CTV exchange:  As of 25 April 2016, this field is required in all bid responses. 

attr

Set of attributes describing the creative.

Array of integers

Magnite CTV exchange:  Strongly encourages bidders to include this field in all bid responses.

dealid

Reference to the deal.id from the bid request if this bid pertains to a private marketplace direct deal.

String

Magnite CTV exchange:  For PMP responses, the Bid object dealid must be included, as is required in this case by the IAB.

Macro

Description

${AUCTION_ID}

ID of the bid request; from BidRequest.id attribute.

${AUCTION_BID_ID}

ID of the bid; from BidResponse.bidid attribute.

${AUCTION_IMP_ID}

ID of the impression just won; from imp.id attribute.

${AUCTION_SEAT_ID}

ID of the bidder seat for whom the bid was made.

${AUCTION_AD_ID}

ID of the ad markup the bidder wishes to serve; from bid.adid attribute.

${AUCTION_PRICE}

Clearing price using the same currency and units as the bid.

${AUCTION_CURRENCY}

The currency used in the bid (explicit or implied); for confirmation only.