OpenRTB API for Bidding

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

Value of “200” often sent, dynamic values for some header bidding/S2S auctions may differ

To avoid long request messages, we limit the number of entities that may be included in wseat lists. BidRequest object limit =50. Deals object limit= 20. If the limit is exceeded, the wseat field will be absent. An allowlist still exists in our system and it is enforced. It won’t be sent in the bid request. Bids returned from buyers not on the allowlist are rejected ( appropriate loss reason noted in reporting). For requests without wseat present, any buyer may and should be sent. We filter the bids as needed on our side. If wseat is not present for a deal, assume all seats are eligible and bid with them.

USA - US Dollar (USD)

Canada - Canadian Dollar (CAD)

Brazil - Brazilian Real (BRL)

United Kingdom - British Pound (GBP)

France, Spain, Italy, Germany - Euro (EUR)

Japan - Japanese Yen (JPY)

Values "IAB26", "IAB25", "IAB24" usually passed when included.

Identifier of the OM SDK integration. Same as the "name" parameter of the OMID Partner object.

SDK passed here for app traffic when available

SDK Version passed here for app traffic when available

USA - US Dollar (USD)

Canada - Canadian Dollar (CAD)

Brazil - Brazilian Real (BRL)

United Kingdom - British Pound (GBP)

France, Spain, Italy, Germany - Euro (EUR)

Japan - Japanese Yen (JPY)

For app, the common fixed interstitial size (e.g., 320x480) is sent to indicate orientation (vs 480x320). 

Typical banner value=*.*

Typical values =video/mp4 or video/3gpp

Typical values=2,3,5 or 6

Typical value=0

Typical value=1

Typical values=1,2 or 3

Used to communicate mandatory skippability. Typical value=0 or 1.

Sample Request

"request":"{\"plcmtcnt\":1,\"assets\":[{\"id\":1,\"required\":1,\"img\":{\"type\":3,\"w\":200,\"wmin\":150,\"h\":300,\"hmin\":280,\"mimes\":[\"image/jpg\",\"image/gif\"]}},{\"id\":2,\"required\":1,\"data\":{\"type\":2,\"len\":200}},{\"id\":3,\"required\":1,\"title\":{\"len\":75}},{\"id\":4,\"required\":1,\"data\":{\"type\":12,\"len\":100}}],\"context\":2,\"contextsubtype\":15,\"plcmttype\":1,\"ver\":\"1.1\",\"seq\":0}",

Typical value=1.1

Yes

No

Yes

No

Yes

No

Last octet of IP address may be suppressed.
Typical value=192.192.192.0

Last 4 hextets of IP address may be suppressed.
Typical value=2c0f:f8f0:c600:1d19:0:0:0:0

Flag indicating whether this request is subject to COPPA regulations established by the USA FTC. 0=no 1=yes

Flag indicates if this request is subject to GDPR.0=not subject to GDPR1=yes subject to GDPR

USA - US Dollar (USD)

Canada - Canadian Dollar (CAD)

Brazil - Brazilian Real (BRL)

United Kingdom - British Pound (GBP)

France, Spain, Italy, Germany - Euro (EUR)

Japan - Japanese Yen (JPY)

Optional override of the overall auction type of the bid

Request. 1=First Price, 2=Second Price Plus, 3= the value passed in bidfloor is the agreed upon deal price.

ID of the Bid Request

A response ID generated by the bidder for tracking purposes.

Each bid object corresponds to imp object in the bid request

ID of the imp object to which the bid applies

Maximum precision of 8 digits to the right of the decimal point (e.g., 12.12345678). The maximum "price" is $1,000 CPM. Bids with higher pricing will be considered $1,000 CPM

ID of the ad for buyer

Admarkup. Note: if an auction winner fails to return ad markup via the “adm” or win notice response, then the win will be forfeited and the Marketplace will select a new winner.

Campaign ID

Creative ID

Advertiser Top Level Domain

URL to an image that represents the content of the campaign. Used for ad quality and safety checking

Billing Notification URL, fired upon confirmation that a creative has been delivered to a device ((SSP considers delivery as a billable event). All existing win notice url macros are available. DSP must notify VMX on intentions to use burl.