Request parameters
For convenience and ease of working with parameter values, the case of letters is not taken into account.
Category | Parameter (in VAST tag URL) | Value placeholder (in the VAST tag URL) | Required? | Description | Value example |
|---|---|---|---|---|---|
general | partner_id / account_id | - | Required | TVP partner ID | AA00 |
general | placement_id | - | Required | TVP placement ID | AA00AA000000 |
general | v | - | - | TVP tag response type | 2,3,5,6 https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf p.47 |
general | cb | - | - | Random number to prevent caching | 12345678 |
general | width | [width] | - | Player/Ad Width in pixels | 1920 |
general | height | [height] | - | Player/Ad Height in pixels | 1080 |
general | placement_type | [placement_type] | - | Placement type | pre_roll / preroll mid_roll / midroll post_roll / postroll on_pause / onpause |
general | minbitrate | - | - | Minimum bit rate in Kbps. | 1-50000 |
general | maxbitrate | - | - | Maximum bit rate in Kbps. | 1-50000 |
general | mimes | - | - | Content MIME types supported. | video/x-flv |
general | skip | [skip] | - | Indicates if the player will allow the video to be skipped | 0,1 |
general | tmax | - | - | Maximum time in milliseconds the exchange allows for bids to | 100-5000 |
general | inventorypartnerdomain | [inventorypartnerdomain] | - | Pointer to the domain of the partner (of the site/app owner) with ownership of some portion of ad inventory on the site/app. The partner’s ads.txt or appads.txt file will be hosted here. When a site or an app contains ad inventory that is owned by another partner - the app or site should list all domains for those partners via this directive. | |
Device and user information | useragent | [useragent] | Required for server side requests | The full user agent string | Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/36.0.1985.125 Safari/537.36 |
Device and user information | ip | [ip] | Required for server side requests | The IP address of the user device | 52.52.52.52 |
Device and user information | deviceid | [deviceid] | - | User device identifier used for all device types | 437825ef-a4a6-4575-8b70-81630c6d76e5 |
Device and user information | os | [os] | - | The operating system platform of the device | Linux |
Device and user information | os_version | [osversion] | - | The operating system version (major.minor) | 7.0 |
Device and user information | devicemake | [devicemake] | - | Manufacturer of device | Samsung, Apple |
Device and user information | devicemodel | [devicemodel] | - | Model of device | Galaxy, F8332 |
Device and user information | ifa_type | [ifa_type] | - | Source of the IFA (device id) | rida |
Device and user information | connection_type | [connectiontype] | - | Integer value representing type of connection (wifi, 3G, 4G, etc) | 1 |
Device and user information | lang | [lang] | - | Device/Content language | en |
Device and user information | gender | [gender] | - | User gender | M,F,O |
Device and user information | yob | [yob] | Year of birth as a 4-digit integer. | 1995 | |
Content | content_id | [content_id] | - | Identifier for video content | 102368 |
Content | content_dur | [content_dur] | - | Duration of video content (seconds) | 60 |
Content | content_title | [content_title] | - | Title of video content | A%20New%20Hope |
Content | content_url | [content_url] | - | URL of video content | |
Content | content_cat | [content_cat] | - | Category of video content (IAB category ID or else) | IAB1-1 |
Content | content_album | [content_album] | - | Album to which the content belongs; typically for audio. | Americana |
Content | content_artist | [content_artist] | - | Artist credited with the content | Moby, Tim Burton |
Content | content_episode | [content_episode] | - | Episode number | 23 |
Content | content_genre | [content_genre] | - | Genre that best describes the content (e.g., rock, pop, etc). | DCR_CP; DRC_Concert%20Music G_Health IAB_324; IAB_College%20Sports |
Content | content_prodq | [content_prodq] | - | Production quality. | 0,1,2,3 |
Content | content_season | [content_season] | - | Content season | 3 |
Content | content_series | [content_series] | - | Content series. | 5 |
Content | contentrating | [contentrating] | - | Content rating. | G |
Site | domain | [domain] | - | Domain of website | |
Application | app_name | [appname] | - | Application name | photoeditor |
Application | app_store_id | [app_store_id] | Required for app (dynamic) | Application store ID | 591560124, com.pic.photoeditor |
Application | app_storeurl | [storeurl] | - | Application store URL | https://play.google.com/store/apps/details?id=com.pic.photoeditor&hl=en_US |
Application | bundle_id | [bundle_id] | - | Application BundleID or AppstoreID | 121212 |
Application | app_domain | [app_domain] | - | Domain of the app (e.g., “mygame.foo.com”). | |
Application | app_ver | [app_ver] | - | Application version | 7.6.3 |
Application | app_cat | [app_cat] | - | Application category | IAB1-1 |
Podding and restrictions | ad_max_dur | [ad_max_dur] | - | Maximum ad duration (seconds) | Integer |
Podding and restrictions | ad_min_dur | [ad_min_dur] | - | Minimum ad duration (seconds) | Integer |
Podding and restrictions | pod | - | - | Allow ad podding flag | 1 (true) or 0 (false) |
Podding and restrictions | pod_maxdur | - | - | Maximum pod duration (seconds) | Integer |
Podding and restrictions | pod_maxads | - | - | Maximum number of ads in adpod | Integer |
SSAI | ssai | - | Required for SSAI requests | Required for server side ad insertion integrations only where 1 indicates SSAI is being used. | 1 |
SSAI | ssai_partner | - | Required for SSAI requests | Name of the vendor being used for integration. | |
Livestream | livestream | [livestream] | - | Indicates whether or not the video is live. | 1 (true) or 0 (false) |
Privacy | lmt | [lmt] | - | Limit ad tracking flag | 1 (true) or 0 (false) |
Privacy | coppa | [coppa] | - | A flag indicating traffic that is subject to the Children's Online Privacy Protection Act of the United States. | 1 (true) or 0 (false) |
Privacy | us_privacy | [us_privacy] | - | (CCPA) A mandatory string for all publishers in which they must pass the privacy consent for users from California | 1---, 1YNN, 1NYN |
Privacy | gdpr | [gdpr] | - | A flag for European Union traffic consenting to advertising | 1 (true, consenting) or 0 (false, non-consenting) |
Privacy | gdprc | [gdprc] | - | A consent string passed from various Consent Management Platforms (CMP's) | TBD |
SCO | schain | [schain] | - | Supply chain object string | 1.0,1!exchange1.com,1234,1,,,!exchange2.com,abcd,1,,, |
SDK | ad_break_id | - | - | ||
SDK | app_key | - | Required for SDK | ||
SDK | app_id | - | Required for SDK | ||
Custom | c1-с10 | [c1]-[с10] | - | Custom values 1 - 10. 1-3 can be used in reporting. 4-10 - only passthrough | aaaaaaaa |