List of supported OpenRTB bid request fields for DSPs

id

String; required

The Index-generated unique ID for the request. For DSPs that have multiple OpenRTB integrations with Index, each integration will receive its own unique id for every request.

imp

Object array; required

The Impression Object, which contains at least one Banner object, Video object, or the Native object.

Note:

• By default, Index separates multi-format eligible requests from our sellers into multiple discrete bid requests to DSPs, with one request per format. Index supports multi-format requests that allow you to receive multiple creative A digital ad made available in various creative types, defined by their size in pixels such as 300x250px. types in an impression opportunity. For example, you can receive requests that support banner, video, and native creatives in an impression opportunity. If you want to enable multi-format requests, contact your Index Representative.

• For video requests, by default Index separates multi-impression structured podded Supply that is monetized through ad breaks, also known as ad pods, which is typically long-form video. Ads for a pod can be requested through a single podded ad request or through multiple slotted ad requests. and dynamic podded video Supply that is monetized through ad breaks, also known as ad pods, which is typically long-form video. Ads for a pod can be requested through a single podded ad request or through multiple slotted ad requests. requests from publishers into individual single-impression video requests for DSPs. This allows DSPs without OpenRTB 2.6 support to receive the impression opportunities as non-podded Supply that is monetized with individual video creatives, which is typically short-form video on web or mobile app. The ad displays before (pre-roll), during (mid-roll), or after (post-roll) the video content that the user is viewing. Ads for non-podded video supply are requested through a single ad request. single-impression video requests. If you are able to receive podded requests and want to receive structured or dynamic podded requests from Index, contact your Index Representative.

device

Object; required

The Device Object.

tmax

Integer; required

Maximum time in milliseconds that Index allows to receive bids. To avoid timeouts, the tmax field does not subtract internet latency between Index and the DSP Demand-Side Platform (DSP). A software platform that automates bidding decisions in real-time and efficiently connects buyers and audiences through an ad exchange or SSP. Also known as a buy-side platform..

Note: If required, we can subtract latency when passing tmax. For more information, contact your Index Representative.

cur

String array; optional

The currencies that publishers will accept in bid responses, which must always be USD.

ext

Required

A custom Index Request Extension Object that contains additional information about the bid request.

app

Object; optional

The App Object; included if the impression originates from an application.

bcat

Array of Strings; optional

An array of blocked advertiser categories, based on standard IAB Interactive Advertising Bureau (IAB). An advertising business organization that develops industry standards, conducts research, and provides legal support for the online advertising industry. content categories. For a full list of values, see List: Category Taxonomies in AdCOM 1.0.

badv

Array of strings; optional

A list of advertiser domains that have been blocked by the publisher The owner of a website or app where advertisements are served. from serving on their properties, for example “ford.com”.
Note: This field is temporarily unavailable while we make some optimization improvements.

regs

Object; optional

The Regulations Object.

site

Object; optional

The Site Object; included if the impression originates from a website.

user

Object; optional

The User Object.

sourceType

Integer; required

The header bidding Publishers offer their inventory programmatically to multiple ad exchanges before calling their chosen ad server. type used in the auction, where:

• 1 = the request is not from a header bidding auction

• 2 = the request is from a client-side A type of header bidding where the auction takes place on the user's browser. header bidding auction

• 3 = the request is from a server-side A process where the header bidding takes place on an external server, as opposed to bidding from a browser. This is also called as server-to-server (S2S) header bidding. header bidding auction

sourceOrigin

Integer; required

The source of the impression opportunity which specifies where it originated from, where:

• 1 = direct (tag-based)

• 2 = other SSP Supply-Side Platform (SSP). A software platform used by publishers to automate real-time inventory sales to advertisers through an ad exchange or DSP. Also known as the sell-side.

• 3 = Amazon TAM

• 4 = Google Open Bidding

• 5 = Prebid

• 6 = IX Wrapper Library

• 7 = other header bidding solution

omidpn

String; optional

An identifier for the OM SDK integration. This is the same as the name parameter of the OMID Partner object.

