2.6 Specifications

√

√

√

x

√

rwdd¹

integer

ssai

exp

placement²

Video placement type for the impression. Refer to List: Placement Subtypes – Video in AdCOM 1.0.

w

integer

Width in device independent pixels (DIPS).

h

integer

Height in device independent pixels (DIPS).

wratio

integer

Relative width when expressing size as a ratio.

hratio

integer

Relative height when expressing size as a ratio.

wmin

integer

The minimum width in device independent pixels (DIPS) at which the ad will be displayed the size is expressed as a ratio.

ext

object

Placeholder for exchange-specific extensions to OpenRTB.

private_auction

integer

Indicator of auction eligibility to seats named in the Direct Deals object, where 0=all bids are accepted, 1=bids are restricted to the deals specified and the terms thereof.

deals

object array

Array of Deal (Section 3.2.12) objects that convey the specific deals applicable to this impression.

ext

object

Placeholder for exchange-specific extensions to OpenRTB.

id

required

string

A unique identifier for the direct deal.

bidfloor

optional

float

Minimum bid for this impression expressed in CPM.

bidfloorcur

optional

string

Currency specified using ISO-4217 alpha codes. This may be different from bid currency returned by bidder if this is allowed by the exchange. This field does not inherit from `Imp.bidfloorcur`; it is either explicitly specified or defaults to USD.

at

optional

integer

Optional override of the overall auction type of the bid request, where 1 = First Price, 2 = Second Price Plus, 3 = the value passed in bidfloor is the agreed upon deal price. Additional auction types can be defined by the exchange.

wseat

optional

string array

Allowed list of buyer seats (e.g., advertisers, agencies) allowed to bid on this deal. IDs of seats and the buyer’s customers to which they refer must be coordinated between bidders and the exchange a priori. Omission implies no seat restrictions.

wadomain

optional

string array

Array of advertiser domains (for example, Advertiser.com domain name is for sale ) allowed to bid on this deal. Omission implies no advertiser restrictions.

guar¹

optional

integer

Indicates that the deal is of type `guaranteed` and the bidder must bid on the deal, where 0 = not a guaranteed deal, 1 = guaranteed deal.

mincpmpersec¹

optional

float

Minimum CPM per second. This is a price floor for video or audio impression opportunities, relative to the duration of bids an advertiser may submit.

ext

optional

object

Placeholder for exchange-specific extensions to OpenRTB.

id

string

Exchange-specific site ID.

name

string

Site name (may be aliased at the publisher’s request).

domain

string

Domain of the site (e.g., “Foo.com “).

cattax

integer

The taxonomy in use. Refer to the AdCOM List: Category Taxonomies for values. If no cattax field is supplied, IAB Content Category Taxonomy 1.0 is assumed.

cat

string array

Array of IAB Tech Lab content categories of the site. The taxonomy to be used is defined by the cattax field.

sectioncat

string array

Array of IAB Tech Lab content categories that describe the current section of the site. The taxonomy to be used is defined by the cattax field.

pagecat

string array

Array of IAB Tech Lab content categories that describe the current page or view of the site. The taxonomy to be used is definied by the cattax field.

page

string

URL of the page where the impression will be shown.

ref

string

Referrer URL that caused navigation to the current page.

search

string

Search string that caused navigation to the current page.

mobile

integer

Indicates if the site has been programmed to optimize layout when viewed on mobile devices, where 0=no, 1=yes.

privacypolicy

integer

Indicates if the site has a privacy policy, where 0 = no, 1 = yes.

publisher

object

Details about the see Publisher (Section 3.2.15) of the site.

content

object

Details about the Content (Section 3.2.16) within the site.

keywords

string

Comma separated list of keywords about the site. Only one of keywords or kwarray may be present.

kwarray

string array

Array of keywords about the site. Only one of keywords or kwarray may be present.

inventorypartnerdomain

string

The taxonomy in use. Refer to the AdCOM List: Category Taxonomies for values. If no cattax field is supplied, IAB Content Category Taxonomy 1.0 is assumed.

ext

object

Placeholder for exchange-specific extensions to OpenRTB.

id

string

Exchange-specific app ID.

name

string

App name (may be aliased at the publisher’s request).

bundle

string

The store ID of the app in an app store. See OTT/CTV Store Assigned App Identification Guidelines for more details about expected strings for CTV app stores. For mobile apps in Google Play Store, these should be bundle or package names (e.g. com.foo.mygame). For apps in Apple App Store, these should be a numeric ID.

domain

string

Domain of the app (e.g., “Foo.com “).

storeurl

