For Buyers
Introduction
ADPIE-Exchange is platform to simplify integration of Demand Side Platform(DSP) with Sell Side Platform(SSP). This document defines the protocol for interaction between DSP and ADPIE-exchange.
Integration Spec
Basically support OpenRTB 2.3 and OpenRTB Native-Ads-Specification 1.1, including scalability use extension field. Addition/deletion of field is available according to application.
• HTTP 1.1 based POST method
• Data Format: JSON
• Not support Multiple impression per one request
• Support some parts of OpenRTB 2.5 and OpenRTB Native-Ads-specification 1.2.
• Supported Ad Formats: Banner, Native, Rewarded video
• Supported Size: 320x50, 320x100, 320x480, 300x250, 1200x627, 1280x720, 720x1280
Bid Request
Bid Request Object
id
string
O
unique ID of the bid request
“bb046a99 f84dad1fa 7ac3b0ce4 bc4dd3”
imp
array of objects
O
impression object
The current version supports only 1 Imp object.
app
object
O
app object(i.e., non-browser applications). Only applicable and recommended for apps.
Either site or app object should be present.
site
object
O
site object.
Only applicable and recommended for websites.
Either site or app object should be present.
device
object
O
Device Object which describes the device the impression will be delivered to.
user
object
O
User Object which describes the user.
tmax
integer
Maximum time in milliseconds to submit a bid to avoid timeout.(milliseconds)
400
cur
array of strings
Array of allowed currencies for bids on this bid request.
[“USD”]
bcat
array of strings
Blocked Advertiser Categories. (Refer to 5.4 Content Categories)
["IAB7","IAB26","IAB25-3","IAB7-17 "]
badv
array of strings
[“block1.com”,“block2.com”]
at
integer
Auction type, where 1=First Price, 2=Second Price Plus.
2
ext
object
Impression ext object for exchange-specific extensions to OpenRTB.
Impression Object
id
string
O
impression ID within the bid request.
“1”
banner
object
Banner object. Required for banner impressions.
native
object
bidfloor
float
Bid floor as set by the SSP. The currency is the same as specified in cur field.
0.01080
bidfloorcur
string
Bid floor currency specified using ISO-4217 alpha codes.
“USD”
secure
integer
0 for non-secure pages (default); 1 for secure pages. Creatives for secure pages should be SSL-compliant.
0
instl
integer
1 if the ad is interstitial or full screen; else 0 (i.e., no).
1
pmp
object
Private Marketplace object
tagid
string
Identifier for specific ad placement or ad tag that was used to initiate the auction. This can be useful for debugging of any issues, or for optimization by the buyer.
displayman ager
string
Name of ad mediation partner, SDK technology, or player responsible for rendering ad (typically video or mobile).
“adpiessdk”
displayman agerver
string
Version of ad mediation partner, SDK technology, or player responsible for rendering ad (typically video or mobile).
"011402"
Banner Object
id
string
Unique identifier for this banner object. Used for tracking multiple banner objects.
"1"
w
integer
O
Width of the impression in pixels.
320
h
integer
O
Height of the impression in pixels.
50
btype
array of integers
Blocked creative types. See Table 5.5 Banner Ad Types. If blank, assume all types are allowed.
[1,3]
battr
array of
integers
Blocked creative attributes. See Table 5.7
[1,4]
Video Object
mimes
array of integers
O
Content MIME types supported
[“video/mp4”]
w
integer
O
Width of the video player in device independent pixels
320
h
integer
O
Height of the video player in device independent pixels
50
minduration
integer
O
Minimum video ad duration in seconds
5
maxduration
integer
O
Maximum video ad duration in seconds
30
protocols
array of integers
O
Array of supported video protocols. Refer to List 5.13.
[1,2,3]
startdelay
integer
Indicates the start delay in seconds for pre-roll, mid-roll, or post-roll ad placements. Refer to List 5.14 for additional generic values.
0
linearity
integer
Indicates if the impression must be linear, nonlinear, etc. If none specified, assume all are allowed. Refer to List 5.15
1
skip
integer
Indicates if the player will allow the video to be skipped, where 0 = no, 1 = yes.
1
skipmin
integer
Videos of total duration greater than this number of seconds can be skippable; only applicable if the ad is skippable.
3
skipafter
integer
Number of seconds a video must play before skipping is enabled; only applicable if the ad is skippable.
5
battr
array of integers
Blocked creative attributes.
See Table 5.7.
[1,3]
boxingallowed
integer
Indicates if letter-boxing of 4:3 content into a 16:9 window is allowed, where 0 = no, 1 = yes.
1
delivery
array of integers
Supported delivery methods. If none specified, assume all are supported. Refer to List 5.17.
[1,2]
api
array of integers
List of supported API frameworks for this impression. Refer to List 5.18. If an API is not explicitly listed, it is assumed not to be supported.
[1,3]
Native Object
request
string
O
Request payload complying with the Native Ad Specification.
ver
string
Version of the Native Ad Specification to which request complies.
"1.1"
battr
array of integers
Blocked creative attributes. See Table 5.7
[1,3]
Native Request Object
assets
string
O
Request payload complying with the Native Ad Specification.
ver
string
Version of the Native Ad Specification to which request complies.
"1.1"
battr
array of integers
Blocked creative attributes. See Table 5.7
[1,3]
Native Asset Object
id
integer
O
Unique asset ID, assigned by exchange
1
required
integer
Set to 1 if asset is required (exchange will not accept a bid without it)
0
title
object
img
object
data
object
Native Asset Title Object
len
integer
O
Maximum length of the text in the title element.
25
Native Asset Image Object
type
integer
O
Type ID of the image element
supported by the publisher. Reter to 5.9
3
w
integer
Width of the image in pixels
1200
h
integer
Height of the image in pixels
627
Last updated