omidpv

String; optional

A version of the OM SDK integration. This is the same as the versionString parameter of the OMID Partner object.

asi

String; required

Domain name of the system that the bidder connects to. For example, SSP, exchange.

Note: You can find the sellers.json Sellers.json is a file stored on Index's website that includes the various publishers and intermediaries that Index Exchange works with. file for each node through this domain name. The same domain is also used in ads.txt files for publishers (for example, indexexchange.com).

rid

String; optional

The request's OpenRTB RequestId issued by the seller.

Note: The same information can also be found in bidrequest.id.

String; required

The seller or reseller account ID.

Note: The same information can also be found in site.publisher.id.

hp

Integer; required

Specifies whether this node is involved in the flow of payment for the inventory. The hp field is sent if an upstream chain includes it. Index's node will always include hp=1. For version 1.0 of SupplyChain, this property A point of presence such as a website, social media account, or blog on the web that is an asset of an entity such as an individual or corporation and used for the purpose of representing a brand, person or other identity. should always be 1.

id

String; required

A unique identifier for this impression.

tagid

String; optional

A unique identifier for the ad placement or ad tag The HTML/JavaScript code that a browser uses to retrieve advertisements from an ad server. on a publisher's website or app that was used to initiate the auction. DSPs can use this detailed breakdown of publisher inventory that specifies the exact location of the ad on a web page or app to optimize and troubleshoot buyer campaigns.

Note: If no tagid is specified, Index will pass its own site ID Site IDs are unique Index-specific identifiers that represent specific inventory and attributes based on our publishers needs. Site IDs are created in the Index UI and these IDs are used by publishers to make real-time bid requests. for the inventory to DSPs.

banner

Object; required

The Banner Object.

Note: All requests must include at least one Banner Object or Video Object.

bidfloor

Float; optional

The minimum bid for this impression in CPM Cost Per Thousand (CPM). A pricing structure for buying impressions and is the cost of serving an advertisement 1,000 times. Also known as Cost Per Mille (where M represents 1,000 in Roman numerals) or Cents Per Mille..

bidfloorcur

The currency for the bid floor A pricing control used by publishers and exchanges to set a minimum sale price on inventory., which will always be USD.

secure

Integer; required

Specifies whether impressions require secure HTTPS URL creative assets and markup, where:

• 0 = secure assets are not required
• 1 = secure assets and markup are required

video

Object; required

The Video object.

Note: All requests must include at least one Video object, Banner object, or native object.

ext

Object; optional

instl

Integer; optional

Specifies whether an ad is interstitial A ad that covers the entire screen of the device/host app., where:

• 0 = ad is not interstitial
• 1 = ad is interstitial or full screen

metric

Object; optional

The Metric object that contains more information about any metrics associated with this impression.

rwdd

Integer; optional

Indicates if this impression is associated with a rewarded An opt-in video ad experience, typically in mobile apps, in exchange for which the user receives some type of in-app or in-game currency. placement, where:

• 0 = ad is not a rewarded placement
• 1 = ad is a rewarded placement

pmp

Object; optional

bcrid

Array of Strings; required

DSP Creative IDs that are blocked because they are pending review or have been blocked by Index and are therefore excluded from participating in an auction.

Note:

• The number of Creative IDs that display is configurable per DSP.
• This field is temporarily unavailable while we make some optimization improvements.

floor

Array of Integers; optional

An array of bid floor values, in cents.

Note: The array index identifies the bid floor of a seat with corresponding index in the wseat field of the Bid Request Object.

hb

Integer; optional

Specifies whether to use Header Tag inventory bid requests, where:

• 0 = traditional ad tag request
• 1 = header tag ad request

Note: This is not included by default and DSPs must request it.

wopv

String; optional

The HUMAN, Inc. (Human; formally White Ops) lookupID. The lookupID present in the bid request indicates that MediaGuard has scanned the ad request and determined that it is not fraudulent. For more information about Invalid Traffic (IVT Invalid traffic (IVT). Traffic entering an exchange that is attempting to present itself as legitimate traffic but is determined to be fraudulent. For example, bot traffic.) monitoring, see Inventory quality.

