Bid Models Fields
 Share
The version of the browser you are using is no longer supported. Please upgrade to a supported browser.Dismiss

View only
 
 
ABCDEFGHIJKLMNOPQRSTUVWXY
1
HeaderDefinitionValidation
2
ad_positionIf applicable, ad position on pageMust match the text values for the OpenRTB Enums.BidRequest.Impression.AdPosition
3
app_bundleApplication bundle or package name (e.g., com.foo.mygame). This is intended to be a unique ID across multiple exchanges.
4
app_idApplication ID on the exchange. For uniqueness, Uses ad exchange/SSP identifier as prefix e.g. pm/ representing pubmaticMust match regex: .+/.+
5
app_nameApplication name
6
auction_typeIf 1, first price auction. If 2, second price auction. Additional auction types cna be defined as per the exchange's business rulesMust be an integer
7
banner_heightHeight of the impression in pixelsMust be an integer
8
banner_widthWidth of the impression in pixelsMust be an integer
9
campaign_idID of the campaign that submitted the bidMust be an integer
10
content_coppa_flagChildren’s Online Privacy Protection Act (COPPA) Flag; inventory with this flag carries several ad quality limitationsMust be an integer, either 0 or 1
11
content_languageLanguage in which content associated to the impression is written (as declared by the publisher)
12
content_ratingContent parental rating (as declared by the publisher)
13
display_managerName of the ad mediation partner, SDK technology, or player responsible for rendering ad (typically video or mobile). Used by some ad servers to customize ad code by partner.String, max length of 255
14
display_manager_verVersion of display_managerString, max length of 255
15
domainDomain name from which a given impression originated
16
environment_typeEnvironment type (APP or WEB)Must match the text values for the OpenRTB Enums.Inventory.EnvironmentType
17
geo_cityCity geo code
IP address. MaxMindDB Lookup data
18
geo_countryCountry geo name
IP address. MaxMindDB Lookup data
19
geo_metroMetro geo code
IP address. MaxMindDB Lookup data
20
geo_regionGeo region name
IP address. MaxMindDB Lookup data
21
geo_zipZip code
IP address. MaxMindDB Lookup data
String, min length of 5
22
hour_of_day_utcIndicates the hour of the bid request, between 0 and 23 in UTC timezoneMust be an integer, between 0 and 23
23
inventory_interstitialdetermines if ad tag responsible for the impression accepts interstitial creatives or not; 1 for yes, 0 for noMust be an integer, either 0 or 1
24
inventory_sourceInventory source - exchange nameMust match the text values for the OpenRTB Enums.Inventory.Source
25
lat_long_presentBoolean flag indicating whether or the the device's latitude and longitude are present on the requestMust be an integer, either 0 or 1
26
line_item_idLine Item ID that was responsible for winning the auction, as listed in BeeswaxMust be an integer
27
placementPlacement ID/name, as provided by the publisher. Prefixed with exchange handle.Must match regex: .+/[^,]+(,.+/.+)*
28
placement_typePlacement type, indicates whether the placement is meant for banner, video ads, or bothMust match the text values for the OpenRTB Enums.Inventory.PlacementType
29
platform_bandwidthShows whether the browser is using wifi or carrier to establish connection with internet to generate the impressionMust match the text values for the OpenRTB Enums.BidRequest.Device.ConnectionType
30
platform_browserName of browser used during the auction for the impression at hand
31
platform_browser_versionVersion of browser used to during the auction for the impression at hand
32
platform_carrierIf the device is using a mobile carrier to establish internet connection, this field will identify which carrier is used
33
platform_device_makeMake of the device used to generate the impression
34
platform_device_modelModel of the device used to generate the impression
35
platform_device_screen_sizeScreensize of the device used to generate the impression
36
platform_device_typeType of the device used to generate the impressionMust match the text values for the OpenRTB Enums.BidRequest.Device.DeviceType
37
platform_jsIndicates whether the browser supports JavaScript or notMust be an integer, either 0 or 1
38
platform_osOperating system of the device used to generate the impression
39
platform_os_versionOperating system version of the device used to generate the impression
40
publisher_idPublisher ID on the exchange. Prefixed with the exchange handle for uniquenessMust match regex: .+/.+
41
rewardedStates whether the placement tag behind the impression is meant for rewarded adsMust be an integer
42
site_idID of the site that generated the impression, as provided by the publisherMust match regex: .+/.+
43
site_nameName of the site that generated the impression, as provided by the publisher
44
video_boxing_allowedIndicates if letter-boxing of 4:3 content into a 16:9 window is
allowed, where 0 = no, 1 = yes
Must be an integer, either 0 or 1
45
video_companion_requiredA banner companion ad is required to accompany the video ad: 0=false, 1=trueMust be an integer, either 0 or 1
46
video_playback_methodVideo playback method, as determined by the publisher.Must match the text values for the OpenRTB Enums.BidRequest.Impression.Video.PlaybackMethod
47
video_player_sizeVideo player size
48
video_start_delayIndicates the start delay in seconds for pre-roll, mid-roll, or
post-roll ad placements
Must be an integer
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
Loading...