BidRequest
Data for bid requests is sent in JSON RFC 4627 format and all fields are considered case-sensitive.
BidRequest object
The top level bid request object and accompanying fields are below, followed by each lower level object contained within it.
| Field | Type | Description |
|---|
id | String; required | The Auction ID generated by Prebid.js. |
imp | Array of Objects; required | The Impression Object. Contains at least one Banner Object or Video Object. |
device | Object; required | The Device Object. |
tmax | Integer; required | Maximum time in milliseconds that AIDEM allows to receive bids. |
cur | Array of Strings; required | The currencies that publishers will accept in bid responses. For more information, see List of currencies. |
tz | Integer; optional | The client timezone offset. |
regs | Object; required | The Regulations Object. |
site | Object; required | The Site Object. |
environment | Object; required | The Environment Object. |
at | Integer; required | The Auction type where:
1 = first price
2 = second price |
Impression object
This object describes an ad placement or impression opportunity being auctioned. A single impression opportunity may allow one or multiple creative types such as banner and video. Bid responses should only include creative types that are allowed for the respective impression opportunity.
| Field | Type | Description |
|---|
id | String; required | The unique identifier of this impression. |
tid | String; required | The unique identifier of the BidRequest transaction. |
tagid | String; optional | A unique identifier for the ad placement or ad tag on a publisher's website that was used to initiate the auction. |
mediatype | String; required | The media type. One of banner, video. |
banner | Object; optional | The Banner Object.
Note: All requests must include at least one Banner Object or Video Object. |
video | Object; optional | The Video Object.
Note: All requests must include at least one Video Object or Banner Object. |
floor | Object; optional | The Floor Object |
imp_ext | Object; optional | JSON object containing arbitrary first party data. |
Banner object
This object is describes a banner ad impression.
| Field | Type | Description |
|---|
topframe | Integer; required | Specifies whether the banner ad is delivered in the top frame or in an iFrame, where:
0 = ad is displayed in an iframe
1 = ad will not be displayed in an iframe. |
format | Array of Objects; required | Array of Format Object objects specifying the banner sizes permitted for an impression opportunity. |
Video object
| Field | Type | Description |
|---|
context | String; required | Video placement where:
instream = instream video
outstream = outstream video |
mimes | Array of Strings; required | A list of supported video content MIME types. Popular MIME types supported by HTML5 players include:
video/mp4
video/webm
video/ogg |
protocols | Array of Integers; required | An array of supported video protocols. At least one supported protocol must be specified, where:
2 = VAST 2.0
3 = VAST 3.0
5 = VAST 2.0 wrapper
6 = VAST 3.0 wrapper |
maxduration | Integer; optional | Maximum video ad duration, in seconds. |
minduration | Integer; optional | Minimum video ad duration, in seconds. |
Floor object
| Field | type | Description |
|---|
value | Float; required | The value of the floor price. |
currency | String; required | One of List of currencies. |
The format object specifies an allowed size, in height and width combination, for a banner impression opportunity. These are typically used in an array where multiple sizes are permitted.
| Field | type | Description |
|---|
h | integer; required | The height in device-independent pixels. |
w | integer; required | The width in device-independent pixels. |
Regulations object
| Field | Type | Description |
|---|
gdpr_applies | Boolean; required | Represents whether the user in question is in an area where GDPR applies. |
usp_applies | Boolean; required | Represents whether the user in question is in an area where US Privacy applies. |
coppa_applies | Boolean; required | Specifies whether this request is subject to the United States Children’s Online Privacy Protection Act (COPPA), where:
false = no
true = yes
Note: BidRequest with coppa=1 will not be processed by AIDEM. |
us_privacy | String; optional | US Privacy/CCPA notice and opt-out status information. |
Device object
| Field | Type | Description |
|---|
ua | String; required | The content of the HTTP_USER_AGENT header for this user. Anything above 512 characters is truncated. |
language | String; optional | The first two characters of the header, in uppercase. For example, HTTP_ACCEPT_LANGUAGE "EN" |
connectiontype | Integer; optional | The network connection type that the device uses, where:
0 = unknown
1 = ethernet
2 = WiFi
3 = cellular network - unknown generation
4 = cellular network - 2G
5 = cellular network - 3G
6 = cellular network - 4G
7 = cellular network - 5G |
screen_width | Integer; required | The screen width. |
screen_height | Integer; required | The screen height. |
Site object
| Field | Type | Description |
|---|
id | String; optional | A static value that represents the site’s ID. This field must be present when the request represents a web impression. This field is optional if the request contains the the App Object. This field is required if the request doesn't contain any App Object. |
name | String; optional | A static value that represents the site’s name. |
domain | String; optional | A static value that represents the site’s domain. |
page | String; optional | The URL of the page where this impression will be shown. Anything above 512 characters is truncated. |
referer | String; optional | The referring URL that caused navigation to the page hosting this impression. Anything above 512 characters is truncated. |
publisher | Object; required | The Publisher Object. |
cat | Array of Strings; optional | A single-element array representing the standard IAB content category for the overall site. For example, ["IAB3-7"] See section 6.1 of the OpenRTB Specification (version 2.5) for a full list. |
sectioncat | Array of Strings; optional | A single-element array representing the standard IAB content category for the overall site. For example, ["IAB3-7"] See section 6.1 of the OpenRTB Specification (version 2.5) for a full list. |
keywords | String; optional | The string of keywords |
site_ext | Object; optional | The Site Extension Object. Arbitrary JSON object |
Publisher Object
| Field | Type | Description |
|---|
id | String; required | The AIDEM-specific publisher ID. |
Site Extension object
Site Extension Data Object
This object is an arbitrary JSON.
The fields listed are reserved for the App Object.
| Field | Type | Description |
|---|
app | Object; optional | The App Object. |
inventory_source | string; optional | The inventory source |
dsp_auction_id | string; optional | TBD |
App Object
| Field | Type | Description |
|---|
app_bundle | string; optional | The id of the App Bundle on the App Store |
app_id | string; optional | The AIDEM generated App ID |
app_name | string; optional | The name of the App |
app_store_url | string; optional | The store url or the App |
Environment object
| Field | Type | Description |
|---|
ri | Object; optional | The Referrer Info Object |
hl | Integer; optional | History length. |
nav | Object; required | JSON string representing the navigator object, may vary from browser to browser. |
inp | Object; optional | The Inp Object |
wpar | Object; optional | The Wpar Object |
Referrer info object
| Field | Type | Description |
|---|
reachedTop | Boolean; optional | |
isAmp | Boolean; optional | |
numIframes | Integer; optional | The number of iframes |
stack | Array of Strings; optional | |
topmostLocation | String; optional | |
location | String; optional | |
canonicalUrl | String; optional | |
page | String; optional | |
domain | String; optional | |
ref | String; optional | |
legacy | Object; optional | The Legacy Object |
Legacy object
| Field | Type | Description |
|---|
reachedTop | Boolean; optional | |
isAmp | Boolean; optional | |
numIframes | Integer; optional | The number of iframes |
stack | Array of Strings; optional | |
referer | String; optional | |
canonicalUrl | String; optional | |
Inp object
| Field | Type | Description |
|---|
euc | Boolean; optional | Checks that the encodeUriComponent function has not been overwritten. |
eu | Boolean; optional | Checks that the encodeUri function has not been overwritten. |
js | Boolean; optional | Checks that the JSON.stringify function has not been overwritten. |
jp | Boolean; optional | Checks that the JSON.parse function has not been overwritten. |
ofe | Boolean; optional | Checks that the Object.fromEntries function has not been overwritten. |
oa | Boolean; optional | Checks that the Object.assign function has not been overwritten. |
Wpar object
| Field | Type | Description |
|---|
innerWidth | Integer; optional | The value of the window.innerWidth. |
innerHeight | Integer; optional | The value of the window.innerHeight. |