skadn

Object; optional

Specifies publisher support for Apple's SKAdNetwork app install attribution. See SKAdNetwork extension object below.

tid

String; optional

The unique transaction ID for each impression, which is common across all the exchanges that are bidding on this impression opportunity. This field is an implementation of OpenRTB's community extension for Per-Impression Transaction IDs.
Note: This field is not currently supported, but will be soon available for DSPs.

data

Object; optional

The custom key value pairs passed by a publisher that provides contextual information about an ad unit. For more information see, Targeting custom key values in deals using inventory groups (Beta).

ae

Integer; optional

Info: Starting in June 2025, Index has paused support for the Protected Audience API. As a result, you won't receive this field from Index.

If you are using the Protected Audience API, this field specifies the auction environment for the request, where:

• 0 = does not support the Protected Audience API, where a traditional auction runs (default).

• 1 = supports the Protected Audience API, where the final auction runs in the browser.

sid

String; optional

Seller integration data passed to Index. Publishers can use this field to pass any custom data that they want to receive in their Client Audit Logs (CAL Client Audit Logs (CAL) API. An API that allows Index customers to retrieve log files for impression and bid event data.).

format

Array of Objects; optional

Array of format objects specifying the banner sizes permitted for an impression opportunity.

Note: Not enabled for all partners by default. To enable the format object, contact your Index Representative.

Note: Partners who are enabled to receive the format object must include the w and h values in the bid object of the bid response.

Note: For partners that do not support the format object, Index by default includes the maximum size supported by you in the bid request.

h

Integer; required

The height of this impression, in pixels.

topframe

Boolean; required

Specifies whether the banner ad is delivered in the top frame or in an iFrame An HTML tag that tells the browser to open a mini browser window of a specified size inside the current window. This way the ad content cannot expand beyond the size specified and does not take over the screen., where:

• 0 = ad is displayed in an iframe
• 1 = ad will not be displayed in an iframe

w

Integer; required

The width of this impression, in pixels.

battr

Array; optional

Indicates blocked creative attributes; if blank, it is assumed that all types are allowed.For a full list of values, see List: Creative Attributes in AdCOM 1.0.

expdir

Array of Integers; optional

Indicates expandable ad A type of display ad that changes dimensions when a user interacts with it. directions, where:

• 1 = left
• 2 = right
• 3 = up
• 4 = down
• 5 = full screen

api

Array of Integers; optional

Specifies the supported API frameworks, where:

• 1 = VPAID 1.0
• 2 = VPAID 2.0
• 3 = MRAID 1.0
• 4 = ORMMA
• 5 = MRAID 2.0
• 6 = MRAID 3.0
• 7 = OMID 1.0

By default, custom APIs are assumed as unsupported.

hmax

String; optional

The maximum height of the impression in pixels. If included, it specifies that a range of sizes is allowed with this maximum height and h is considered to be the recommended size. If it is not included, h is considered an exact requirement.

hmin

String; optional

The minimum height of the impression in pixels. If included, it specifies that a range of sizes is allowed with this minimum height and h is considered as the recommended size. If not included, h is considered an exact requirement.

id

String; optional

A unique identifier for this banner object; especially useful for tracking multiple Banner Objects (for example, in companion banner array). It usually begins with 1 and increases with each object.

mimes

Array of Strings; optional

Allowed list of content MIME types supported. Popular MIME types include, but are not limited toimage/jpg and image/gif.

pos

Integer; optional

Specifies the position of the ad as a relative measure of visibility or prominence where:

• 0 = unknown
• 1 = above the fold (default)
• 2 = deprecated (resolution dependent)
• 3 = below the fold
• 4 = header
• 5 = footer
• 6 = sidebar
• 7 = full-screen

wmax

Integer; optional

