Device Object

Note

Fields marked with asterisk (*) are optional.

Parameter
Type
Description

geo

object

Geo Object as derived from the device’s location services, or supplied by the Supplier if the device IP is missing. For more information, see the Geo Object section.

ip

string

Specifies the IPv4 address closest to the device. Semi-Required One of IP or IPv6 required. Required for almost all requests, any containing invalid IP addresses will be discarded based on IP Validation e.g. 87.224.77.0.

ipv6

string

Semi-Required One of IP or IPv6 required. IP address in IPv6, for example fe80:0:0:0:200:f8ff:fe21:67cf.

ua*

string

Browser or application user agent string, for example, “Mozilla/5.0 (Windows NT 6.3; WOW64; rv:35.0)Gecko/20100101Firefox/35.0”.

sua*

object

Structured user agent. If both ua and sua are present in the bid request, sua should be considered the more accurate representation of the device attributes. This is because the ua may contain a frozen or reduced user agent string.

language*

string

Alpha-2/ISO 639-1 code of browser language, for example, en.

langb*

string

Browser language using IETF BCP 47. Only one of language or langb should be present.

carrier*

string

Carrier or ISP derived from the IP address, for example, WIFI.

connectiontype*

integer

Connection type as defined in OpenRTB, for example, 2.

dpidsha1*

string

Platform device ID (e.g., Android ID); hashed via SHA1, for example, CCF6DC12B98AEB2346AFE1BEE7860DF01FDE158B.

ifa*

string

The ID for Advertisers (IFA) in clear text (i.e. not hashed), for example Apple’s IDFA or Android’s Advertising ID. Note: This field is required for in-app requests.

make*

string

Device make, for example, “Apple”.

mccmnc*

string

Mobile carrier as the concatenated MCC-MNC code (e.g., “310-005” identifies Verizon Wireless CDMA in the USA).

model*

string

Device mode, for example, “iPhone”.

os*

string

Device operating system, for example, “iOS”.

osv*

string

Device operating system version, for example, “3.1.2”.

h*

integer

Physical height of the screen in pixels, for example, 750.

w*

integer

Physical width of the screen in pixels, for example, 1334.

pxratio*

float

The ratio of physical pixels to device independent pixels, for example, 1.0.

dnt*

integer

Do not track. 0: do not track is set to false. 1: do not track is set to true in the browser, for example, 0.

lmt*

integer

Limit Ad Tracking. Signal commercially endorsed (e.g., iOS, recommended Android): 0: tracking is unrestricted, 1: tracking must be limited per commercial guidelines, for example, 0.

devicetype*

integer

Device type as defined by OpenRTB, for example, 4.

js*

integer

Limit Ad Tracking. Signal commercially endorsed (e.g., iOS, recommended Android): 0: tracking is unrestricted, 1: tracking must be limited per commercial guidelines, for example, 0.

flashver*

string

Flash version detected, for example, 10.1.

ext*

object

Device extension object.

Device Ext

Parameter
Type
Description

ifa_type*

string

Indicates the origin of the device.ifa field, whether it was provided from the device itself or generated by a publisher or Supplier in the supply chain.

Structured User Agent

Parameter
Type
Description

browsers*

array of objects

Each Brand Version object identifies a browser or similar software component.

platform*

object

A BrandVersion object that identifies the user agent’s execution platform / OS. Implementers should send a brand derived from the Sec-CH-UA-Platform header, and version derived from the Sec-CH-UAPlatform-Version header or an equivalent JavaScript accessor from NavigatorUAData interface. See the Brand Version Object.

mobile*

integer

ndicates a mobile version: 0 For desktop content. 1 if the agent prefers a mobile version of the content.

architecture*

string

Device’s major binary architecture, e.g. “x86” or “arm”.

bitness*

string

Device’s bitness, e.g. “64” for 64-bit architecture.

model*

string

Device model.

source*

integer

The source of data used to create this object.

Brand Version Object

Parameter
Type
Description

brand*

string

A brand identifier, for example, “Chrome” or “Windows”. The value may be sourced from the User-Agent Client Hints headers, representing either the user agent brand (from the Sec-CH-UA-Full-Version header) or the platform brand (from the Sec-CH-UA-Platform header).

version*

array of strings

A sequence of version components, in descending hierarchical order (major, minor, build, patch, etc e.g. [“102”, “0”, “5005”, “115”].