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=&vpw=&vph=&vpaid=&coppa=&age=&yob=&gender=

 

If you have trouble verifying your VAST XML URL please contact your Account Manager for assistance: pubaccounts@aerserv.com

  

 

Step 4c: Connected TV


 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=&adid=&dnt=&ip=&make=&model=&os=&osv=&type=&ua=&age=&yob=&gender=&vpaid=&vph=&vpw=&coppa=&bundleid=&pl=&sc=&site_appstore_id=

 

 

  

Parameter Overview

 
 PARAMETER  DESCRIPTION EX. VALUE  MOBILE WEB  IN-APP   DATA TYPE

adid

Advertising ID - Unhashed Apple IDFA or Google AdId

bbd606b1-32ab-4a1e-
b2aa-5771ad804430

 N/A Required   String
age

Age Demographic Information

22 Optional Optional Integer

appdomain

Application's Website

https://www.ea.com/games/
real-racing/real-racing-3

 N/A Required  String (encoded)
appname Application Name Tien%Len%Online N/A

Required 

* Passing a application name 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 application name from our system and you are not required to pass it in your ad request.

String (encoded)
appversion

Application Version

1.5 N/A

Optional

String
base_domain_url

The base URL of the page where the advertisement will be displayed

http://www.eonline.com

Required N/A  String (encoded)

bundleid

App Bundle ID

com.popcap.ios.BejBlitz

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)
carrier

Cell carrier

Verizon

N/A

Optional

String (encoded)

cb

A unique number generated (guid) to prevent a browser from caching the ad and to ensure a unique call to the server for each ad. This macro helps eliminate discrepancies with outside servers

 

e9a0739e-69a3-4501
-9278
-f28a60e4b37a

 Required  Required  String
coppa 

Indicates if your app requires COPPA regulation. COPPA imposes certain requirements on operators of websites or online services directed to children under 13 years of age, and on operators of other websites or online services that have actual knowledge that they are collecting personal information online from a child under 13 years of age.

Values: 1=yes , 0=no

 1  Optional  Optional  Boolean
dnt

Do Not Track .

Values: 1 - for do not track is enabled, 0 - for allow to track

 1  N/A Required  Boolean

gender

Gender demographic information.

Values: male, female

male Optional Optional String

inttype

Device ID Type.

Values: 1 - Mobile/Tablet, 2 - Personal Computer, 3 - Connected TV, 4 - Phone, 5 - Tablet

 1 Optional  Optional Integer

ip

Client IP Address

123.456.78.9

Required Required  String

lat

Latitude of Device

33.58

 N/A  Optional  Float

locationsource

Origination of Lat/Long.

Values: 1 - GPS, 2 - Derived from IP

1

Optional   Optional  Integer
long Longitude of device  117.73  N/A Optional  Float
make Device Make apple Optional Optional String (encoded)
model Device Model iPhone 7 Optional Optional String (encoded)
network

The connection your device is using

 wifi, carrier N/A Optional  String (encoded)
 os Operating System iOS Optional Optional  String (encoded)
OSV  Operating System Version 10.1 Optional Optional   String
pl

Indicates whether the call is for a preloaded ad.

Values: 0 designates a call for an ad that will be displayed right away, 1 designates a call made to preload an ad

1 N/A Required Integer
sc

The natural scale factor associated with the screen

1 N/A Optional Integer
site_appstore_id

Apple appstore ID

123456789  N/A

Required for IOS

 Integer
siteurl  App Store URL

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

 N/A

Required 

* Passing a app store URL 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 app store URL from our system and you are not required to pass it in your ad request.

String (encoded)

type 

Device Type.

Values: phone, tablet

 Tablet Optional  Optional  String
ua Client User Agent

Mozilla%2F5.0%20
(Linux%3B%20Android%
204.0.4%3B%20Galaxy%
20Nexus%20Build%
2FIMM76B)

Required Required String (encoded)
url

The full page URL where advertisement will be displayed

 

http://www.eonline.com
/news/entertainment

Required N/A String (encoded)
 

vpaid

 

VPAID flag set this if you would like or dislike VPAID ads.

Values: 1=allow, 0=do not allow

1 Optional  Optional Integer
vph  

Video player height

480 Optional Optional Integer 
vpw Video player width 360 Optional Optional Integer
yob Year of birth demographic information 1985  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