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).
The video player uses the VAST XML to provide instructions for what video ad to play and when to play it. The VAST XML URL feed is in a standardized format that all video players can understand. If the feed does not conform to this standard the video player will be unable to understand the instructions and fail to play the video.
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.
AerServ will provide you with a VAST XML URL which you will enter into the ironSource ad server.
Step 1: Create an App or Site
For detailed instructions on how to set up your inventory (app or site), click here.
Step 2: Add aerVideo as an Ad Product & Create PLC
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: Export Your AerServ VAST Tag
- Click on Generate my Tag Link
- To verify integration replace live tag PLC with 1000741
Step 4: Add IronSource Macros into Ad Tag
Ad Tag Parameters
The VAST tag contains ad parameters that will need to be populated using ironSource’s macros 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 is 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.
Macros should be added after each key in the query string. ie ("cb=$[cb]").
- Macro shown above (in green) are AerServ specific, please use your 3rd party server macros
- Description of each ad tag parameters is below.
- Some required information listed in the parameter overview will be pulled from AerServ’s database. These parameters are not in the ironSource ad tag template.
- Template for AerServ tag with ironSource Macro’s
http://ads.aerserv.com/as/?plc=XXXXX&cb=[RANDOM]&adid=[IFA]&network=[NETWORK]&carrier=[CARRIER]&dnt=[LAT]&ip=[IP]&os=[OS]&osv=[OS_VERSION]&ua=[UA]
If you have trouble verifying your VAST tag please contact your Account Manager for assistance.
AerServ Parameter Overview:
|
DESCRIPTION
|
EXAMPLE
REQUEST KEY
|
EXAMPLE VALUE
|
MOBILE
WEB
|
IN-APP
|
DATA
TYPE
|
|---|---|---|---|---|---|
| Application Name | appname | Tien%Len%Online | N/A | Required | String (encoded) |
| App Store URL |
siteurl |
https://itunes.apple.com/us/app/tienlen onlinefree/id447031106? |
N/A | Required | String (encoded) |
| App Bundle ID |
bundleid |
IOS: id447031106 Android: |
N/A | Required | String (encoded) |
| Page URL | url | Required | N/A | String (encoded) | |
| App Domain |
appdomain |
ads.aerserv.com |
Required | Optional | String (encoded) |
| Application Version | appversion |
1.0 |
Required | Optional | String |
| CacheBuster |
cb |
123456789 |
Required | Required | Integer |
| Connection Type |
network |
wifi, carrier |
Required | Optional | String |
| Do Not Track |
dnt |
1 for do not track, 0 for allow to track |
Required | Required | Boolean |
| Advertising ID - unhased Apple IDFA or Google AdID | adid |
bbd606b1-32ab-4a1e-b2aa-5771ad804430 |
Required | Required | String |
| Lat | lat |
33.58 |
Required | Optional | Float |
| Long | long |
117.73 |
Required | Optional | Float |
| 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 |
ironSource Macros:
|
MACRO
|
DESCRIPTION
|
TYPE
|
|---|---|---|
| [IP] | Device IP Address |
String |
| [UA] |
Device User Agent |
String |
| [IFA] |
Device advertising identifier. Android: GAID, iOS: IDFA if LAT disabled, IDFV if LAT enabled |
String |
| [OS] |
Operating System |
String |
| [HEIGHT] |
Desired Ad Height |
String |
| [WIDTH] |
Desired Ad Width |
String |
| [APP_BUNDLE_ID] |
Application Bundle ID |
String |
| [APP_STORE_URL] |
Application Store URL |
String |
| [APP_NAME] |
Application Name |
String |
| [APP_CATEGORY] |
App Category in the Store |
String |
| [LAT] |
Denotes the setting for “Limit Ad Tracking” setting in the device |
Boolean |
| [LAT_STRING] |
Same as [LAT], where 1=”true” & 0=”false” |
String |
| [OS_VERSION] |
Device OS Version |
String |
| [TIME_STAMP] |
Device Time Stamp |
String |
| [CARRIER] |
Device Service Provider |
String |
| [NETWORK] |
Device Mobile Network Code |
String |
| [SDK_VERSION] |
ironSource SDK Version |
String |
| [RANDOM] |
Random INT |
Integer |
Comments