Device Object
BidRequest.device
Each BidRequest object may contain a Device object, which provides details about the end-user’s computing environment. The Device object can contain an Extensions object (see below) and can reference the Geo object.
| Field name | Data type | Description | Sent? |
|---|---|---|---|
ua | string | The HTTP user agent, which typically indicates the user’s browser. For example, “Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_2; en-us)” | Sometimes |
geo | geo object | An object containing properties that describe the geographic location of the user as derived from the device. | Sometimes |
dnt | integer | The “do not track” flag. This flag indicates whether the user’s web browser is set for private browsing. • 0 = False• 1 = True (Browser is set for private browsing.) | Sometimes |
lmt | integer | The “limit tracking” flag. If the user’s mobile device is set for private browsing, the LMT (limit tracking) flag is passed. • 0 = False• 1 = True (The user does not want to be tracked.) | Sometimes |
ip | string | The ipv4 address closest to the user’s device. For example, 238.122.7.1 | Sometimes |
ipv6 | string | The IP address closest to device as IPv6. | Sometimes |
devicetype | integer | The detected device category for the user’s device as defined in the IAB’s OpenRTB 2.5 specification. Note: OpenX OpenRTB uses a devicetype value of 1001 to indicate text (SMS). | Sometimes |
make | string | The make for the user’s device. For example, Apple | Sometimes |
model | string | The model for the user’s device. For example, iPhone | Sometimes |
os | string | The operating system for the user’s device. For example, iOS | Sometimes |
osv | string | The version number for the user’s operating system. For example, 3.1.2 | Sometimes |
hwv | string | The device’s hardware version. For example, 5S (for iPhone 5S) | Sometimes |
h | integer | The physical height of the device’s screen, in pixels. | Sometimes |
w | integer | The physical width of the device’s screen, in pixels. | Sometimes |
language | string | A single two-letter code ISO 639-1 for the user’s preferred browsing language on their device. For example, en | Sometimes |
carrier | string | The carrier or ISP using exchange-curated string names. Should be published to bidders a priori. For example, VERIZON | Sometimes |
mccmnc | string | The mobile carrier for the user’s device as the concatenated MCC-MNC code. Refer to Mobile country code for additional examples. Note: The dash between the MCC and MNC parts is required to remove parsing ambiguity. For example, 310-005 (Identifies Verizon Wireless CDMA in the USA.) | Sometimes |
connectiontype | integer | The detected data connection type for the user’s device as defined in the IAB’s OpenRTB 2.5 specification. For example, 2 | Sometimes |
ifa | string | The ID for advertisers (also referred to as “IDFA”). This is the ID sanctioned for advertiser use in the clear (not hashed). | Sometimes |
didsha1 | string | The SHA-1 hash identifier for the user’s device, such as the UDID for an iOS device. For example, 2b6f0cc904d137be2e1730235f5664094b831186 | Sometimes |
dpidsha1 | string | The SHA-1 hash of the Android ID for the end-user’s mobile device. | Sometimes |
dpidmd5 | string | The MD5 hash of the Android ID for the end-user’s mobile device. | Sometimes |
macsha1 | string | The SHA-1 hash of the device’s MAC address. | Sometimes |
macmd5 | string | The MD5 hash of the device’s MAC address. | Sometimes |
ext | extension object | An object containing properties that describe custom fields related to this device. | Sometimes |
For additional details, see:
- IAB’s OpenRTB 2.5 specification
- Supplemental Data (for additional publisher enrichment fields)
BidRequest.device.ext
To provide additional details about the end-user’s device, the Device object may include an Extensions object.
| Field name | Data type | Description | Sent? |
|---|---|---|---|
language | array of strings | An array of two-letter codes for the user’s preferred browsing languages on their device, listed in order of the user’s language preferences in the browser. | Always |