List of supported OpenRTB bid request fields
Our OpenRTB bidding API facilitates real-time bidding. Data for bid requests is sent in JSON RFC 4627 format and all fields are considered case-sensitive.
BidRequest object
The top level bid request object and accompanying fields are below, followed by each lower level object contained within it.
Field | Type | Description |
---|---|---|
|
String; required |
The Index unique ID for the request. The ID is a 36-character alphanumeric string. |
|
Object; required |
The Impression Object; contains at least one Banner Object or Video Object. |
|
Object; required |
The Device Object. |
|
Object; required |
Maximum time in milliseconds that Index allows to receive bids. To avoid timeouts, the Note: If required, we can subtract latency when passing |
|
String array; optional |
The currencies that publishers will accept in bid responses. Currencies must be specified in the ISO-4217 standard and must be supported by Index. For more information, see List of supported currencies. |
|
Required |
A custom Index Request Extension Object that contains additional information about the bid request. |
|
Object; optional |
The App Object; included if the impression originates from an application. |
|
Array of Strings; optional |
An array of blocked advertiser categories, based on standard IAB content categories. The full list is available in section 5.1 of the OpenRTB Specification (version 2.5). |
|
Array of strings; optional |
A list of advertiser domains that have been blocked by the publisher from serving on their properties, for example |
|
Object; optional |
The Regulations Object. |
|
Object; optional |
The Site Object; included if the impression originates from a website. |
|
Object; optional |
The User Object. |
source
|
Object; optional | A Source object that provides data about the inventory source. |
BidRequest extension object
Field | Type | Description |
---|---|---|
|
Integer; optional |
The number of ad requests since a session was started with the user (max 255). |
|
Object; optional |
The Placement Object. |
|
Integer; optional |
The number of ad requests since a session was started with the user for the domain (max 255). |
|
Integer; optional |
The user time zone derived from the JavaScript getTimezoneOffset() function. |
Placement object
The Placement Object is always present for impressions in the private exchange.
Field | Type | Description |
---|---|---|
|
String; optional |
A name that describes why the impression is private (for example, "Homepage"). |
|
Boolean; optional |
The scope of DSP bidding eligibility for this impression, where:
|
Source object
Field | Type | Description |
---|---|---|
|
String; optional |
The Payment ID chain string provides visibility into an impression's supply path. For bid requests sourced directly from Index, the
For example, 50b1c356f2c5c8fc:2167. For bid requests sourced from a supplier, the |
|
String; optional |
The Source extension object which is used to specify additional details about the source of the bid request. For more information, see the Source extension object below. |
Source extension object
Field | Type | Description |
---|---|---|
|
Integer; required
|
The header bidding type used in the auction, where:
|
|
Integer; required
|
The source of the impression opportunity which specifies where it originated from, where:
|
|
Object; optional |
Like To interpret the For more information, see the Supply chain object below. |
|
String; optional |
An identifier for the OM SDK integration. This is the same as the |
|
String; optional
|
A version of the OM SDK integration. This is the same as the |
SupplyChain object
Field | Type | Description |
---|---|---|
|
Integer; required |
A flag that specifies whether the chain contains all nodes involved in the transaction leading back to the supply source of the inventory, where:
|
|
Object array; required |
An array of |
|
String; required |
Version of the supply chain specification in use, in the format of “major.minor”. Index is currently using version 1.0 of the sellers.json specification. |
Nodes object
Field | Type | Description |
---|---|---|
|
String; required
|
Domain name of the system that the bidder connects to. For example, SSP, exchange. Note: You can find the sellers.json file for each node through this domain name. The same domain is also used in |
|
String; optional |
The request's OpenRTB RequestId issued by the seller. Note: The same information can also be found in |
sid
|
String; required |
The seller or reseller account ID. Note: The same information can also be found in |
|
Integer; required |
Specifies whether this node is involved in the flow of payment for the inventory. The |
Regs object
Field | Type | Description |
---|---|---|
|
Integer; optional |
Specifies whether this request is subject to the United States Children’s Online Privacy Protection Act (COPPA), where:
If this flag is omitted in the request, Index assumes that this information is unavailable. Note: The following fields are automatically blanked in COPPA-related requests: lat, lon, metro, city and zip (in the Geo Object). |
|
Object; optional |
The Regulation Extension Object, which is used to specify requests that are subject to regulations. See the table below. |
Regs extension object
Field | Type | Description |
---|---|---|
|
Integer; optional |
Specifies whether the request is subject to regulations, where:
|
|
Object; optional |
Specifies whether US privacy laws (for example, CCPA) apply or don't apply to the user in the bid request. This field contains four characters. For example,
For example, a string passed as Note: When a consumer chooses to opt-out of the sale of their personal information, the following bid request fields are automatically adjusted:
|
Imp object
This object describes an ad placement or impression opportunity being auctioned. A single impression opportunity may allow one or multiple creative types such as banner
and video
. Bid responses should only include creative types that are allowed for the respective impression opportunity.
Field | Type | Description |
---|---|---|
|
String; required |
A unique identifier for this impression. |
|
String; optional |
A unique identifier for the ad placement or ad tag on a publisher's website that was used to initiate the auction. DSPs can use this detailed breakdown of publisher inventory specifying where the ad is located on a web page to optimize and troubleshoot buyer campaigns. Note: |
|
Object; required |
The Banner Object. Note: All requests must include at least one Banner Object or Video Object. |
|
Integer; required |
Specifies whether impressions require secure HTTPS URL creative assets and markup, where:
|
|
Object; required |
The Video object. Note: All requests must include at least one Video object or Banner object. |
native
|
Object; required | The native object. This field is required if this impression is offered as a Native ad opportunity. Note: The native object is currently in Beta testing. For more information on how Index supports native ads, contact your Index Representative. |
|
Float; optional |
The minimum bid for this impression in CPM. For more information about the |
|
String; optional |
The currency for the bid floor. Currencies must be specified in the ISO-4217 standard and must be supported by Index. For more information, see List of supported currencies. |
|
Object; optional |
A custom Index Impression Extension Object that contains additional information about any deals for this impression. |
|
Integer; optional |
Specifies whether an ad is interstitial, where:
|
|
Object; optional |
The Metric object that contains more information about any metrics associated with this impression. |
|
Integer; optional |
Indicates if this impression is associated with a rewarded placement, where:
|
|
Object; optional |
The PMP Object that contains information about deals for this impression. |
Imp extension object
This custom Extension Object communicates information regarding deals and Header Tag bids.
Field | Type | Description |
---|---|---|
|
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:
|
|
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 |
|
Integer; optional |
Specifies whether to use Header Tag inventory bid requests, where:
Note: This is not included by default and DSPs must request it. |
|
String; optional |
The HUMAN, Inc. (Human; formally White Ops) |
|
Object; optional |
Specifies publisher support for Apple's SKAdNetwork app install attribution. See SKAdNetwork extension object below. |
gpid
|
String; optional | The Global Placement Identifier (GPID) for the ad slot or placement. For more information about GPID, see Send the Global Placement Identifier (GPID) to Index. |
Metric object
The metric object is associated with an impression as an array of metrics. These metrics can offer insight into the impression, such as recent viewability, completion rate, and click-through rate. Each metric is identified by its type, the value of the metric, and optionally the source or vendor that measured the value.
Field | Type | Description |
---|---|---|
type
|
String; required |
The type of metric being presented. Index supports the following metric types:
|
|
Float; required |
A number representing the value of the metric. Probabilities must be in the range of |
|
String; optional |
The source of the value using exchange curated string names. At the moment, only exchange-generated metrics are supported, so this value will always be |
Banner object
This object is a subset of the Impression object that describes a banner ad impression. If the auctioned impression is banner or rich media, include the Banner object directly in the Impression object. It can also be embedded in the Video object to describe companion banners available for linear/non-linear video ads. For information on the possible ad dimensions, see List of ad units and maximum expansion size.
Field | Type | Description |
---|---|---|
|
Array of Objects; optional |
Array of Note: Not enabled for all partners by default. To enable the Note: Partners who are enabled to receive the Note: For partners that do not support the |
|
Integer; required |
The height of this impression, in pixels. |
|
Boolean; required |
Specifies whether the banner ad is delivered in the top frame or in an iFrame, where:
Note: Expandable ads must meet our expansion requirements. |
|
Integer; required |
The width of this impression, in pixels. |
|
Array; optional |
Indicates blocked creative attributes; if blank, it is assumed that all types are allowed. Refer to the OpenRTB API Specification Version 2.5 for a full list of values. |
|
Integer; optional |
The list of blocked creative types, where:
If left blank, Index assumes that all types are allowed. |
|
Array of Integers; optional |
Indicates expandable ad directions, where:
|
|
Array of Integers; optional |
Specifies the supported API frameworks, where:
By default, custom APIs are assumed as unsupported. |
|
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 |
|
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 |
|
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 |
|
Array of Strings; optional |
Whitelist of content MIME types supported. Popular MIME types include, but are not limited to |
|
Integer; optional |
Specifies the position of the ad as a relative measure of visibility or prominence where:
|
|
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 |
|
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 |
Video object
Field | Type | Description |
---|---|---|
|
Integer; required |
Maximum video ad duration, in seconds. |
|
Integer; required |
Minimum video ad duration, in seconds. |
|
Array of Strings; required |
A list of supported video content MIME types. Popular MIME types supported by HTML5 players include:
For VPAID support, make sure to specify application/javascript. |
|
Array of Integers; required |
An array of supported video protocols. At least one supported protocol must be specified, where:
|
|
Array of Integers; optional |
A list of supported API frameworks, where:
By default, custom APIs are assumed to be unsupported. |
|
Integer; optional |
Specifies whether letter-boxing of 4:3 content into a 16:9 window is allowed, where:
|
|
Array; optional |
Specifies blocked creative attributes. If blank, it is assumed that all types are allowed. |
|
Array of Objects; optional |
Available companion ads are listed as an array of Banner Objects. |
|
Array of Integers; optional |
A list of supported VAST companion ad types, where:
|
|
Array of Integers; optional |
A list of supported delivery methods. If blank, it is assumed that all are supported, where:
|
|
Object; optional |
A custom Index Video Extension Object that contains additional information about this impression.
|
|
Integer; optional |
The height of the player, in pixels. |
|
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:
|
|
Integer; optional |
The maximum extended ad duration if extension is allowed, where:
|
|
Integer; optional |
The maximum bit rate in Kbps. |
|
Integer; optional |
The minimum bit rate in Kbps. |
|
Integer; optional |
The video's placement type, where:
For more information, see Table 5.9 in the OpenRTB API Specification Version 2.5. |
|
Integer; optional
|
Specifies whether the player allows the video to be skipped, where:
|
|
Integer; optional |
Videos of total duration greater than this number of seconds can be skippable; only applicable if the ad is skippable. |
|
Integer; optional |
Number of seconds a video must play before skipping is enabled; only applicable if the ad is skippable. |
|
Array of Integers; optional |
A list of allowed playback methods, where:
If blank, Index assumes that all methods are allowed. |
|
Integer; optional |
Specifies the position of the ad as a relative measure of visibility or prominence, where:
|
|
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. |
|
Integer; optional |
Specifies the start delay in seconds for pre-roll, mid-roll, or post-roll ad placement, where:
|
|
Integer; optional |
The width of the player, in pixels. |
Video extension object
This custom Extension Object indicates the player type associated with out-stream video impressions.
Field | Type | Description |
---|---|---|
|
Integer; optional |
Specifies the player type associated with this out-stream video impression, where:
If blank, the player is assumed to be a conventional in-steam type. |
|
Integer; optional |
Specifies whether the ad is being rendered as a part of a rewarded video ad experience, where:
|
Native object
The presence of a native
object as a subordinate of the impression
object indicates that this impression is offered as a native type impression. At the publisher’s discretion, that same impression may also be offered as banner, video, or audio by also including them as imp
subordinate objects of those types.
Field | Type | Description |
---|---|---|
|
String; required |
The request payload complying with the OpenRTB Dynamic Native Ads API Specification Version 1.2. For more information about the |
|
String; optional |
The version of the native markup in use. |
|
Integer array; optional |
The list of supported API frameworks for the impression. If an API is not listed, assume it is not supported. |
|
Integer array; optional |
The blocked creative attributes. To learn more, see the List of creative attributes. |
Format object
The format
object specifies an allowed size, in height and width combination, for a banner impression opportunity. These are typically used in an array where multiple sizes are permitted.
Field | type | Description |
---|---|---|
|
integer; optional |
The height in device-independent pixels. |
|
integer; optional |
The width in device-independent pixels. |
PMP and Deal objects
PMP object
Field | Type | Description |
---|---|---|
|
Integer; optional |
The scope of DSP bidding eligibility for this impression, where:
|
|
Array of Objects; optional |
A collection of Direct Deals Objects containing any direct deals eligible for this impression. |
|
Object; optional |
A custom Index PMP Extension Object that contains additional information about this deal. |
Deal object
The PMP Object may contain one or more additional Deals Objects, each representing a different direct deal for this impression:
Field | Type | Description |
---|---|---|
|
String; required |
A unique identifier for this direct deal. |
|
Integer; optional |
The auction type for this direct deal, where:
Note: The second price auction type is deprecated and no longer supported. |
|
Integer (if sent as cents, like 134) or Float (if sent as dollars, like 1.34); optional |
Designated floor price for this direct deal, in US (sent in cents, by default). For more information about the Note: It can be sent in dollars if requested, but the price in the response Bid Object must also be sent in dollars.
|
|
String; optional |
The currency for the bid floor. Currencies must be specified in the ISO-4217 standard and must be supported by Index. For more information, see List of supported currencies. |
|
String; optional |
A whitelist of buyer seats (for example, advertisers, agencies) that are allowed to bid on a deal. |
PMP extension object
The PMP Object may contain an IX-custom PMP extension Object, containing additional information about the direct deal.
Field | Type | Description |
---|---|---|
|
String; optional |
Placement name for all impressions operating in the private market. Example: "The Daily Times". |
Deals extension object
To provide transparency to DSPs during an auction and to identify Post-Auction Discounts opportunities on deals, Index will pass the following disc
field in the deals.ext
object of a bid request:
Field | Type | Description |
---|---|---|
Float |
A number between 0.01 - 1.0 representing the discount negotiated between a publisher and buyer. This value is applied to the Example: A 25% discount is sent as To learn more about discounts for deals, see Negotiating discounts on deals. |
SKAdNetwork extension object
The skadn
object may include an extension object. To learn more, see OpenRTB SKAdNetwork extension.
Field | Type | Description |
---|---|---|
|
String; optional |
The version of skadnetwork supported. This field is always "2.0" or higher and is dependent on both the OS version and the SDK version. Note: With the release of SKAdNetwork 2.1, this field is deprecated in favor of the |
|
String array; optional |
An array of strings containing the supported skadnetwork versions. This field is always "2.0" or higher and is dependent on both the OS version and the SDK version. |
|
String; optional |
The ID of the publisher app in Apple’s app store. It should match the |
|
String array; optional |
A subset of SKAdNetworkItem entries in the publisher app’s Info.plist , expressed as lowercase strings, that are relevant to the bid request. It is recommended that this list does not exceed 10.
Note: BidRequest.imp.ext.skadn.skadnetlist.addl is the preferred method to express raw SKAdNetwork IDs. |
skadnetlist
|
Object; optional | An object containing the IAB's list definition. See skadnetlist object below. Example: "skadnetlist": {"max": 306, "excl": [2,8,10,123], "addl": ["cdkw7geqsh.skadnetwork", "qyJfv329m4.skadnetwork"]} |
Skadnetlist object
This object provides the IAB's skadnetwork
object list fields.
Field | Type | Description |
---|---|---|
|
Integer; optional |
A list containing the max entry ID of SKAdNetwork ID. |
|
Integer array; optional |
A comma separated list of IAB registration IDs that are to be excluded from the IAB shared list. |
|
String array; optional |
A comma separated list of string SKAdNetwork IDs, expressed as lowercase strings, not included in the IAB shared list. It is recommended that this list should not exceed 10 IDs. |
Site object
Field | Type | Description |
---|---|---|
|
String; required |
The Index-assigned unique identifier for the website. |
|
Array of Strings; optional |
A single-element array representing the standard IAB content category for the overall site. For example, [" |
|
Object; optional |
The Content Object. For more information about the |
|
String; optional |
A static value that represents the site’s domain. |
|
Integer; optional |
Specifies whether the site has been programmed to optimize layout when viewed on mobile devices, where:
|
|
String; optional |
The URL of the page where this impression will be shown. |
|
Object; optional |
Provides details about the producer of the content. For more information about the |
|
Object; optional |
The Publisher Object. |
|
String; optional |
The referring URL that caused navigation to the page hosting this impression. Anything above 512 characters is truncated. |
App object
Field | Type | Description |
---|---|---|
|
String; required |
The Index-assigned unique numeric identifier for this app. |
|
String; optional |
The App name or bundle (for example, "com.foo.mygame"), used as a unique identifier across exchanges. |
|
Array of Strings; optional |
The standard IAB content category for the overall site (for example, [" |
|
Object; optional |
Details about content within the app. For more information about the |
|
Optional |
A static value representing the domain of the app. |
|
String; optional |
A comma-separated list of keywords related to the app. Maximum of 255 characters. |
|
String; optional |
The name of the app. It may be masked if requested by the publisher. |
|
Integer; optional |
Specifies whether the app is a paid or free version, where:
|
|
Integer; optional |
Specifies whether the app has a privacy policy, where:
|
|
Object; optional |
Provides details about the producer of the content. For more information about the |
|
Object; optional |
The Publisher Object. |
|
String; optional |
The App store URL for an installed app for QAG 1.5 compliance. |
|
String; optional |
The application version. |
|
object; optional |
The App extension object, which is used to provide more information about the app impression opportunity. |
App extension object
The app
object may include an Extension object. It provides additional information about the app impression opportunity.
Field | Type | Description |
---|---|---|
|
String; optional |
A pointer to the domain of a partner that is explicitly authorized to monetize ads within this application's content. The partner's corresponding appads.txt or ads.txt file will be hosted at this domain and can be used for supply chain validation. For more information about how to implement this field, see the IAB's ads.txt Specification. |
Content, Producer, and Publisher objects
Content object
Field | Type | Description |
---|---|---|
|
String; optional |
The album to which the content belongs, typically for audio. |
|
String; optional |
The artist who is credited with the content. |
|
String array; optional |
A single-element array representing the standard IAB content category for the overall site. For example, |
|
String; optional |
The content's rating (for example, |
|
Integer; optional |
Refers to the type of content, where:
|
|
Object array; optional |
Provides additional content data. |
|
Integer; optional |
Indicator of whether or not the content is embeddable, where:
|
|
String; optional |
Episode number that applies to video content. |
|
Object; optional |
A placeholder for Index-specific extensions to the content object. See the Content extension object table below. |
|
String; optional |
The genre that best describes the content. For example, rock, pop, etc. |
|
String; optional |
ID that uniquely identifies the content. |
|
String; optional |
International Standard Recording Code conforming to ISO-3901. |
|
String; optional |
A comma separated list of keywords describing the content. |
|
String; optional |
The first two characters of the language, in uppercase, as per ISO-639-1-alpha-2. For example, |
|
Integer; optional |
Used for video and audio, and specifies the length of the content in seconds. |
|
Integer; optional |
Specifies if the content is live (for example, a stream or live blog), where:
|
|
Integer; optional |
Refers to the production quality, where:
|
|
Object; optional |
Details about the content producer. For more information, see |
|
Integer; optional |
The media rating as per Quality Assurance Guidelines (QAG), where:
|
|
String; optional |
The season of the content (for example, " |
|
String; optional |
Content series. |
|
Integer; optional |
Specifies the relationship to the source, where:
|
|
String; optional |
The title of the content. |
|
String; optional |
URL of the content, for buy-side contextualization or review. |
|
String; optional |
How users have rated the content. For example, number of stars, number of likes. |
|
Integer; optional |
Refers to the video quality. |
Content extension object
The content
object may include an Index-specific extension object that describes the impression content.
Field | Type | Description |
---|---|---|
|
String; optional |
The specific channel that the content is playing on. |
|
String; optional |
The specific channel that the content is playing on. |
|
String; optional |
The parent content network that contains several channels. |
|
String; optional |
The parent content network that contains several channels. |
|
String; optional |
The alternate name under which the publisher distributes the content. |
Producer object
Field | Type | Description |
---|---|---|
|
String array; optional |
A single-element array representing the standard IAB content category for the overall site. For example, |
|
String; optional |
The highest level domain of the content producer. For example, "producer.com". |
|
Object; optional |
A placeholder for Index-specific extensions to the producer object. |
|
String; optional |
An ID that represents the content producer or originator. This field is useful if the content is syndicated and posted on a site using embed tags. |
|
String; optional |
The name of the content producer or originator. For example, "Warner Bros". |
Publisher object
Field | Type | Description |
---|---|---|
|
String; required
|
The Index-specific publisher ID. |
|
String; optional |
A name that represents the publisher that can be masked if requested. Note: This field is always present when a deal exists. |
Device object
Field | Type | Description |
---|---|---|
|
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). |
|
Integer; optional |
The device type in use for this impression, if available, where:
|
|
String; optional |
The hardware device ID , hashed via MD5. For example, IMEI . |
|
String; optional |
The hardware device ID, hashed via SHA1. For example, IMEI . |
|
String; optional |
The platform device ID, hashed via MD5. For example, Android ID . |
|
String; optional |
The platform device ID, hashed via SHA1. For example, Android ID . |
|
Object; optional |
The Geo object. |
|
Integer; optional |
The physical height of the device screen, in pixels. Note: Only supported in OpenRTB 2.3. |
|
String; optional |
Represents the hardware version of the device. For example, "5S" represents an iPhone 5S. Note: Only supported in OpenRTB 2.3. |
|
Integer; optional |
The network connection type that the device uses, where:
|
|
String; optional |
An ID sanctioned for advertiser use in the clear (not hashed). It is an identifier for ads with privacy support and is used along with the device.lmt and device.ext.ifa_type fields. |
|
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 |
|
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 |
|
String; optional |
The first two characters of the header, in uppercase. For example, HTTP_ACCEPT_LANGUAGE "EN" |
|
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:
Note: Only supported in OpenRTB 2.3. |
|
String; optional |
MAC address of the device; hashed via MD5. |
|
String; optional |
MAC address of the device; hashed via SHA1. |
|
String; optional |
The device make. For example, "Apple". |
|
String; optional |
The device model. For example,"iPhone" |
|
String; optional |
The device operating system. For example, "iOS" |
|
String; optional |
The device operating system version. For example, “3.1.2" |
|
Integer; optional |
The pixels per linear inch. Note: Only supported in OpenRTB 2.3. |
|
Float; optional |
The ratio of physical pixels to device-independent pixel. Note: Only supported in OpenRTB 2.3. |
|
String; optional |
The content of the HTTP_USER_AGENT header for this user. Anything above 512 characters is truncated. |
|
Integer; optional |
The physical width of the device screen, in pixels. Note: Only supported in OpenRTB 2.3. |
|
Integer; optional |
A placeholder for Index specific extensions to the device object. See Device extension object below. |
Device extension object
The device
object may include an extension object to indicate the app's app tracking authorization status and IDFV. It may also include the Identifier for Advertising (IFA) source value according to the IAB Tech Lab's Guidelines for Identifier for Advertising (IFA) on CTV/OTT platforms.
Field | Type | Description |
---|---|---|
|
String; optional |
The IDFV of the device with the publisher. |
|
Integer; optional |
An iOS only field that is passed to represent the app's app tracking authorization status, where:
|
|
String; optional |
A value indicating the source of the IFA value, whether it is device-generated, provided by the publisher, or is a temporary session IFA. The supported values are:
For more information about |
Geo object
Field | Type | Description |
---|---|---|
|
String; optional |
The city, as per United Nations Code for Trade & Transport Locations. See UN/LOCODE Code List. |
|
String; optional |
The country code, using ISO-3166-1-alpha-3. |
|
Float; optional |
The latitude from -90.0 to +90.0, where negative is south. |
|
Float; optional |
The longitude from -180.0 to +180.0, where negative is west. |
|
String; optional |
The Google metro code; similar to but not exactly Nielsen DMAs. See List of Google Metro Codes. |
|
String; optional |
The region code using ISO-3166-2; 2-letter state code if USA ("US" ). |
|
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. |
|
Integer; optional |
The source of location data; recommended when passing lat and lon. See List of location types. |
|
String; optional |
The zip code or postal code. |
|
Integer; optional |
The local time as the number +/- of minutes from UTC. Note: Only supported in OpenRTB 2.3. |
User object
Field | Type | Description |
---|---|---|
|
String; optional |
A DSP's UID for this user (see user matching for format). Note: This field is always present in default user match configuration. |
|
Array of objects; optional |
This object is used by publishers to pass additional attributes about the user or content. See the Data object. |
|
Object; optional |
The |
|
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. |
User extension object
Field | Type | Description |
---|---|---|
|
String; optional |
Specifies user consent when GDPR regulations are in effect. When present, it contains the data structure developed by the GDPR Consent Working Group. For more information, refer to the OpenRTB GDPR Advisory, published by the IAB. |
|
Array of objects; optional |
An array of EIDs Objects, used to communicate email IDs for this user. |
|
Integer; optional |
Specifies whether the request is subject to regulations, where:
If this field is omitted, Index assumes that the request's status is unknown. For more information, refer to the OpenRTB GDPR Advisory, published by the IAB. |
EID object
Field | Type | Description |
---|---|---|
|
String; optional |
The source of the IDs. For example, "adserver.org". |
|
Array of objects; optional |
An array of UID object. |
|
String; optional |
The user ID received in the request. |
|
Object; optional |
The EID extension Object. |
EID extension object
Field | Type | Description |
---|---|---|
|
String; optional |
The name of the Universal ID provider. For example, " |
UID object
Field | Type | Description |
---|---|---|
|
String; optional |
The user ID. For example, " |
|
Object; optional |
The UID extension object. |
UID extension object
Field | Type | Description |
---|---|---|
|
String; optional |
The name of the Universal ID provider. For example, " |
Data object
Field | Type | Description |
---|---|---|
|
Object; optional |
The data extension object that contains community extensions. See the Data extension object. |
name
|
String; optional | The unique domain of the business entity who is stating the additional information about the user or content. |
|
Array of objects; optional |
Contains additional information about the related objrct that is specified, such as the user, site, or app object. See the Segment object. |
Data extension object
Field | Type | Description |
---|---|---|
|
Integer; optional |
The ID associated with a taxonomy that is registered centrally with the IAB Tech Lab. |
Segment object
Field | Type | Description |
---|---|---|
|
String; optional |
The ID that is associated with this data segment and is specific to the data provider. |