Page tree



The following parameters in OpenRTB 2.4 + are supported by PubMatic.

Consumer Identifier

Consumer identifiers support in the OpenRTB specification allows buyers to use audience data in real time bidding. For additional information, refer to IAB OpenRTB 3.0 documentation.

Object: Imp

AttributeTypeDescription
metricObject ArrayAn array of a Metric Object
extObjectPlaceholder for exchange-specific extensions of OpenRTB

Object: Banner

AttributeTypeDescription
apiInteger ArrayList of supported API frameworks for this impression. If an API is not explicitly listed, it is assumed not to be supported.

Object: Video

AttributeTypeDescription
battrInteger ArrayBlocked creative attributes.

Object: App

AttributeTypeDescription
extObjectPlaceholder for exchange-specific extensions to OpenRTB.

Object: Site

AttributeTypeDescription
extObjectPlaceholder for exchange-specific extensions to OpenRTB.

Object: User

AttributeTypeDescription
extObjectPlaceholder for exchange-specific extensions to OpenRTB.

Object: Regs

AttributeTypeDescription
extObjectPlaceholder for exchange-specific extensions to OpenRTB.

Object: Geo

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

Object: Metric

Attribute

Type

Description

typeStringType of metric being presented using exchange-curated string names, which should be published to bidders a priori.
valueFloatNumber representing the value of the metric. Probabilities must b in the range of 0.0 - 1.0.
vendorStringSource of the value using exchange-curated string names, which should be published to bidders a priori. If the exchange itself is the source versus a third party, "EXCHANGE" is recommended.

Added field to User Object

AttributeTypeDescription
eidsObject ArrayAn array of Extended ID objects

Object: eids (Extended IDs)

AttributeTypeDescription
sourceStringSource or technology provider responsible for the set of included IDs. Expressed as a top-level domain.
uidsObject ArrayArray of extended ID UID objects.

Object: uids (Extended ID UIDs)


AttributeTypeDescription
idStringCookie or platform native of the identifier
atypeIntegerType of user agent the match is from. See agent types table below.

Object: Content                 

Attribute

Type

Description

idstring   ID uniquely identifying the content.
episode       integerEpisode number (typically applies to video content).
title         string   Content title.
series        string   Content series.
season        string   Content season; typically for video content (e.g., “Season 3”).
producer      Producer   objectDetails about the content Producer
url           string   URL of the content, for buy-side contextualization or review.
cat           string  arrayArray of IAB content categories that describe the content producer.
videoqualityinteger      Video quality per IAB’s classification.
contentratingstring   Content rating (e.g., MPAA).
userrating    string   User rating of the content (e.g., number of stars, likes, etc.).
qagmediaratinginteger      Media rating per QAG guidelines.
keywords      string   Comma separated list of keywords describing the content.
livestream    integer      0 = not live, 1 = content is live (e.g., stream, live blog).
sourcerelationshipinteger       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.
embeddable    integer      Indicator of whether or not the content is embeddable where 0 = no, 1 = yes.
ext           objectPlaceholder for exchange-specific extensions to OpenRTB.

Object: Producer

Attribute

Type

Description

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”).
cat   string arrayArray of IAB content categories that describe the content producer.
domainstring   Highest level domain of the content producer (e.g., “producer.com”).
ext   objectPlaceholder for exchange-specific extensions to OpenRTB.

Object: consented_providers_setting

AttributeTypeDescriptionscope
consented_providersString arrayList of provider_ids that has user consentoptional

Object: Banner

AttributeTypeDescription
formatObject arrayArray of format objects representing the banner sizes permitted.
Banner.w and banner.h is considered as primary width and height.

Object: Video

AttributeTypeDescription
protocolintegerNOTE: Deprecated in favor of protocols. 
Supported video protocol. At least one supported protocol must be specified in either the protocol or protocols attribute.
protocolsinteger arrayArray of supported video protocols. At least one supported protocol must be specified in either the protocol or protocols attribute

Agent Types

Type IDNameDescription
1WebAn Id intended which is tied to a specific browser or device (cookie-based, probabilistic, or other.
2IDFAApple IDFA
3AAIDAndroid Ad ID
4Windows Advertising IDWindows mobile advertising ID
5Other mobile IDAnother mobile advertising identifier, such as SHA1 or MD5 version, or other legacy native mobile identifier.
500+Exchange-specific

Object: Source

The Source object is added in the BidRequest Object. This object describes the nature and behavior of the entity that is the source of the bid request
upstream from the exchange. The primary purpose of this object is to define post-auction or upstream decisioning when the exchange itself does not control the final decision. For more information, refer to IAB OpenRTB 2.5 documentation.

AttributeTypeDescription
pchainStringPayment ID chain string containing embedded syntax described in the TAG Payment ID Protocol v1.0.


 

⇧ Top