PreBid BidResponse
Fields
Field | Type | Description |
---|---|---|
cf_latitude | Float; optional | Latitude of the incoming request, e.g. 30.27130 |
cf_longitude | Float; optional | Longitude of the incoming request, e.g. -97.74260 |
cf_colo | String; optional | The three-letter airport code (e.g. ATX, LUX) representing the colocation which processed the request |
cf_asn | Integer; optional | The Autonomous System Number (ASN) of the request, e.g. 395747 |
cf_country | String; optional | The two-letter country code of origin for the request. This is the same value as that provided in the CF-IPCountry header, e.g. "US" |
cf_city | String; optional | City of the incoming request, e.g. “Austin”. |
cf_continent | String; optional | Continent of the incoming request, e.g. “NA” |
cf_postal_code | String; optional | Postal code of the incoming request, e.g. “78701” |
cf_region | String; optional | If known, the ISO 3166-2 name for the first level region associated with the IP address of the incoming request, e.g. “Texas”. |
cf_region_code | String; optional | If known, the ISO 3166-2 code for the first level region associated with the IP address of the incoming request, e.g. “TX”. |
worker_cf_ray | String; required | The Cf-Ray of the worker that handled the request |
client_ip | String; required | The ip of the request |
timestamp | Integer; required | The timestamp of the request |
date | String; required | The date of the request in the format YYYY-MM-DD |
id | String; required | The Auction ID generated by Prebid.js. |
imp_id | String; required | The unique identifier of this impression. |
imp_tid | String; required | The unique identifier of the BidRequest transaction. |
imp_mediatype | String; required | The media type. One of banner, video. |
imp_banner_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 iframe1 = ad will not be displayed in an iframe. |
imp_banner_format | Array of Objects; required | Array of Format Object objects specifying the banner sizes permitted for an impression opportunity. |
imp_video_context | String; required | Video placement where:instream = instream videooutstream = outstream video |
imp_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 |
imp_video_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 |
imp_video_maxduration | Integer; optional | Maximum video ad duration, in seconds. |
imp_video_minduration | Integer; optional | Minimum video ad duration, in seconds. |
imp_floor_value | Float; required | The value of the floor price. |
imp_floor_currency | String; required | One of List of currencies. |
imp_imp_ext | Object; optional | JSON object containing arbitrary first party data. |
device_ua | String; required | The content of the HTTP_USER_AGENT header for this user. Anything above 512 characters is truncated. |
device_language | String; optional | The first two characters of the header, in uppercase. For example, HTTP_ACCEPT_LANGUAGE "EN" |
device_connectiontype | Integer; optional | The network connection type that the device uses, where:0 = unknown1 = ethernet2 = WiFi3 = cellular network - unknown generation4 = cellular network - 2G5 = cellular network - 3G6 = cellular network - 4G7 = cellular network - 5G |
device_screen_width | Integer; required | The screen width. |
device_screen_height | Integer; required | The screen height. |
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_gdpr_applies | Boolean; required | Represents whether the user in question is in an area where GDPR applies. |
regs_usp_applies | Boolean; required | Represents whether the user in question is in an area where US Privacy applies. |
regs_coppa_applies | Boolean; required | Specifies whether this request is subject to the United States Children’s Online Privacy Protection Act (COPPA), where:false = notrue = yesNote: BidRequest with coppa=1 will not be processed by AIDEM. |
regs_us_privacy | String; optional | US Privacy/CCPA notice and opt-out status information. |
site_id | String; required | A static value that represents the site’s ID. |
site_domain | String; required | A static value that represents the site’s domain. |
site_page | String; required | The URL of the page where this impression will be shown. Anything above 512 characters is truncated. |
site_referer | String; required | The referring URL that caused navigation to the page hosting this impression. Anything above 512 characters is truncated. |
site_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. |
site_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. |
site_keywords | String; optional | The string of keywords |
site_site_ext | Object; optional | The Site Extension Object. Arbitrary JSON object |
site_publisher_id | String; required | The AIDEM-specific publisher ID. |
site_publisher_name | String; optional | The AIDEM-specific publisher ID. |
environment_ri | Object; optional | The Referrer Info Object |
environment_hl | Integer; optional | History length. |
environment_nav | Object; required | JSON string representing the navigator object, may vary from browser to browser. |
environment_inp_euc | Boolean; optional | Checks that the encodeUriComponent function has not been overwritten. |
environment_inp_eu | Boolean; optional | Checks that the encodeUri function has not been overwritten. |
environment_inp_js | Boolean; optional | Checks that the JSON.stringify function has not been overwritten. |
environment_inp_jp | Boolean; optional | Checks that the JSON.parse function has not been overwritten. |
environment_inp_ofe | Boolean; optional | Checks that the Object.fromEntries function has not been overwritten. |
environment_inp_oa | Boolean; optional | Checks that the Object.assign function has not been overwritten. |
environment_wpar_inner_width | Integer; optional | The value of the window.innerWidth. |
environment_wpar_inner_height | Integer; optional | The value of the window.innerHeight. |
at | Integer; required | The Auction type where:1 = first price2 = second price |