Web VAST ad tag setup

Last updated on June 14, 2018

Video in the OpenX Ad Exchange is in Beta release only. For more information, please contact your OpenX account manager.

The following instructions are for publishers who would like to configure a Video Ad Serving Template (VAST) ad tagA small piece of code that defines the ad space where ads display on a website. It includes parameters that describe the inventory advertising campaigns can target, which may in turn display ads in the ad space. for either desktop webRefers to the use of the Internet via a desktop computer web browser, specifically to differentiate from mobile web or mobile app. or mobile webRefers to the use of the Internet via a mobile device web browser, specifically to differentiate from mobile app..

Sample base VAST ad tag

In order to complete the setup of a video ad unitThe smallest inventory component that represents the space on a site where ads display. and start serving video ads, you must configure the base VAST ad tagSynonymous with VAST URL. An HTTP-based URL that enables communication between video players and ad servers. Publishers configure these tags in order to serve video ads on their sites. generated when you create a linear video ad unit.

The screenshot below shows the base tag that results from creating a linear videoAn ad or ad unit that displays in sequence with video content in a video player. Sequencing may be pre-roll, mid-roll, or post-roll. Can be accompanied by a companion ad. An example is a video ad that plays before a video starts, though static images may also serve. ad unit, where the blurred section is a placeholder for your instance name.

VAST ad tag

Simple web video integration

If you only need a simple integration (without dynamic parameters, run-of-network, or run-of-siteAn OpenX component that represents top-level domains or subdomains and is used to organize ad units. Sites enable you to target and report on inventory performance.) you need only append the URL of the page with your video player. The use case for this simple setup is a website with a video player on a single page. In other setup use cases, you will need to append macrosFor OpenX, a command enclosed in curly braces {} that dynamically inserts attributes into your HTML or third-party ad creatives and click-through URLs when OpenX serves an ad. Other macros, like from your video player, may have alternate formatting.. Please see the Append macros section below for more information.

Sample simple VAST ad tag with a placeholder URL for the video player's static page

The sample VAST ad tag below is color-coded:

  • Black: Base tag
  • Red: URL parameter
  • Blue: A placeholder page URL with full HTTP path

Append parameters and macros

After receiving the base tag with ad unit ID, you should append parameters and macros. Appending the required and highly recommended parameters adds an additional level of detail to your tag.

Appending macros allows you to pass information dynamically, ensuring that it is as accurate as possible. You can find the relevant macros in your ad serverA complete digital advertising platform where publishers sell, manage, and deliver their advertising inventory across all digital formats. or video player's documentation, depending on where you plan to traffic your VAST ad tag.

Sample VAST ad tag - Fully configured with placeholders for macros

In the example below, you could pass in the parameters for URL, video player height, and video player width to dynamically override the values you entered in the OpenX UI as needed.

The sample VAST ad tag below is color-coded:

  • Black: Base tag
  • Red: Parameters which must be configured exactly to our specifications (see Parameters below)
  • Blue: A placeholder for the relevant macro
http://your-instance.openx.net/v/1.0/av?auid=123456789&url=INSERT MACRO&vht=INSERT MACRO&vwd=INSERT MACRO

Parameters for web video requests

You are likely to encounter the following parameters. For more information on these and other parameters, see Ad request parameters.

  • url
  • cb
  • ip
  • vht
  • vwd
  • gdpr
  • gdpr_consent

If you need to express your traffic in real time in a detailed way, you can augment your ad tag with our OpenRTB object query string argument. For more information, see OpenRTB supply-side ad request parameter values.

Incorporate your tag

Add the fully configured VAST ad tag to your ad server or video player. Please contact your OpenX Account Manager once you've completed this step.

Next steps

Now that you have configured your VAST ad tag, you need to set up OpenX selling rules.

If you're interested in learning more about video, please refer to Video setup best practices for publishers.

See also

This topic applies to Ad Exchange.