You are here: Publishers > Inventory > Ad tags > Mobile app VAST Ad Tag setup

Mobile app VAST Ad Tag setup

Last updated on February 16, 2017

Video in Exchange is in Beta release only. Please contact your Account Manager to have this feature enabled.

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 mobile appSynonymous with mobile. Refers to the use of an app via a mobile device, specifically to differentiate from mobile web. video ad units.

In order to complete the setup of a video ad unitIn OpenX, the 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 instanceThe platform on which the publisher's or buyer's product is hosted. name. This base tag includes the ad unit id (auid) and dr=true (no redirect for cookiesSmall text files sent from a web server to a browser, then returned by the browser each time it logs on to that server. Advertisers use cookies to monitor the number of ads that have been shown to a visitor, while they are used by websites to gauge numbers of unique visitors.) already appended.

Append macros

Because you configured your mobile app siteAn OpenX component that represents top-level domains or sub-domains and is used to organize ad units. Sites enable you to target and report on inventory performance. and linear video ad unit in the OpenX UI, all of the required fields are automatically populated. However, after receiving the base tag with ad unit ID, you can also 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..

Appending macros allows you to pass in 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 Android VAST Ad Tag - Fully configured with placeholders for macros

In the example below, you could pass in parameters for settings you chose in the UI to dynamically override them as needed, such as URL, video player height, and video player width.

Note: For an iOS tag, you would replace the Android parameters of did.adid and did.adid.enabled with the iOS parameters of did.ia and did.iat.

The sample VAST Ad Tag below includes all required and highly recommended parameters. It is color-coded as follows:

  • Black: Base tag
  • Red: Parameters which must be configured exactly to our specifications (see tables below)
  • Blue: A placeholder for the relevant macro MACRO&did.adid=INSERT MACRO&did.adid.enabled=INSERT MACRO&vht=INSERT MACRO&vwd=INSERT MACRO&lat=INSERT MACRO&lon=INSERT MACRO&ip=INSERT MACRO&net=INSERT MACRO

Sample Android VAST Ad Tag - Fully configured with macro-substituted values

Once your macros dynamically populate the placeholders, the VAST Ad Tag should display as follows, following the same color-coding as above:

Parameters for mobile app video requests

For information on these and additional parameters, including descriptions and example values, see Mobile ad request parameters.

Required parameters

You must append these parameters for mobile app video requests.

Parameter Description

(Android only) Indicates the Google Advertising ID for the Android OS on the user's device.

For example: did.adid=1be50157-d948-4c62-8814-06b71ac09c3c


(Android only) Indicates the end-user has ad tracking either enabled or limited, based on the following:

  • true/1 (Enabled)
  • false/0 (Limited)

For example: did.adid.enabled=true

Note: If an end-user opts out of interest-based advertising by selecting "limit ad tracking" on their device, the correct value to send OpenX is false/0.


(iOS only) Indicates the Apple IDFA identifier for advertising for Apple iOS6 (or higher) on the end-user's mobile device.

For example: did.ia=43043FE3-6BA9-4515-8209-6E0AC6AE1ADF


(iOS only) The IFA tracking parameter on the end user's device. Indicates the end-user has ad tracking either enabled or limited, based on the following:

  • true/1 (Enabled)
  • false/0 (Limited)

For example: did.iat=true

Note: If an end-user opts out of interest-based advertising by selecting "limit ad tracking" on their device, the correct value to send OpenX is false/0.


Indicates the GPS latitude location, in decimal form, of the end-user.

For example: lat=37.530676


Indicates the GPS longitude location, in decimal form, of the end-user.

For example: lon=-122.262447


Indicates the source of the end-user's location data, which can be one of the following:

  • 1 (GPS/Location Services)
  • 2 (IP Address)
  • 3 (User Provided, e.g. a zip code on a website's registration form)

For example: lt=1

Important: For 1 to be available for a mobile app, two criteria must be met. The publisherIn OpenX, an account type that represents a business with ad space to sell. must enable sending location and source in the app, and the end-user must agree to allow location sharing with prompted by the app.


Indicates the mobile app store URL.

The URL for mobile apps should not use an HTTPS URL; instead, use a corresponding HTTP URL.

For iOS, it is the App Store URL. For example: url=

For Android, it is the Google Play URL. For example: url=

Highly recommended parameters

These parameters are highly recommended to increase the accuracy of each ad requestCommunication between a web browser or application and an ad server to display an ad. dynamically.

Parameter Description


Client IP address

For example:


Indicates the end-user's network connection type. For a wireless network, use net=wifi.


Video height. Indicates the expected height dimension of the video ad, in pixels.

Use this as an override for the ad unit setting.

For example: 320


Video width. Indicates the expected width dimension for a video ad, in pixels.

Use this as an override for the ad unit setting.

For example: 480

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.

Add the complete 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.

This topic applies to Ad Exchange.

Feedback form