string

App store URL for an installed app; for IQG 2.1 compliance.

cattax¹

integer

The taxonomy in use. Refer to the AdCOM List: Category Taxonomies for values.

cat

string array

Array of IAB Tech Lab content categories of the app. The taxonomy to be used is defined by the cattax field. If no cattax field is supplied Content Category Taxonomy 1.0 is assumed.

sectioncat

string array

Array of IAB Tech Lab content categories that describe the current section of the app. The taxonomy to be used is defined by the cattax field.

pagecat

string array

Array of IAB Tech Lab content categories that describe the current page or view of the app. The taxonomy to be used is definied by the cattax field.

ver

string

Application version.

privacypolicy

integer

Indicates if the app has a privacy policy, where 0 = no, 1 = yes.

paid

integer

0 = app is free, 1 = the app is a paid version.

publisher

object

Details about the Publisher (Section 3.2.15) of the app.

content

object

Details about the Content (Section 3.2.16) within the app.

keywords

string

Comma separated list of keywords about the app. Only one of keywords or kwarray may be present.

kwarray

string array

Array of keywords about the app. Only one of keywords or kwarray may be present.

inventorypartnerdomain¹

string

A domain to be used for inventory authorization in the case of inventory sharing arrangements between an app owner and content owner. This field is typically used by authorization crawlers to establish the domain of the content owner, who has the right to monetize some portion of ad inventory within the app. The content owner’s domain should be listed in the app owner’s app-ads.txt file as an inventorypartnerdomain. Authorization for supply from the inventorypartnerdomain will be published in the ads.txt file on the root of that domain. Refer to the ads.txt 1.1 spec for more details.

ext

object

Placeholder for exchange-specific extensions to OpenRTB.

id

string

Exchange-specific seller ID. Every ID must map to only a single entity that is paid for inventory transacted via that ID. Corresponds to a seller_id of a seller in the exchange’s sellers.json file.

–

name

string

Seller name (may be aliased at the seller’s request).

–

cattax¹

integer

The taxonomy in use. Refer to the AdCOM List: Category Taxonomies for values.

1

cat

string array

Array of IAB Tech Lab content categories of the publisher. The taxonomy to be used is defined by the cattax field. If no cattax field is supplied Content Category Taxonomy 1.0 is assumed.

–

domain

string

Highest level domain of the seller (e.g., “Seller.com “).

–

ext

object

Placeholder for exchange-specific extensions to OpenRTB.

id

string

ID uniquely identifying the content.

episode

integer

Episode number.

title

string

Content title.
*Video Examples:* “Search Committee” (television), “A New Hope” (movie), or “Endgame” (made for web).
*Non-Video Example:* “Why an Antarctic Glacier Is Melting So Quickly” (Time magazine article).

series

string

Content series.
*Video Examples:* “The Office” (television), “Star Wars” (movie), or “Arby ‘N’ The Chief” (made for web).
*Non-Video Example:* “Ecocentric” (Time Magazine blog).

season

string

Content season (e.g., “Season 3”).

artist

string

Artist credited with the content.

genre

string

Genre that best describes the content (e.g., rock, pop, etc).

album

string

Album to which the content belongs; typically for audio.

isrc

string

International Standard Recording Code conforming to ISO- 3901.

producer

object

Details about the content Producer (Section 3.2.17).

url

string

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

cattax¹

integer

The taxonomy in use. Refer to list List: Category Taxonomies in AdCOM 1.0 for values.

cat

string array

Array of IAB Tech Lab content categories that describe the content. The taxonomy to be used is defined by the cattax field. If no cattax field is supplied Content Category Taxonomy 1.0 is assumed.

prodq

integer

Production quality. Refer to List: Production Qualities in AdCOM 1.0.

context

integer

Type of content (game, video, text, etc.). Refer to List: Content Contexts in AdCOM 1.0.

contentrating

string

Content rating (e.g., MPAA).

userrating

string

User rating of the content (e.g., number of stars, likes, etc.).

qagmediarating

integer

Media rating per IQG guidelines. Refer to List: Media Ratings in AdCOM 1.0.

keywords

string

Comma separated list of keywords describing the content. Only one of keywords or kwarray may be present.

kwarray

string array

Array of keywords about the site. Only one of keywords or kwarray may be present.

livestream

integer

0 = not live, 1 = content is live (e.g., stream, live blog).

sourcerelationship

integer

0 = indirect, 1 = direct.

len

integer

Length of content in seconds; appropriate for video or audio.

language¹

string

Content language using ISO-639-1-alpha-2. Only one of language or langb should be present.