The maximum width of the impression in pixels. If included, it specifies that a range of sizes is allowed with this maximum width and w is considered to be the recommended size. If not included, w is considered an exact requirement.

wmin

Integer; optional

The minimum width of the impression in pixels. If included, it specifies that a range of sizes is allowed with this minimum width and w is considered as the recommended size. If not included, w is considered an exact requirement.

maxduration

Integer; required

Maximum video ad duration, in seconds.

minduration

Integer; required

Minimum video ad duration, in seconds.

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

For VPAID support, make sure to specify application/javascript.

protocols

Array of Integers; required

An array of supported video protocols. At least one supported protocol must be specified, where:

• 2 = VAST Video ad-serving template (VAST). A communication standard between ad servers and video players in XML-format that describes the video player's expected behavior. 2.0
• 3 = VAST 3.0
• 5 = VAST 2.0 Wrapper
• 6 = VAST 3.0 Wrapper
• 7 = VAST 4.0
• 8 = VAST 4.0 Wrapper
• 11 = VAST 4.1
• 12 = VAST 4.1 Wrapper
• 13 = VAST 4.2
• 14 = VAST 4.2 Wrapper

api

Array of Integers; optional

A list of supported API frameworks, where:

• 1 = VPAID 1.0
• 2 = VPAID 2.0
• 3 = MRAID 1.0
• 4 = ORMMA
• 5 = MRAID 2.0
• 6 = MRAID 3.0
• 7 = OMID 1.0

By default, custom APIs are assumed to be unsupported.

boxingallowed

Integer; optional

Specifies whether letter-boxing of 4:3 content into a 16:9 window is allowed, where:

• 0 = boxing is not allowed
• 1 = boxing is allowed (default setting)

battr

Array; optional

Specifies blocked creative attributes. If blank, it is assumed that all types are allowed.

companionad

Array of Objects; optional

Available companion ads are listed as an array of Banner Objects.

companiontype

Array of Integers; optional

A list of supported VAST companion ad An ad that is located beside a video player and accompanies a video ad. types, where:

• 1 = static resource
• 2 = HTML resource
• 3 = iframe resource

delivery

Array of Integers; optional

A list of supported delivery methods. If blank, it is assumed that all are supported, where:

• 1 = streaming
• 2 = progressive

ext

Object; optional

A custom Index Video Extension Object that contains additional information about this impression.

h

Integer; optional

The height of the player, in pixels.

linearity

Integer; optional

Specifies whether the ad impression is linear or non-linear. If the field is blank, the ad impression can be of any type, where:

• 1 = linear/instream A video ad that displays before (pre-roll), during (mid-roll), or after (post-roll) video content that the user is consuming. The video ad plays within video content, similar to watching TV with commercials.
• 2 = non-linear/overlay

maxextended

The maximum extended ad duration if extension is allowed, where:

• If blank or 0 = extension is not allowed
• -1 = an extension is allowed and there is no time limit imposed
• If greater than 0 = the value represents the number of seconds of extended play supported beyond the maxduration value.

maxbitrate

Integer; optional

The maximum bit rate in Kbps.

minbitrate

Integer; optional

The minimum bit rate in Kbps.

placement

Integer; optional

The video's placement type, where:

• 1 = instream
• 2 = in-banner
• 3 = in-article
• 4 = in-feed
• 5 = interstitial/slider/sloating

Note: Although this field is deprecated in OpenRTB 2.6, Index still continues to support it.

plcmt

Integer; optional

The video's placement type in accordance with the updated IAB Digital Video Guidelines, where:

• 1 = instream
• 2 = accompanying content Pre-roll, mid-roll, and post-roll ads that are played before, during, or after streaming video content.It starts playback upon entering the viewport. It may convert to a floating/sticky player as it scrolls off the page.
• 3 = interstitial
• 4 = no content/standalone Video ads that are played without streaming video content. This can be in placements like slideshows, native feeds, in-content or sticky/floating.

skip

Integer; optional

Specifies whether the player allows the video to be skipped, where:

• 0 = no
• 1 = yes

