VAST is today's preferred technology for monetizing video inventory. E-Planning SSP can be implemented using VAST tags for both web traffic and mobile apps.

Content

How to get the tags

VAST tags consist of URLs that must be implemented directly in your video player or ad server. They can be extracted from the platform by accessing the Implementation tab.

There are different tag versions, depending on where they will be implemented:

Web VAST tag: Use this code if you are going to implement the VAST tag in a web site
In-App VAST tag: Use this code if you are going to implement the VAST tag in a mobile app
CTV VAST tag: Use this code if you are going to implement the VAST tag in a CTV app

Remember that you also need to implement the lines in the ads.txt file correctly. Click here for more info about ads.txt.

Implementation

Copy the tag and paste it into your video player or ad server, according to the instructions provided by them for implementing VAST tags.

Macros

The tags that can be extracted from the platform contain a series of macros, which are automatically replaced by your video player or ad server. In case your video player or ad server does not support VAST macros, please replace them manually.

Web VAST tag

[PLAYERSIZE]: must be replaced by the height and width of the video player, separated by the "," (comma) character. For example: 640,480
[PAGEURL]: must be replaced by the URL of the current page encoded.
[PLACEMENTTYPE]: must be replaced by 1 if the player is in-stream or 2 if the player is out-stream.

Eg:

https://ads.us.e-planning.net/vssp/1/18f66?sz=640,480&ur=https%3A%2F%2Fwww.test.com&vv=3&vctx=1

In-App & CTV VAST tag

[PLAYERSIZE]: must be replaced by height and width of the video player, separated by the "," (comma) character. For example: 640,480
[APPBUNDLE]: must be replaced by the bundle of the application, for example com.android.myapp
[PLACEMENTTYPE]: should be replaced by 1 if the player is in-stream or 2 if the player is out-stream
[IFA]: must be replaced by the user's Identifier for Advertisers (IFA). If not available or unknown, it should be left blank.

Eg:

https://ads.us.e-planning.net/vssp/1/18f66?sz=640,480&b=com.android.myapp&vv=3&vctx=1&ifa=AA000DFE74168477C70D291f574D344790E0BB11

Extra fields

Some fields are optional and are not included by default in the tags. However, we strongly recommend you to add them when available, as it will help to better monetize your content.

You can append any of these as a parameter to your VAST tag. For example, if you want to add age information to the tag:

https://ads.us.e-planning.net/vssp/1/18f66?sz=640,480&b=com.android.myapp&vv=3&vctx=1&ifa=AA000DFE74168477C70D291f574D344790E0BB11&age=35

All parameters should be URL encoded where necessary.

User & device fields

Field	Description
ip	User IPv4 addresss
ua	User Agent
dtype	Device Type (device.devicetype): 1 = Mobile/Tablet - General 2 = Personal Computer 3 = Connected TV 4 = Phone 5 = Tablet 6 = Connected Device 7 = Set Top Box 8 = OOH Device
ifv	Identifier For Vendors (aka IDFV)
lat	Latitude expressed as a float
lon	Longitude expressed as a float
lltype	Lat/Lon type, ie. how was lat/lon collected? 1 = GPS/Location Services 2 = IP Address 3 = User provided (eg. registration data)
age	Age of user (eg. 51, 24)
gender	Gender of user. Lowercase values will work as well M = Male F = Female O = Other
us_privacy	US privacy string, required jurisdictions where legally enforced https://github.com/InteractiveAdvertisingBureau/USPrivacy/blob/master/CCPA/US%20Privacy%20String.md
consent	TCF2 consent string
gpp	GPP string, required in jurisdictions where legally enforced
gpp_sid	GPP section id. Comma separated for multiple sections
coppa	Boolean to specify if the transaction is subject to COPPA or not 0 = No 1 = Yes

Inventory fields

Field	Description
minduration	Minimum duration allowed in seconds
maxduration	Maximum duration allowed in seconds
protocols	Comma separated list of supported video protocol IDs 1 = VAST 1.0 2 = VAST 2.0 3 = VAST 3.0 4 = VAST 1.0 Wrapper 5 = VAST 2.0 Wrapper 6 = VAST 3.0 Wrapper 7 = VAST 4.0 8 = VAST 4.0 Wrapper 9 = DAAST 1.0 10 = DAAST 1.0 Wrapper
apis	Comma separated list of supported video API IDs 1 = VPAID 1.0 2 = VPAID 2.0 3 = MRAID-1 4 = ORMMA 5 = MRAID-2 6 = MRAID-3 7 = OMID-1
pm	Playback method that is used, if none is specified, any may be used: 1 = Initiates on Page Load with Sound On 2 = Initiates on Page Load with Sound Off by Default 3 = Initiates on Click with Sound On 4 = Initiates on Mouse-Over with Sound On 5 = Initiates on Entering Viewport with Sound On 6 = Initiates on Entering Viewport with Sound Off by Default
sd	Indicates the start delay in seconds for pre-roll, mid-roll, or post-roll: Value > 0 = Mid-Roll (value indicates start delay in second) 0 = Pre-Roll -1 = Generic Mid-Roll -2 = Generic Post-Roll
plcmt	Placement type for the impression: 1 = Instream 2 = Accompanying Content 3 = In-Article 4 = No Content/Standalone
instl	Whether this ad unit is within an interstitial or not 0 = No 1 = Yes
pos	Position of ad in the viewport 0 = Unknown 1 = Above Fold 3 = Below Fold 7 = Fullscreen
schain	The serialized form of the supply chain object. Only required if the publisher’s relationship with E-Planning is not direct.
ssai	Indicates if server-side ad insertion 0 = Unknown 1 = All client-side 2 = Assets stitched server-side but tracking pixels fired client-side 3 = All server-side
ipd	Inventory partner domain. Third-party domain authorized to validate ads.txt and app-ads.txt
mnbr	Minimum bit rate in Kbps
mxbr	Maximum bit rate in Kbps
sturl	App store URL for an installed app

Video content fields

These fields describe the content in which the ad will appear. Content fields are highly recommended in CTV inventory and should be added whenever possible.

Field	Description
content_id	ID uniquely identifying the content
title	Content title (e.g. Search Committee)
series	Content series (e.g. The Office)
genre	Genre that best describes the content
season	Content season (e.g., “Season 3”)
episode	Episode number
language	Content language using ISO-639-1-alpha-2 (i.e., EN)
rating	Content rating (e.g., MPAA)
len	Length of content in seconds
ctx	Type of content (game, video, text, etc.). 1 = Video 2 = Game 3 = Music 4 = Application 5 = Text 6 = Other 7 = Unknown
content_categories	Comma-separated list of IAB categories
content_keywords	Comma-separated list of keywords
livestream	0 = Not live 1 = Content is live (e.g., stream, live blog)
channel	Channel name (e.g., “MTV”)
content_producer_name	Content producer or originator name (e.g., “Warner Bros”)
network_name	Network the content is on (e.g., a TV network like “ABC")

Bid floor

By default the auction will be performed using the bid floor configured in the UI. However, it is possible to define bid floors dynamically in the tag using the p= parameter.

To set them up, add to the tag (in any of its versions) a new parameter p= with the bid floor. For example:

https://ads.us.e-planning.net/vssp/1/18f66?sz=640,480&b=com.android.myapp&vv=3&vctx=1&p=1.23

Then the auction will have a minimum price of USD 1.23

Pricing

We support the use of the <Pricing> tag in the VAST response, where we report the bid price expressed as CPM. If your ad server or video player supports it, you can use this field to decide whether to play the ad or not based on other bids you may have for the same impression.

This is an example of a a VAST document using the <Pricing> tag:

<VAST version="3.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <Ad id="45-1678755">
        <InLine>
            <AdSystem>e-planning</AdSystem>
            <AdTitle>Demo Ad</AdTitle>
            <Pricing model="cpm" currency="USD">
                <![CDATA[ 5.00 ]]>
            </Pricing>

You can find more information in the IAB VAST 3.0 definition under the 2.2.4.2 section.

User sync / Cookie matching

For web implementation, it is important to sync users as this can considerably increase the results.
To do this, insert the following HTML code in all your pages:

<iframe src="https://ads.us.e-planning.net/uspd/1/" width="0" height="0" style="display: none;"></iframe>