langb

string

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

embeddable

integer

Indicator of whether the content is embeddable (e.g., an embeddable video player), where 0 = no, 1 = yes.

data

object array

Additional content data. Each Data object (Section 3.2.21) represents a different data source.

network

object

Details about the network (Section 3.2.23) the content is on.

channel

object

Details about the channel (Section 3.2.24) the content is on.

ext

object

Placeholder for exchange-specific extensions to OpenRTB.

id

string

Content producer or originator ID. Useful if content is syndicated and may be posted on a site using embed tags.

name

string

Content producer or originator name (e.g., “Warner Bros”).

cattax¹

integer

The taxonomy in use. Refer to the AdCOM 1.0 list List: Category Taxonomies for values.

cat

string array

Array of IAB Tech Lab content categories that describe the content producer. The taxonomy to be used is defined by the cattax field. If no cattax field is supplied Content Category Taxonomy 1.0 is assumed.

domain

string

Highest level domain of the content producer (e.g., “producer.com“).

ext

object

Placeholder for exchange-specific extensions to OpenRTB.

geo

object

Location of the device assumed to be the user’s current location defined by a Geo object (Section 3.2.19).

dnt

integer

Standard “Do Not Track” flag as set in the header by the browser, where 0 = tracking is unrestricted, 1 = do not track.

lmt

integer

“Limit Ad Tracking” signal commercially endorsed (e.g., iOS, Android), where 0 = tracking is unrestricted, 1 = tracking must be limited per commercial guidelines.

ua

string

Browser user agent string. This field represents a raw user agent string from the browser. For backwards compatibility, exchanges are recommended to always populate ua with the User-Agent string, when available from the end user’s device, even if an alternative representation, such as the User-Agent Client-Hints, is available and is used to populate sua. No inferred or approximated user agents are expected in this field.
If a client supports User-Agent Client Hints, and sua field is present, bidders are recommended to rely on sua for detecting device type, browser type and version and other purposes that rely on the user agent information, and ignore ua field. This is because the ua may contain a frozen or reduced user agent string.

sua

object

Structured user agent information defined by a UserAgent object (see Section 3.2.29). 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.

ip

string

IPv4 address closest to device.

ipv6

string

IP address closest to device as IPv6.

devicetype

integer

The general type of device. Refer to List: Device Types in AdCOM 1.0.

make

string

Device make (e.g., “Apple”).

model

string

Device model (e.g., “iPhone”).

os

string

Device operating system (e.g., “iOS”).

osv

string

Device operating system version (e.g., “3.1.2”).

hwv

string

Hardware version of the device (e.g., “5S” for iPhone 5S).

h

integer

Physical height of the screen in pixels.

w

integer

Physical width of the screen in pixels.

ppi

integer

Screen size as pixels per linear inch.

pxratio

float

The ratio of physical pixels to device independent pixels.

js

integer

Support for JavaScript, where 0 = no, 1 = yes.

geofetch

integer

Indicates if the geolocation API will be available to JavaScript code running in the banner, where 0 = no, 1 = yes.

flashver

string

Version of Flash supported by the browser.

language

string

Browser language using ISO-639-1-alpha-2. Only one of language or langb should be present.

langb

string

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

carrier

string

Carrier or ISP (e.g., “VERIZON”) using exchange curated string names which should be published to bidders *a priori*.

mccmnc¹

string

Mobile carrier as the concatenated MCC-MNC code (e.g., “310-005” identifies Verizon Wireless CDMA in the USA). Refer to Mobile country code for further examples. Note that the dash between the MCC and MNC parts is required to remove parsing ambiguity. The MCC-MNC values represent the SIM installed on the device and do not change when a device is roaming. Roaming may be inferred by a combination of the MCC-MNC, geo, IP and other data signals.

connectiontype

integer

Network connection type. Refer to List: Connection Types in AdCOM 1.0.

ifa

string

ID sanctioned for advertiser use in the clear (i.e., not hashed)

Unless prior arrangements have been made between the buyer and the seller directly, the value in this field is expected to be an ID derived from a call to an advertising API provided by the device’s Operating System.

didsha1²

string

Hardware device ID (e.g., IMEI); hashed via SHA1.

didmd5²

string

Hardware device ID (e.g., IMEI); hashed via MD5.

dpidsha1²

string

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

dpidmd5²

string

Platform device ID (e.g., Android ID); hashed via MD5.

macsha1²

string

MAC address of the device; hashed via SHA1.

macmd5²

string

MAC address of the device; hashed via MD5.

ext

object

