Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

AttributeTypeDescriptionScope
idStringUnique ID of the bid request, provided by the exchange.Required
imp Object ArrayArray of impression objects representing the impressions offered. At least 1 impression object is required.Required
site Object

Details via a site object about the publisher's website.

Warning
A request containing both site and app object in BidRequest Object will not be considered. Only site OR app should be present in the request; not both in the same request.


Optional
device Object

Details via a device object about the user's device to which the impression will be delivered.

Required
user Object

Details via a user object about the human user of the device; the advertising audience.

Optional
app Object

Details via an App object about the publisher's app (that is, non-browser applications). Only applicable and recommended for apps.

Warning
A request containing both site and app object in BidRequest Object will not be considered. Only site OR app should be present in the request; not both in the same request.


Optional
atInteger

Auction Type

1 = Publisher first price auction

2 = (Default) Publisher second price auction

Optional
bcatString Array

Blocked advertiser categories using the IAB content categories.

The limit of IAB categories the system can support is 20 categories.

Optional
badvString Array

Block list of advertisers by their domains; for example, "ford.com".

The limit of URLs the system can support is 40 URLs.

Optional
regs ObjectA Regs object that specifies any industry, legal, or governmental regulations in force for this request.Optional
source
ObjectA Source object that provides data about the inventory source and which entity makes the final decision.Optional
testInteger

Indicator of test mode, in which auctions are not billable.

0=live mode (Default)

1=test mode

Optional
ext ObjectPlaceholder for exchange-specific extensions to OpenRTB.Optional
ext.rewardInteger

Only supported values is 1, which indicates the video is non-skippable-reward-video.

When the value = rewarded, these parameters are ignored in requests:

    •  video.skip
    • video.skipmin
    • video.skipafter

Multi-format requests are supported for video object/request, and will be ignored for banner object/request.

Optional
ext.is_rewarded_inventoryBoolean

Only supported value is true, which indicates the video is non-skippable-reward-video.

When the value = rewarded, these parameters are ignored in requests:

    •  video.skip
    • video.skipmin
    • video.skipafter

Multi-format requests are supported for video object/request, and will be ignored for banner object/request.

Optional



Expand
titleExpand to view bidrequest.imp attributes


Info
Each impression object can contain one object from each video/native/banner object, but PubMatic considers only a maximum of 2.    


AttributeTypeDescriptionScope
idStringA unique identifier for this impression within the context of the bid request (typically, starts with 1 and increments).Required
tagidString

Identifier for specific ad placement or ad tag that was used to initiate the auction.

Info
  • You can also use as PubMatic ad placement id or ad id. You must maintain the mapping of your publisher ad id to the PubMatic ad id.
  • You must send PubMatic ad id here.
  • You can also use as a slotname for wrapper/prebid. PubMatic maintains mapping to derive the PubMatic ad id from the slotname.


Optional
banner ObjectA banner object is required if this impression is offered as a banner ad opportunity. Optional
native ObjectA Native object; required if this impression is offered as a native ad opportunityOptional
video ObjectA Video object required if this impression is offered as a video ad opportunity.Optional
instlInteger1 = the ad is interstitial or full screen, 0 = not interstitial.Optional
bidfloorFloatMinimum bid for this impression expressed in CPM.Recommended
bidfloorcur StringCurrency specified using ISO-4217 alpha codes.Recommended

iframebuster

String ArrayArray of exchange-specific names of supported iframe busters.Optional
secureIntegerFlag to indicate if the impression requires secure HTTPS URL creative assets and markup, where 0 = non-secure, 1 = secure. If omitted, the secure state is unknown, but non-secure HTTP support can be assumed.Recommended
pmp ObjectA PMP Object containing any private marketplace deals in effect for this impression.Optional
metric Object arrayAn array of the Metric object.Optional
ext ObjectPlaceholder for exchange-specific extensions to OpenRTBOptional



Banner

...

Expand
titleExpand to view bidrequest.imp.banner attributes


AttributeTypeDescriptionScope
wIntegerWidth of the impression in pixels.Required
hIntegerHeight of the impression in pixels.Required
battrInteger ArrayBlocked creative attributes.Optional
posIntegerAd position on screen.Optional
topframeIntegerIndicates if the banner is in the top frame as opposed to an iframe, where 0 = no, 1 = yes.Optional
expdirInteger ArrayDirections in which the banner may expand.Optional
formatObject Array