skipmin

Integer; optional

Videos of total duration greater than this number of seconds

can be skippable; only applicable if the ad is skippable.

skipafter

Integer; optional

Number of seconds a video must play before skipping is

enabled; only applicable if the ad is skippable.

playbackmethod

A list of allowed playback methods, where:

• 1 = auto-play sound on
• 2 = auto-play sound off
• 3 = click-to-play
• 4 = mouse-over
• 5 = entering viewport with sound on
• 6 = entering viewport with sound off

If blank, Index assumes that all methods are allowed.

pos

Integer; optional

Specifies the position of the ad as a relative measure of visibility or prominence, where:

• 0 = unknown
• 1 = above the fold (default)
• 2 = deprecated (resolution dependent)
• 3 = below the fold
• 4 = header
• 5 = footer
• 6 is sidebar
• 7 is full-screen

sequence

Integer; optional

If multiple ad impressions are offered in the same bid request, the sequence number will allow for the coordinated delivery of multiple creatives.

Note: Although this field is deprecated in OpenRTB 2.6, Index still continues to support it.

startdelay

Integer; optional

Specifies the start delay in seconds for pre-roll, mid-roll, or post-roll ad A video ad that plays after a publisher's video content is finished. placement, where:

• >0 = mid-roll (value indicates start delay in second)
• 0 = pre-roll
• -1 = generic mid-roll
• -2 = generic post-roll

w

Integer; optional

The width of the player, in pixels.

id

String; required

The Index-assigned unique identifier for the website.

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.2) for a full list.

content

Object; optional

The Content Object. For more information about the content object, see the content object below.

domain

String; optional

A static value that represents the site’s domain.

mobile

Integer; optional

Specifies whether the site has been programmed to optimize layout when viewed on mobile devices, where:

• 0 = no
• 1 = yes

page

String; optional

The URL of the page where this impression will be shown.

producer

Object; optional

Provides details about the producer of the content. For more information about the producer object, see the producer object below.

publisher

Object; optional

The Publisher Object.

ref

String; optional

The referring URL that caused navigation to the page hosting this impression. Anything above 512 characters is truncated.

id

String; required

The Index-assigned numeric identifier for this app.

bundle

String; optional

The App name or bundle (for example, "com.foo.mygame"), used as a unique identifier across exchanges.

cat

Array of Strings; optional

The standard IAB content category for the overall site (for example, ["IAB3-7"]). For a full list of values, see List: Category Taxonomies in AdCOM 1.0.

content

Object; optional

Details about content within the app. For more information about the content object, see the content object below.

domain

Optional

A static value representing the domain of the app.

keywords

String; optional

A comma-separated list of keywords related to the app. Maximum of 255 characters.

name

String; optional

The name of the app. It may be masked if requested by the publisher.

paid

Integer; optional

Specifies whether the app is a paid or free version, where:

• 0 = app is free
• 1 = app is a paid version

privacypolicy

Integer; optional

Specifies whether the app has a privacy policy, where:

• 0 = no
• 1 = yes

producer

Object; optional

Provides details about the producer of the content. For more information about the producer object, see the producer object below.

publisher

Object; optional

The Publisher Object.

storeurl

String; optional

The App store URL for an installed app for QAG 1.5 compliance.

ver

String; optional

The application version.

ext

object; optional

The App extension object, which is used to provide more information about the app impression opportunity.

album

String; optional

The album to which the content belongs, typically for audio.

artist

String; optional

The artist who is credited with the content.

cat

String array; optional

A single-element array representing the standard IAB content category for the overall site. For example, ["IAB3-7"]. For a full list of values, see List: Category Taxonomies in AdCOM 1.0.

channel

The Channel object.

contentrating

String; optional

The content's rating (for example, MPAA).

context

Integer; optional

Refers to the type of content, where:

• 1 = video (video file or internet TV broadcast)

• 2 = game (interactive software game)

• 3 = music (audio file or internet radio broadcast)

• 4 = application (interactive software application)

• 5 = text (web page, eBook, news article)

• 6 = other

• 7 = unknown

data

Object array; optional

Provides additional content data.

embeddable

Integer; optional

Indicator of whether or not the content is embeddable, where:

• 0 = no

• 1 = yes

episode

String; optional

Episode number that applies to video content.

ext

Object; optional

A placeholder for Index-specific extensions to the content object. See the Content extension object table below.

genre

String; optional

The genre that best describes the content. For example, rock, pop, etc.

id

String; optional

ID that uniquely identifies the content.

isrc

String; optional

International Standard Recording Code conforming to ISO-3901.

keywords

String; optional

A comma separated list of keywords describing the content.

language

String; optional

The first two characters of the language, in uppercase, as per ISO-639-1-alpha-2. For example, "EN".

len

Integer; optional

Used for video and audio, and specifies the length of the content in seconds.

livestream

Integer; optional

Specifies if the content is live (for example, a stream or live blog), where:

• 0 = not live

• 1 = content is live

network

Object; optional

The Network object.

prodq

Integer; optional

Refers to the production quality, where:

• 0 = unknown

• 1 = professionally produced

• 2 = prosumer

• 3 = user generated content (UGC)

producer

Object; optional

Details about the content producer. For more information, see producer object table below.

qagmediarating

Integer; optional

The media rating as per Quality Assurance Guidelines (QAG), where:

• 1 = all audiences

• 2 = everyone over 12

• 3 = mature audiences

season

String; optional

The season of the content (for example, "Season 3").

series

String; optional

Content series.

sourcerelationship

Integer; optional

Specifies the relationship to the source, where:

• 0 = indirect

• 1 = direct

title

String; optional

The title of the content.

url

String; optional

URL of the content, for buy-side contextualization or review.

userrating

String; optional

How users have rated the content. For example, number of stars, number of likes.

videoquality

Integer; optional

Refers to the video quality.

carrier

String; optional

The carrier or ISP. For example, “VERIZON”.“WIFI” is often used in mobile to indicate high bandwidth (for example, video friendly vs. cellular).

devicetype

Integer; optional

The device type in use for this impression, if available, where:

• 1 = mobile or tablet
• 2 = personal computer
• 3 = connected TV Connected TV (CTV). A TV set that receives video content from the internet through a smart TV operating system, streaming device, or game console.
• 4 = phone
• 5 = tablet
• 6 is connected device
• 7 is set-top box

didmd5

String; optional

The hardware device ID , hashed via MD5. For example, IMEI.

Note: Although this field is deprecated in OpenRTB 2.6, Index still continues to support it.

didsha1

String; optional

The hardware device ID, hashed via SHA1. For example, IMEI.

Note: Although this field is deprecated in OpenRTB 2.6, Index still continues to support it.

dpidmd5

String; optional

The platform device ID, hashed via MD5. For example, Android ID.

Note: Although this field is deprecated in OpenRTB 2.6, Index still continues to support it.

dpidsha1

String; optional

The platform device ID, hashed via SHA1. For example, Android ID.

Note: Although this field is deprecated in OpenRTB 2.6, Index still continues to support it.

geo

Object; optional

h

The physical height of the device screen, in pixels.

Note: Only supported in OpenRTB 2.3.

hwv

String; optional

Represents the hardware version of the device. For example, "5S" represents an iPhone 5S.

Note: Only supported in OpenRTB 2.3.

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

ifa

String; optional

ip

String; optional

A dotted-octet representation of the IPv4 address of the user.

Note: This field is required if the bid request does not contain the ipv6 field. See the ipv6 field below.

ipv6

String; optional

The IP address closest to the device, specified in IPv6 format (for example, "fe80:0:0:0:200:f8ff:fe21:67cf"). Index only sends bid requests for IPv6 traffic if you're able to support it. Contact your Index Representative if you want to start receiving IPv6 requests.

Note: Index always sends one of either device.ip or device.ipv6 in all bid requests.

language

String; optional

lmt

Integer; optional

