Follow

VAST Tag Integration Guide (aerVideo Ad Unit)

Overview:

  • A VAST (Video Ad Serving Template) tag is a HTTP or HTTPS URL that points to a VAST XML feed. The VAST XML URL feed contains information about the video ad, including the video file, length, companion banner and more. (you can read more about VAST in the IAB spec here: http://www.iab.net/guidelines/508676/digitalvideo/vsuite/vast)

  • The video player uses the VAST XML URL feed to instruct it when and what video ad to play. Without it the video player would be unable to play a video advertisement. The VAST XML URL feed is in a standardized format that all video players can understand, so if the feed does not conform to this standard then the video player will be unable to understand and play it.

  

 

Integrating a VAST Tag


In order to consume a VAST XML URL feed, it can be entered directly into an ad server, which is called via a video player or in some cases the URL can be entered directly into the video player code. The VAST XML URL will not work outside of a video player so just entering the link directly on a webpage will not work.

Below is an example of how the VAST XML URL can be entered directly into the JW video player.

AerServ will provide you with a VAST XML URL which you will enter into your ad server or video player.  The process for integrating a VAST XML feed differs for each ad server and video player and is outside the scope of this guide, so refer to the documentation of your ad server and/or video player to determine how to integrate it.

 

 

 

 

Step 1: Create Your App/Site


For detailed instructions on how to set up your app or site in the AerServ platform, please click here.

 

Step 2: Create an aerVideo Ad Placement (PLC)


The VAST XML URL provided to each publisher contains a Placement (PLC) number that is unique to each publisher account and has ad campaigns assigned just for their sites.  A PLC is a unique ID that is used to retrieve ads for a particular site and placement created within the AerServ platform.  Your PLC can be found within the Inventory section of the AerServ platform. Please reach out to your Account Manager with any questions regarding your PLC or for a tutorial guide go here!

 

 

 

 

 

Step 3: Generate Your Tags


Once you get to Step 4 of the On-Boarding Wizard (SDK & Tags Page), you will be able to "Generate Your Tags."

      1. Click on Generate my Tag Link
      2. Copy your Live Tags
      3. To verify integration replace live tag PLC with 1000741

 

Macros

The VAST XML URL may contain macros that will need to be populated by the publisher prior to sending a request to AerServ. Macros are placeholders for data values that are dependent on the user of the page.  The population of macros are crucial to campaign targeting and can have a significant impact on fill rate.  Below are examples of macros that may be included in the VAST XML URL.

 

 

Step 4a: Mobile Web Tag


Macros should be added after each key in the query string. ie ("cb=$[cb]").  

      • Macro shown above (in green) is Aerserv specific, please use your 3rd party server macros
      • Description of each key and macro is below.

http://ads.aerserv.com/as/?plc=XXXXX&cb=&ip=&make=&model=&os=&osv=&type=&ua=&url=&coppa=&vpw=&vph=&vpaid=&age=&yob=&gender=

 

 

Step 4b: In-App


 

Macros should be added after each key in the query string. ie ("cb=$[cb]").  

      • Macro shown above (in green) is Aerserv specific, please use your 3rd party server macros
      • Description of each key is below.

http://ads.aerserv.com/as/?plc=XXXXX&cb=&appversion=&adid=&network=&carrier=&dnt=&ip=&make=&model=&os=&osv=&type=&lat=&long=&ua=&carrier=&vpw=&vph=&vpaid=&coppa=&age=&yob=&gender=

If you have trouble verifying your VAST XML URL please contact your Account Manager for assistance.

  

Parameter Overview

 
 DESCRIPTION  EX. REQUEST KEY EX. VALUE  MOBILE WEB  IN-APP   DATA TYPE
Age demographic information age age=22 Optional Optional Optional
Application Name appname Tien%Len%Online N/A Required String (encoded)
App Store URL siteurl

https://itunes.apple.com/us/

app/tienlenonlinefree/

id447031106?mt=8

N/A Required String (encoded)
App Bundle ID bundleid IOS: id447031106 Android: N/A

Required *

* Passing a BundleID is required. However, if you have set up your app in the AerServ platform using an Apple App Store URL or Google Play Store URL, AerServ can extract the BundleID from this field and you are not required to pass it in your ad request.

String (encoded)
Gender demographic information gender gender=male Optional Optional Optional
Page URL url www.aerserv.com Required NA String (encoded)
App domain appdomain ads.aerserv.com N/A Required String (encoded)
Application Version appversion 1.0 N/A Optional String
CacheBuster cb 123456789 Required Required Integer
Connection Type network wifi, carrier N/A Optional String
Coppa Flag coppa

is your app COPPA compliant?

1=yes, 0=no

Optional Optional Optional
Do Not Track dnt

1 for do not track,

0 for allow to track

N/A Required Boolean
Advertising ID -
Unhashed Apple IDFA or Google AdId
adid bbd606b1-32ab-4a1e-b2aa-5771ad804430 N/A

Required *

 * Provide either the Device ID or the Advertising ID.

String
Lat lat 33.58 N/A Optional Float
Long long 117.73 N/A Optional Float
Location Source locationsource

Values: 1 or 2 - Origination of Lat/Long values - 1 = GPS,

2 = Derived from IP

Optional Optional Integer
IP Address ip 123.456.78.9 Required Required String
Device Make make Apple Required Required String
Device Model model iPhone4 Required Required String
Operating System os iOS Required Required String
Operating System Version osv 7.1 Required Required String
Device Type type phone, tablet Required Optional String
User Agent ua

Mozilla%2F5.0%20(Linux%3B

%20Android%204.0.4%3B%

20Galaxy%20Nexus%20Build

%2FIMM76B)

Required Required String (encoded)
Cell Carrier carrier Verizon N/A Optional String
Year Of Birth demographic information yob yob=1985 Optional Optional Optional
Video Player Width vpw vpw=360 Optional Optional Integer
Video Player Height vph vph=480 Optional Optional Integer
VPAID Flag set this if you would like or dislike VPAID ads (1=allow, 0=do not allow) vpaid  vpaid=1 Optional Optional Integer

 

 

Headers:

If sending an IP through the ad request parameter (i.e. http://ads.aerserv.com/as/?plc=[PLACEMENT]&key=2&ip=xxx.xx.xxx), make sure the same IP value in the ad request parameter is contained in the request headers for the IP

 

 

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk