Versions Compared

Key

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

...

In-app OTT parameters

Name

oRTB parameter

Parameter Type

Notes

pubId (Required)



integer

Your PubMatic account at Publisher ID, for example:

pubId=12345

profId (Required)
integer

OpenWrap profile ID, for example:

profId=1000

f


string

Format of response to return, for example:

f=json

Info

Pass this parameter to specify response format.

If value of this parameter is JSON, the response returns JSON data containing only the targeting field.

Values other than JSON, get a response containing a redirect url unless debug is true.

pwtm_iu (Required)


string

Inventory ad unit as a URL encoded string, for example:

pwtm_iu=%2F40619304%2FOW_Video

This is the ad unit value OpenWrap uses for mapping to demand partner parameters.

pwtm_sz (Required)


string

Video player size in the format, WxH (Width x Height); for example:

pwtm_sz=640x480

Info

Only one size is allowed.


pwtm_url (Required)


string

Encoded page URL, for example:

pwtm_url=https%3A%2F%2Fwww.pubmatic.com.com%2F

Info

Applicable only to Desktop, Web, and Mobile Web setup.


pwtbidrprm


URL encoded JSON string

Bidder specific key-value for Xandr and PubMatic.

  • Targeting support under PubMatic SSP today requires the dctr and pmzoneid parameters (PMP targeting does not currently support the keywords param).

pmzoneid: Comma separated zone id. Used in deal targeting and site section targeting. For example, drama,sport

dctr: Deals custom targeting pipe-separated key-value pairs. For example, title=The Hunt|genre=animation,adventure

  • Use the keywords parameter when passing the same information to downstream DSPs like Xandr .
  • Use bidder codes for sending the keywords. For instance if appnexus is created with bidder code app-alias, use app-alias for sending keywords.

Example unencoded/encoded JSON with key-values:

Tabs group
borderall-sides


Unencoded JSON PayloadjsBidder JSONtruejava


URL Encoded JSON Payload


xmlBidder JSON (Contains <CR>s for readability.)




pwtvapi

API

integer array

Use 7 to indicate OMID-1 (Open Measurement Support); for example:

pwtvapi=7

Use 2,7 for viewability in desktop setup. For example:

pwtvapi=2,7

pwtbatr

BAttr

integer array

Blocked creative attributes. For example:

pwtbatr=1,2

See oRTB 2.5 Spec, section 5.3 Creative Attributes , for the full list of values.

pwtbox

BoxingAllowed

boolean

Indicates whether to allow letter-boxing of 4:3 content into a 16:9 window; 0 = no, 1 = yes. For example:

pwtbox=1

pwtdvry

Delivery

integer array

Supported delivery methods (for example, streaming, progressive). If pwtdvry is left blank, PubMatic assumes all types are supported.

pwtdvry=1,2

See oRTB 2.5 Spec, section 5.15 Content Delivery Methods, for the full list values.

pwtmnbr

MinBitrate

integer

Minimum bit rate in Kbps. For example:

pwtmnbr=300

pwtmxbr

MaxBitrate

integer

Maximum bit rate in Kbps. For example:

pwtmxbr=1000

pwtmxex

MaxExtended

integer

Maximum extended ad duration if extension is allowed. Use the following values to determine extension permission:

  • 0 (or blank) = extension is not allowed.
  • -1 = extension allowed, with no imposed time limit.
  • >0 = number of seconds of extended play supported beyond the maxduration value.

For example:

pwtmxex=0

pwtmime

Mimes

integer array           

A comma-separated list of integer values representing HTML MIME types, for example:

pwtmime=1,2

The following table lists integer values that represent corresponding MIME types:

ID Value
0All
1video/mp4
2application/x-shockwave-flash
(VPAID - FLASH)
3video/wmv
4video/h264
5video/webm
6application/javascript
(VPAID - JS)
7video/ogg
8video/flv


pwtvplc

Placement

integer

Placement type for the impression. For example:

pwtvplc=1

See oRTB 2.5 Spec, section 5.9 Video Placement Types, for a full list of values.

pwtvpos

Pos

integer

Ad position on screen. For example:

pwtvpos=1

See oRTB 2.5 Spec, 5.4 Ad Position section, for the full list of values.

pwtprot

Protocol

integer

Deprecated. See pwtprots below.

pwtprots

Protocols

integer array

A comma-separated list of supported video protocols. For example:

pwtprots=1,2

See oRTB 2.5 Spec, 5.8 Protocols section, for the full list of values.

pwtseq

Sequence

integer

When a single bid request offers multiple ad impressions, the sequence number allows coordinated delivery of multiple creatives.

pwtseq=1

Defaults to 1 if parameter is not used.

pwtskp

Skip

boolean

Indicates whether the player allows the user to skip video; 0 = no, 1 = yes. For example, to allow users to skip the video:

pwtskp=1

pwtskmn

SkipMin

integer

When an ad is skippable (see pwtskp above), videos with a duration greater than this number of seconds allow users to skip, after the video plays longer than this value. For example, with the setting below, the video must play a minimum of 5 seconds before the user can skip:

pwtskmn=5

pwtskat

SkipAfter

integer

When an ad is skippable (see pwtskp above), this is the number of seconds a video must play before the user can skip. For example, the setting below limits skipping until after the video has played 10 seconds:

pwtskat=10

pwtvlin

Linearity integer