Specifies the scope of tracking related to this impression. This signal represents a commercially adopted version (endorsed by iOS and Android) of standard do-not-track functionality, where:

• 0 = tracking is unrestricted
• 1 = tracking must be limited per commercial guidelines

Note: Only supported in OpenRTB 2.3.

macmd5

String; optional

MAC address of the device; hashed via MD5.

Note: Although this field is deprecated in OpenRTB 2.6, Index still continues to support it.

macsha1

String; optional

MAC address of the device; hashed via SHA1.

Note: Although this field is deprecated in OpenRTB 2.6, Index still continues to support it.

make

String; optional

model

String; optional

os

String; optional

osv

String; optional

ppi

Integer; optional

The pixels per linear inch.

Note: Only supported in OpenRTB 2.3.

pxratio

Float; optional

The ratio of physical pixels to device-independent pixel.

Note: Only supported in OpenRTB 2.3.

ua

String; optional

The content of the HTTP_USER_AGENT header for this user. Anything above 512 characters is truncated.

sua

Object; optional

The structured user agent information specified in the UserAgent object. If both the ua and sua fields contain values, sua is considered more accurate because the ua value may contain a frozen or reduced user agent string.

w

Integer; optional

The physical width of the device screen, in pixels.

Note: Only supported in OpenRTB 2.3.

ext

Integer; optional

A placeholder for Index specific extensions to the device object. See Device extension object below.

city

String; optional

The city, as per United Nations Code for Trade & Transport Locations. See UN/LOCODE Code List.

country

String; optional

The country code, using ISO-3166-1-alpha-3.

ipservice

Integer; optional

The service or provider that is used to determine the geolocation. For a full list of values, see List: IP Location Services in AdCOM 1.0.

lat

Float; optional

The latitude from -90.0 to +90.0, where negative is south.

lon

Float; optional

The longitude from -180.0 to +180.0, where negative is west.

metro

String; optional

The regional marketing areas such as Nielsen's DMA codes or other similar taxonomy to be agreed among vendors prior to use.

region

String; optional

regionfips104

String; optional

The region of a country using FIPS 10-4 notation. While OpenRTB supports this field, it has been withdrawn by NIST in 2008.

type

Integer; optional

The source of location data; recommended when passing lat and lon. See List of location types.

zip

String; optional

The zip code or postal code.

utcoffset

Integer; optional

The local time as the number +/- of minutes from UTC.

Note: Only supported in OpenRTB 2.3.

buyeruid

String; optional

A DSP's UID A free, cookie-based identifier for ad tech providers. for this user (see user matching for format).

Note: This field is always present in default user match configuration.

data

Array of objects; optional

This object is used by publishers to pass additional attributes about the user or content. See the Data object.

eids

Array of objects; optional

This object includes third-party identifiers for this user. For more information, see the EID object below.

ext

Object; optional

The User extension object, which is used to indicate requests that contain certain user identifiers and are subject to GDPR regulations.

id

String; optional

The Index static identifier for this user (contains only alphanumeric or the following characters: @ - . _ ).

Note: This field is always present in default user match configuration.

browsers

Array of objects; optional

An array of BrandVersion objects for identifying the browser or similar software component. The brand and version fields are derived from the Sec-CH-UA-Full-Version-List header. For more information, see the BrandVersion object.

platform

Object; optional

The BrandVersion object for identifying the user agent's operating system. The brand value is derived from the Sec-CH-UA-Platform header, and the version value is derived from the Sec-CH-UAPlatform-Version header. For more information, see the BrandVersion object.

The user agent preference where:

• 1 = The user agent prefers a mobile version of the content.

• 0 = The user agent prefers a desktop version of the content.

This value is derived from the Sec-CH-UAMobile header.

The source of data used to create this object where:

• 0 = Unspecified/unknown

• 1 = User agent client hints. Only low-entropy headers were available.

• 2 = User agent client hints. High-entropy headers were available.

• 3 = Parsed from the user agent header. This is the same value in the ua field.

The default value for this field is 0.