Share via

Required tag parameters for CTV inventory

  • Article

You can use a single combined tag for CTV, or create separate tags for each device type. When identifying the device, using ifa and ifa_type is recommended: if you can't use these parameters, you can use openudid.

Note

You will need need additional parameters such as width and height to monetize your inventory, unless these values have been set on the placement.

The following examples show how to implement a server-side tag with ifa/ifa_type or , if ifa and ifa_type can't be used, with openudid.

https://secure.adnxs.com/ssptv?id=<PLACEMENT_ID>&appid=<INSERT_MACRO>&ifa=<INSERT_MACRO>&ifa_type=<INSERT_MACRO>

https://secure.adnxs.com/ssptv?id=<PLACEMENT_ID>&appid=<INSERT_MACRO>&openudid=<INSERT_MACRO>
Parameter Type Required? Compatible Handlers Description
appid (CTV) string Yes ptv, ssptv, vmap, ssvmap This string is used to identify an app running on a ConnectedTV device such as Apple TV, Fire TV, Android TV, or Roku.
- On Android, this is the app's package name. It's formatted as follows: com.example.helloworld.
- On iOS, this is the app's numeric iOS store ID, auto-generated by the App Store. It's formatted as follows: 123456789.
Many buyers set campaign targeting and reporting based on appid. Failing to supply a correct appid will make your inventory unattractive to these buyers. Therefore, passing this field is strongly recommended when supply_type is set to mobile_app.
To find the app ID for a particular Android or IOS app, find the app's detail page, which you can find using a web search. The URL of the app store's detail page will show the app's ID.
For example, here are the detail pages for the "Fussball" app:
- Google Play: https://play.google.com/store/apps/details?id=de.telekom.FUSSBALL.DE
- iTunes: https://itunes.apple.com/de/app/fussball.de/id422052549
channel_name string Recommended to monetize inventory. ptv, ssptv The name of channel the content is airing on.
content_cat string array Recommended to monetize inventory. ptv, ssptv, vmap, ssvmap Array of IAB content categories that describe the content producer. Refer to list 5.1.
content_context int Recommended to monetize inventory. ptv, ssptv, vmap, ssvmap Type of content (game, video, text, etc.).
content_contentrating string Recommended to monetize inventory. ptv, ssptv, vmap, ssvmap The content rating (For example: PG-13).
content_episode int Recommended to monetize inventory. ptv, ssptv, vmap, ssvmap Episode number.
content_genre string Recommended to monetize inventory. ptv, ssptv, vmap, ssvmap The genre that best describes the content.
content_len int Recommended to monetize inventory. ptv, ssptv, vmap, ssvmap The content duration in seconds.
content_livestream int Recommended to monetize inventory. ptv, ssptv, vmap, ssvmap Whether the content is live or video on demand (VOD). 0: VOD, 1: Live.
content_network string Recommended to monetize inventory. ptv, ssptv, vmap, ssvmap The top-level parent company or, where relevant, a sub-brand which owns multiple TV-like channels, d2c content brands, or digital properties on which the content is being viewed.
content_prodq int Recommended to monetize inventory. ptv, ssptv, vmap, ssvmap Production quality.
content_season string Recommended to monetize inventory. ptv, ssptv, vmap, ssvmap Content season (Example: “Season 3”). This field is important for monetizing CTV (Connected TV) inventory.
content_series string Recommended to monetize inventory. ptv, ssptv, vmap, ssvmap 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).
content_title string Recommended to monetize inventory. ptv, ssptv, vmap, ssvmap 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).
id string Yes ptv, ssptv, vmap, ssvmap The unique ID of the placement where the ad will serve. If you'd rather not pass the raw placement ID, you can pass in a combination of member and inv_code parameters. For more information, see "Target Video Attributes via Query Parameters."
ifa string Required to monetize inventory. ptv, ssptv, vmap, ssvmap The unique device identifier using the UUID standard (8-4-4-4-12)
ifa_type string Required to monetize inventory. ptv, ssptv, vmap, ssvmap Possible values are aaid (Android), idfa (AppleTV), afai (Amazon Fire), msai (Microsoft), rida (Roku), ppid, tifa (Tizen (Samsung)), vida (Vizio), lgudid (LG).
Note: If you can't dynamically pass in device or platform IDs, you should use:
- ifa_type=openudid for CTV ad requests if you have authentication data and can pass persistent IDs
- &ifa_type=sessionid if you don't have authentication data with persistent IDs
ip string Required to monetize inventory. ptv, ssptv, vmap, ssvmap IP address of the device making the ad request, e.g., 207.237.150.246.
- If no ip is specified for /ptv and /ssptv calls, the system will use the IP passed via the "X-Forwarded-For" HTTP header for geo detection.
mimes* string Recommended to monetize inventory. ptv, ssptv, vmap, ssvmap Video mimes accepted, expressed as a comma-separated list of IDs. You can find the IDs in the Placement Service documentation under "Supported Mime Types."
minbitrate* int Recommended to monetize inventory. ptv, ssptv, vmap, ssvmap The minimum bitrate accepted.
ua string Required to monetize inventory. ptv, ssptv, vmap, ssvmap The user agent string associated with the device requesting an ad. If specified, this value will be used rather than the standard user agent sent via HTTP header. This should be URL encoded. The user agent identifies information such as the device’s operating system as well as the device’s make and model, along with the information about the application, and the software vendor acting on behalf of the user. Many buyers target their audiences based on these parameters and not including them will restrict demand.
vcontext int Required to monetize inventory. ptv, ssptv Position of the video placement. Possible Values:
- 1 - Linear Pre-roll
- 2 - Linear Mid-roll
- 3 - Linear Post-roll
- 4 - Outstream
vframeworks int Required to monetize inventory ptv, ssptv, vmap, ssvmap Frameworks supported by the player. Possible values:
- 1 - VPAID 1.0
- 2 - VPAID 2.0
- 3 - MRAID-1
- 4 - MRAID-2
- 5 - ORMMA
- 6 - OMID-1
Note: vframeworks supports single as well as a list of comma-separated integer values. For example,
vframeworks=1,2,3
or
vframeworks=1.
vheight int Required to monetize inventory. ptv, ssptv, vmap, ssvmap Player height (in pixels). While not required, this parameter is recommended in order to ensure video bidders receive both width and height on bid requests.
vmax_slot_duration int Required to monetize CTV inventory on requests with multiple slots in a pod. ptv, ssptv, vmap, ssvmap Maximum video duration per slot in an ad pod in seconds. Any creative with a duration longer than this value will be excluded from the pod.

Note: This value only overrides the slot maximum duration defined on the placement video settings if the placement and request (i.e. vmaxduration) does not have a pod maximum duration value specified.

vmaxduration int Required to monetize inventory. ptv, ssptv, vmap, ssvmap For single requests, this is the maximum video placement duration in seconds. Any creative with a duration longer than this value will be excluded from the auction. For podded inventory, this is the length of the full pod.
vmin_ad_duration* int Required to monetize inventory. ptv, ssptv, vmap, ssvmap The minimum ad duration, in seconds.
vv int Required to monetize inventory. ptv, ssptv, vmap, ssvmap The VAST version supported by the player:
- 2 - VAST 2.0
- 3 - VAST 3.0
- 4 - VAST 4.0
- 5 - VAST 4.1
- 6 - VAST 4.2.
vwidth int Required to monetize inventory. ptv, ssptv, vmap, ssvmap Player width (in pixels). While not required, this parameter is recommended in order to ensure video bidders receive both width and height on bid requests.