Array of format objects representing permitted banner sizes. Banner.w and banner.h are considered as primary width and height.

Limitation: 4 objects max.

Recommended
apiInteger Array

List of supported API frameworks for the impression. If an API si not explicitly listed, it is assumed not to be supported.

Info

In OpenRTB 2.1-2.5, the api attribute is now also used in support of the Open Measurement SDK.

Add 7 to the array of supported API frameworks if you use Open Measurement.

See List 5.6 API Frameworks in the IAB OpenRTB Advisory for Open Measurement SDK to learn more.


Recommended


Format
Expand
titleExpand to view bidrequest.imp attributes


Expand
titleExpand to view bidrequest.imp.banner attributes


Expand
titleExpand to view bidrequest.imp.banner.format attributes


AttributeTypeDescriptionScope
wIntegerWidth in device independent pixels (DIPS).Required
hIntegerHeight in device independent pixels (DIPS).Required


Code Block
languagexml
titleBidRequest.imp.banner.format sample JSON
linenumberstrue
collapsetrue
{
	"id": "6503ED1F-B749-4215-9721-0EA5A7054F2F",
	"at": 1,
	"imp": [{
		"id": "1",
		"tagid": "904294",
		"bidfloor": 0.300000,
		"secure": 1,
		"banner": {
			"w": 300,
			"h": 250,
			"format": [{
				"w": 300,
				"h": 250
			}],
			"topframe": 1,
			"battr": [1, 3, 6, 7, 8, 9, 11],
			"btype": [1, 2]
		},
		"ext": {
			"headerbidding": {
				"present": 1
			}
		}
	}],
	"site": {
		"id": "173321",
		"cat": ["IAB10", "IAB10-4", "IAB9-30", "IAB25", "IAB1", "IAB9-20", "IAB25-2", "IAB19", "IAB1-6", "IAB9"],
		"page": "https://sonidossumergidosblog.wordpress.com/tag/post-punk/",
		"domain": "sonidossumergidosblog.wordpress.com",
		"mobile": 1,
		"publisher": {
			"id": "156078"
		}
	},
	"device": {
		"ip": "200.106.117.237",
		"lmt": 0,
		"ua": "Mozilla/5.0 (Linux; Android 9; moto g(7) power) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/77.0.3865.92 Mobile Safari/537.36",
		"carrier": "Telefonica del Peru",
		"make": "Motorola",
		"os": "Android",
		"osv": "2.0",
		"js": 1,
		"geo": {
			"country": "PER",
			"region": "lma",
			"city": "lima",
			"metro": "-1",
			"zip": "15000"
		},
		"geofetch": 0,
		"ext": {
			"xff": "10.100.129.33",
			"res": "-1x-1",
			"freq": 0,
			"pf": 2
		}
	},
	"user": {
		"id": "DB389E6A-8559-46FB-A0AD-999D51B017CB",
		"buyeruid": "1oKWGtqMrMmZx1A9VcdW",
		"geo": {
			"country": "per"
		},
		"eids": [{
			"source": "adserver.org",
			"uids": [{
				"id": "8bb26040-d46c-4a47-ab6e-df1e94215ae4",
				"ext": {
					"rtiPartner": "TDID"
				}
			}]
		}],
		"ext": {
			"eids": [{
				"source": "adserver.org",
				"uids": [{
					"id": "8bb26040-d46c-4a47-ab6e-df1e94215ae4",
					"ext": {
						"rtiPartner": "TDID"
					}
				}]
			}]
		}
	},
	"bcat": ["IAB5-2", "IAB25-3", "IAB25-2", "IAB26", "IAB25-5", "IAB25-4", "IAB9-9"],
	"source": {
		"fd": 1,
		"pchain": "5d62403b186f2ace:156078",
		"ext": {
			"schain": {
				"complete": 0,
				"ver": "1.0",
				"nodes": [{
					"asi": "pubmatic.com",
					"sid": "156078",
					"rid": "6503ED1F-B749-4215-9721-0EA5A7054F2F",
					"hp": 1
				}]
			}
		}
	}
}




...