Indicates if the impression must be linear or nonlinear, where:

1 = Linear

2 = Non-linear

For example:

pwtvlin=1

pwtvmnd


Minduration integer

Minimum video ad duration in seconds. For example:

pwtvmnd=5

pwtvmxd

Maxdurationinteger

Maximum video ad duration in seconds. For example:

pwtvmnd=10

pwtplbk

PlaybackMethod integer array

Playback methods that may be in use. For example:

pwtplbk=1

See  OpenRTB Spec 2.5 >  Playback Method for the full list of values.

pwtdly

StartDelay integerIndicates the start delay in seconds for pre-roll, mid-roll, or post-roll ad placements. See  OpenRTB Spec 2.5 >  Start Delay for additional generic values.

User parameters

Name

oRTB parameter

Parameter type

Notes

pwtyob

User.yob

integer

User year of birth.

pwtgender

User.Gender

string

User gender.

Content parameters

Name

oRTB parameter

Parameter type

Notes

pwtgenre

Content.Genre

string

Content genre; for example, "science fiction."

pwttitle

Content.Title

string

Content title; for example, "Star Wars."

GDPR parameters

Name

oRTB parameter

Parameter type

Notes

pwtgdpr

regs.ext.gdpr

integer

Value indicating GDPR enabled or not

pwtcnst

user.ext.consent

string

Consent string

CCPA parameters

Name

oRTB parameter

Parameter type

Notes

pwtccpa

user.ext.us_privacy

string

CCPA string

Mobile parameters

Name
oRTB parameterParameter typeNotes

pwtapp

Appboolean

The following parameters apply only when the pwtapp parameter is set to 1 (true), which identifies the request as mobile. For example, pwtapp=1

Code Block
languagexml
titleSample mobile request
http://ow.pubmatic.com/openrtb/2.5/video/?v=1&pubId=5890&iuId=Div1&profId=4415&
pwtvmxd=100&pwtvmnd=25&pwtmime=1&pwtplbk=1,2&pwtdly=-1&pwtm_description_url=
www.abc.com&pwtm_sz=640x480&pwtbatr=1,26

See oRTB 2.5 Spec, 3.2.14 Object: App section, for more details .

pwtappkwapp.keywordsstring

Comma separated list of keywords about the app. For example, keyword-a,keyword-b,keyword-c

pwtappid

App.Id

string

App ID registered with PubMatic.

pwtappname

App.Name

string

App name, typically as it appears on the platform app store (may be aliased at the publisher’s request).

pwtappbdl

App.Bundle

string

A platform-specific unique identifier for the app and independent of the PubMatic or any exchange. For Android, this should be a bundle or package name (for example, com.foo.mygame). On iOS, it is typically a numeric ID.

pwtappdom

App.Domain

string

Domain for the app. For example, mygame.foo.com

pwtappurl

App.StoreURL

string

App store URL for an installed app (IQG 2.1 compliant).

pwtappcat

App.Cat

string array

Comma-separated list of IAB content categories for the app. See oRTB 2.5 Spec, 5.1 Content Categories section, for the IAB category list .

pwtapppd

App.Paid

boolean

1 = app is a paid version or 0 = app is free.

pwtlmt

Device.Lmt

boolean

User chosen “Limit Ad Tracking” preference:

  • 0 (false) = tracking is unrestricted.
  • 1 (true) = tracking must be limited per platform guidelines.

pwtdnt

Device.Dnt

boolean

Standard “Do Not Track” flag set in the header by the browser:

  • 0 = tracking is unrestricted.
  • 1 = do not track.

pwtjs

Device.JS

integer

Support for JavaScript:

  • 0 = no.
  • 1 = yes.

pwtifa

Device.Ifa

string

ID sanctioned for advertiser use in the clear; that is, not hashed.

pwtdidsha1

Device.DidSha1

string

Hardware device ID (that is, IMEI); hashed via SHA1.

pwtdidmd5

Device.DidMd5

string

Hardware device ID (that is, IMEI); hashed via MD5.

pwtdpidsha1

Device.DpidSha1

string

Platform device ID (that is, Android ID); hashed via SHA1.

pwtdpidmd5

Device.DpidMd5

string

Platform device ID (that is, Android ID); hashed via MD5.

pwtmacsha1

Device.MacSha1

string

MAC address of the device; hashed via SHA1.

pwtmacmd5

Device.MacMd5

string

MAC address of the device; hashed via MD5.

pwtlat

Device.Geo.Lat

float

Latitude from -90.0 to +90.0 (negative is south).

pwtlon

Device.Geo.Lon

float

Longitude from -180.0 to +180.0, (negative is west).

pwtgtype

Device.Geo.Type

integer

Source of location data; recommended when passing lat/lon. See oRTB 2.5 Spec, 5.20 Location Type section, for the list.

pwtcntr

Device.Geo.Country

string

Country code using ISO-3166-1-alpha-3; for example, USA = United States of America.

pwtcity

Device.Geo.City

string

City using United Nations Code for Trade and Transport Locations. See oRTB 2.5 Spec, Appendix A, for a link to the locations .

pwtmet

Device.Geo.Metro

string

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

pwtzip

Device.Geo.Zip

string

Zip or postal code.

pwtuto

Device.Geo.UtcOffset

integer

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

pwtuid

User.ID

string

Exchange-specific ID for the user. At least one of id or buyeruid is recommended.

...