Vungle Exchange OpenRTB 2.5 EndCard Integration

Use these instructions to run end cards with Vungle Exchange. 

Implement End Cards

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

AdParameters

This tag is defined by Vungle Exchange. With AdParameters, Vungle Exchange parses the elements provided by the third-party bidder in the <CompanionAds> node and assembles the end card using our internal templates. Refer to the following example.

Important Note: When using AdParameters, partners must specify their intent to run an end card by declaring <Companion id = "vungle_endcard_v1"> in the <CompanionAds> node.

Sample Code

<CompanionAds>
    <Companion id = "vungle_endcard_v1">   // must specify ID = "vungle_endcard_v1" Required
        <AdParameters xmlEncoded="true">
            <![CDATA[
<EndCardAdParameters>
    <cover_url>https://your-app-cover-url</cover_url> // Required
    <icon>https://your-app-icon-url</icon>  // Required
    <app_name>Your app Name</app_name>  // Required
    <description>Your app description</description>  // Optional
    <app_stars>4.5</app_stars>  // Required
    <button_text>Download button text</button_text>  // Required
    <download_url>https://your-app-download-url</download_url>  // Required
</EndCardAdParameters>
    ]]>
        </AdParameters>
        <TrackingEvents>
            <Tracking event='creativeView'>
                < ![CDATA[https://endcard_tracking]]>
            </Tracking>
        </TrackingEvents>
        <CompanionClickTracking>
            < ![CDATA[https://endcard_click_tracking]]>
        </CompanionClickTracking>
    </Companion>
</CompanionAds>

Sample Layout

Field Descriptions

StaticResource

The following is an example of a static image end card.

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 end card.

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>

HTML Endcard Type

When submitting HTML endcard, we highly recommend the following precaution for proper tracking and better performance:

When submitting VAST video + HTML playable endcard, include "attr": [13] in the seatbid.bid.attr. (When submitting VAST video + HTML static endcard: no new field needs to be included.)

Sample Code

      "appid": "",
      "id": "f3f183a6-xxx-xxx-86ee-xxxxx",
      "attr": [
        13
      ],
      "impid": "1",
      "bundle": "air.com.xxxx.xxxx",
      "cid": "1038"