Placeholder for exchange-specific extensions to OpenRTB.

lat

float

Latitude from -90.0 to +90.0, where negative is south.

lon

float

Longitude from -180.0 to +180.0, where negative is west.

type

integer

Source of location data; recommended when passing lat/lon. Refer to List: Location Types in AdCOM 1.0.

accuracy

integer

Estimated location accuracy in meters; recommended when lat/lon are specified and derived from a device’s location services (i.e., type = 1). Note that this is the accuracy as reported from the device. Consult OS specific documentation (e.g., Android, iOS) for exact interpretation.

lastfix

integer

Number of seconds since this geolocation fix was established. Note that devices may cache location data across multiple fetches. Ideally, this value should be from the time the actual fix was taken.

ipservice

integer

Service or provider used to determine geolocation from IP address if applicable (i.e., type = 2). Refer to List: IP Location Services in AdCOM 1.0.

country

string

Country code using ISO-3166-1-alpha-3.

region

string

Region code using ISO-3166-2; 2-letter state code if USA.

regionfips104

string

Region of a country using FIPS 10-4 notation. While OpenRTB supports this attribute, it was withdrawn by NIST in 2008.

metro

string

Google metro code; similar to but not exactly Nielsen DMAs. See Appendix A for a link to the codes.

city

string

City using United Nations Code for Trade & Transport Locations. See Appendix A for a link to the codes.

zip

string

ZIP or postal code.

utcoffset

integer

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

ext

object

Placeholder for exchange-specific extensions to OpenRTB.

id

string

Exchange-specific ID for the user. Unless prior arrangements have been made between the buyer and the seller directly, the value in this field is expected to be derived from an ID sync. (see Appendix: Cookie Based ID Syncing)

buyeruid

string

Buyer-specific ID for the user as mapped by the exchange for the buyer.Unless prior arrangements have been made between the buyer and the seller directly, the value in this field is expected to be derived from an ID sync. (see Appendix: Cookie Based ID Syncing)

yob²

integer

Year of birth as a 4-digit integer.

gender²

string; DEPRECATED

Gender, where “M” = male, “F” = female, “O” = known to be other (i.e., omitted is unknown).

keywords

string

Comma separated list of keywords, interests, or intent. Only one of keywords or kwarray may be present.

kwarray

string array

Array of keywords about the user. Only one of keywords or kwarray may be present.

customdata

string

Optional feature to pass bidder data that was set in the exchange’s cookie. The string must be in base85 cookie safe characters and be in any format. Proper JSON encoding must be used to include “escaped” quotation marks.

geo

object

Location of the user’s home base defined by a Geo object (Section 3.2.19). This is not necessarily their current location.

data

object array

Additional user data. Each Data object (Section 3.2.21) represents a different data source.

consent

string

When GDPR regulations are in effect this attribute contains the Transparency and Consent Framework’s Consent String data structure.

eids

object array

Details for support of a standard protocol for multiple third party identity providers (Section 3.2.27).

ext

object

Placeholder for exchange-specific extensions to OpenRTB.

id

string

Exchange-specific ID for the data provider.

name

string

Exchange-specific name for the data provider.

segment

object array

Array of Segment (Section 3.2.22) objects that contain the actual data values.

ext

object

Placeholder for exchange-specific extensions to OpenRTB.

id

string

ID of the data segment specific to the data provider.

name

string

Name of the data segment specific to the data provider.

value

string

String representation of the data segment value.

ext

object

Placeholder for exchange-specific extensions to OpenRTB.

id

string

A unique identifier assigned by the publisher. This may not be a unique identifier across all supply sources.

name

string

Network the content is on (e.g., a TV network like “ABC”)

domain

string

The primary domain of the network (e.g. “ABC Network – ABC.com ” in the case of the network ABC). It is recommended to include the top private domain (PSL+1) for DSP targeting normalization purposes.

ext

object

Placeholder for exchange-specific extensions to OpenRTB.

id

string

A unique identifier assigned by the publisher. This may not be a unique identifier across all supply sources.

name

string

Channel the content is on (e.g., a TV channel like “WABC-TV”)

domain

string

The primary domain of the channel (e.g. “ABC7 Eyewitness News – WABC-TV New York ” in the case of the local channel WABC-TV). It is recommended to include the top private domain (PSL+1) for DSP targeting normalization purposes.

ext

object

Placeholder for exchange-specific extensions to OpenRTB.

complete

integer

Flag indicating whether the chain contains all nodes involved in the transaction leading back to the owner of the site, app or other medium of the inventory, where 0 = no, 1 = yes.

nodes

object array

Array of SupplyChainNode objects in the order of the chain. In a complete supply chain, the first node represents the initial advertising system and seller ID involved in the transaction, i.e. the owner of the site, app, or other medium. In an incomplete supply chain, it represents the first known node. The last node represents the entity sending this bid request.

ver

string

Version of the supply chain specification in use, in the format of “major.minor”. For example, for version 1.0 of the spec, use the string “1.0”.

ext

object

Placeholder for exchange-specific extensions to OpenRTB.

asi

string

The canonical domain name of the SSP, Exchange, Header Wrapper, etc system that bidders connect to. This may be the operational domain of the system, if that is different than the parent corporate domain, to facilitate WHOIS and reverse IP lookups to establish clear ownership of the delegate system. This should be the same value as used to identify sellers in an ads.txt file if one exists.

sid

string

The identifier associated with the seller or reseller account within the advertising system. This must contain the same value used in transactions (i.e. OpenRTB bid requests) in the field specified by the SSP/exchange. Typically, in OpenRTB, this is publisher.id. For OpenDirect it is typically the publisher’s organization ID. Should be limited to 64 characters in length.

rid

string

The OpenRTB RequestId of the request as issued by this seller.

name

string

The name of the company (the legal entity) that is paid for inventory transacted under the given seller_ID. This value is optional and should NOT be included if it exists in the advertising system’s sellers.json file.

domain

string

The business domain name of the entity represented by this node. This value is optional and should NOT be included if it exists in the advertising system’s sellers.json file.

hp

integer

Indicates whether this node will be involved in the flow of payment for the inventory. When set to 1, the advertising system in the asi field pays the seller in the sid field, who is responsible for paying the previous node in the chain. When set to 0, this node is not involved in the flow of payment for the inventory. For version 1.0 of SupplyChain, this property should always be 1. Implementers should ensure that they propagate this field onwards when constructing SupplyChain objects in bid requests sent to a downstream advertising system.

ext

object

Placeholder for advertising-system specific extensions to this object.

nserter²

string

The canonical domain name of the entity (publisher, publisher monetization company, SSP, Exchange, Header Wrapper, etc.) that caused the ID array element to be added. This may be the operational domain of the system, if that is different from the parent corporate domain, to facilitate WHOIS and reverse IP lookups to establish clear ownership of the delegate system.

This should be the same value as used to identify sellers in an ads.txt file if one exists.

For ad tech intermediaries, this would be the domain as used in ads.txt. For publishers, this would match the domain in the site or app object.

–

source

string

Canonical domain of the ID.

–

matcher²

string

Technology providing the match method as defined in mm.

In some cases, this may be the same value as inserter.

When blank, it is assumed that the matcher is equal to the source

May be omitted when mm=0, 1, or 2.

-.

mm²

int

Match method used by the matcher. Refer to List: ID Match Methods in AdCOM 1.0

-.

uids

object array

Array of extended ID UID objects from the given source. Refer to the Extended Identifier UIDs object (Section 3.2.28)

–

ext

object

Placeholder for exchange-specific extensions to OpenRTB.

–

id

string

The identifier for the user.

–

atype

integer

Type of user agent the ID is from. It is highly recommended to set this, as many DSPs separate app-native IDs from browser-based IDs and require a type value for ID resolution. Refer to List: Agent Types in AdCOM 1.0

–

ext

object

Placeholder for vendor specific extensions to this object.

-.

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 string

A sequence of version components, in descending hierarchical order (major, minor, micro)

ext

object

Placeholder for vendor specific extensions to this object.

refsettings

object array

A RefSettings object (see Section 3.2.34) describing the mechanics of how an ad placement automatically refreshes.

count

integer

The number of times this ad slot had been refreshed since last page load.

ext

object

Placeholder for vendor specific extensions to this object.

reftype

integer

The type of the declared auto refresh. Refer to List: Auto Refresh Triggers in AdCOM 1.0

minint

integer

The minimum refresh interval in seconds. This applies to all refresh types. This is the (uninterrupted) time the ad creative will be rendered before refreshing to the next creative. If the field is absent, the exposure time is unknown. This field does not account for viewability or external factors such as a user leaving a page.

ext

object

Placeholder for vendor specific extensions to this object.

Deprecated in favor of the apisinteger array. API required by the markup if applicable. Refer to List: API Frameworks in AdCOM 1.0.

langb

string

Language of the creative using IETF BCP 47. Only one of language or langb should be present.

dealid

string

Reference to the deal.id from the bid request if this bid pertains to a private marketplace direct de