Vungle VAST Integration Guide

This article describes the Vungle process and specifications for DSP partners serving VAST ads on the Vungle Exchange. For more information, refer to the IAB VAST 2.0 document.

Support

  • Vungle Exchange supports VAST 2.0 and 3.0.
    • Vungle Exchange does NOT support VPAID
    • Vungle Exchange does NOT support MRAID video. Refer to our MRAID documentation for more information.
  • VAST InLine and Wrapper
  • XML must contain:
    • one .mp4 media file
    • bitrate information
    • mediafile length information
    • mediafile height and width
    • secure assets
  • Must click through to landing page
    • Any redirects can only redirect a maximum of one time
    • Must support SSL
  • Supported media MIME types:
    • Android: video/mp4
    • iOS: video/mp4
  • Unsupported media MIME types:
    • MOV, Flash, HLS
  • File size limits:
    • Maximum 120-second video duration
    • Minimum bitrate of 250 kbps
  • Response time:
    • for streaming: must be within 250ms
    • for pre-cached: must be within 750ms
  • VAST extensions are optional, but preferred

Vungle will return an error if any of the above requirements are not met.

Endcards (CompanionAds)

We encourage all DSP partners to run endcards to increase performance. VAST-capable inventory supports companion ads, or endcards.

Implementation

In the VAST response, inside the <CompanionAds> element and define at least one <Companion> node with the desired resource file information for the endcard. The resource file can be of type <StaticResource> or <HTMLResource>.

StaticResource

The following is an example of a static image endcard.

Sample Code

<CompanionAds>
    <Companion>
        <StaticResource creativeType="image/jpeg">
            < [CDATA[https://Your_endcard_image_url]]>  // Required
        </StaticResource>
        <TrackingEvents>
            <Tracking event='creativeView'>
                < [CDATA[https://endcard_tracking]]>  // Required
            </Tracking>
        </TrackingEvents>
        <CompanionClickThrough>
            < ![CDATA[https://endcard_click_through]]>  // Required
        </CompanionClickThrough>
        <CompanionClickTracking>
            < ![CDATA[https://endcard_click_tracking]]> // Required
        </CompanionClickTracking>
    </Companion>
</CompanionAds>

HTMLResource

The following is an example of an HTML endcard.

Sample Code

<CompanionAds>
    <Companion>
        <HTMLResource>
            <![CDATA[
    <div>Your end card content</div> // Content can not be empty
    <script src=""></script>
    ]]>
        </HTMLResource>
        <TrackingEvents>
            <Tracking event='creativeView'>
                < ![CDATA[https://endcard_tracking]]> // Required
            </Tracking>
        </TrackingEvents>
    </Companion>
</CompanionAds>

Open Measurement

For Open Measurement support, you must include the <Extension> and <AdVerifications> node in your VAST tag. Additionally, you must pass API:7 in the bid response.

<Extension type="AdVerifications">
   <AdVerifications>
      <Verification vendor="vendor name">
         <JavaScriptResource apiFramework="omid" browserOptional="true">
<![CDATA[https://verification.com/omid_verification.js]]>
         </JavaScriptResource>
         <TrackingEvents>
            <Tracking event="verificationNotExecuted">
<![CDATA[https://verification.com/omid_error?reason=[REASON]]]>
            </Tracking>
            </TrackingEvents>
            <VerificationParameters>
             <![CDATA[“Vendor name”]>
            </VerificationParameters>
         </Verification>
      </AdVerifications>
</Extension>

Sample VAST Requests

Sample VAST request URL (VAST tag) with unfilled parameters

https://partner.com/vast2/6524rgww153hifw/?duration=15&app_name={{{pub_app_name}}}&app_id={{{market_id}}}&rtb_type=instream_mobile_vast_inter&user_id={{{device_id}}}&ua={{{browser_user_agent}}}&random={{{timestamp}}}&ip_address={{{ip}}} 

Sample VAST request URL (VAST tag) with filled parameters

https://partner.com/vast2/124765432/?duration=15&app_name=My%20Talking%20Tom%20Free%20for%20Android&app_id=com.outfit7.mytalkingtomfree&rtb_type=instream_mobile_vast_inter&user_id=6df43c89-9e3d-43fb-a1e9-bacd51932d41&ua=Mozilla%2F5.0%20(Linux%3B%20Android%204.4.2%3B%20SPH-L720%20Build%2FKOT49H)%20AppleWebKit%2F537.36%20(KHTML%2C%20like%20Gecko)%20Version%2F4.0%20Chrome%2F30.0.0.0%20Mobile%20Safari%2F537.36&random=2015-01-27T21%3A30%3A34%2B00%3A00&ip_address=66.87.114.254 

VAST Request Parameters

Parameter Name Macro Value Notes Example
App Category {{{pub_app_store_category}}} String List of categories Games
App Name {{{pub_app_name}}} String From the iTunes or Play store Family Farm Seaside
App Store URL {{{pub_app_store_url}}} String App Store or content URL. Encoded. https://play.google.com/store/apps/details?id=com.funplus.familyfarm&hl=en
Bundle ID {{{pub_market_app_id}}} String/Int From the iTunes or Play store com.funplus.familyfarm&hl=en (Android)
539920547 (iOS)
City {{{city}}} String Encoded New York
Connection Type {{{connection_type}}} String Wifi, wwan, mobile Wifi, wwan, mobile
Country {{{country}}} String Two-letter country code US
Device DNT {{{ad_tracking_disabled}}} String 'True' indicates that user does not allow ad tracking True/False
Device DNT {{{ad_tracking_enabled}}} String 'True' indicates that user does allow ad tracking True/False
Device DNT {{{boolean_number ad_tracking_disabled}}} Int Do not track, in binary form 0 – False
1 - True 
Device ID {{{device_id}}} String Clear or Hashed ab4d6cc4-f57f-4309-9d29-b7fb5e35dd74
Device Model {{{device_model}}} String Encoded Amazon,KFFOWI
samsung,SM-J700T
IP {{{ip}}} String Internet Protocol Address 95.118.153.77
Language {{{language}}} String Two-character Language from headers  10.2.1
OS version {{{os_version}}} String OS Version (ie iOS 7.2) 2014-12-05T00%3A44%3A19%2B00%3A00
Platform {{{device_platform}}} String iOS or Android iOS/Android
Screen Height {{{screen_height}}} Integer Screen height (pixels) 768
Screen Orientation {{{screen_orientation}}} String Portrait or Landscape Portrait/Landscape
Screen Width {{{screen_width}}} Integer Screen width (pixels) 1024
Timestamp {{{timestamp}}} String/Int Encoded 2014-12-05T00:44:19+00:00
User Agent {{{browser_user_agent}}} String UA from headers. Encoded. Mozilla/5.0 (Linux; Android 5.1.1; VF-1397 Build/LMY47V; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/55.0.2883.91 Safari/537.36
Vungle ID {{{vungle_id}}} String Vungle Publisher ID to associate performance 5497c989a3b61ba3660001b1

Questions?

Need further assistance, feel free to reach out to us, we’re here to help!

Was this article helpful?