For the complete documentation index, see llms.txt. This page is also available as Markdown.

VAST Tag

XML Example

<?xml version="1.0" encoding="UTF-8"?>
<VAST version="3.0">
    <Ad id="1111111">
        <InLine>
            <AdSystem>Exoclick</AdSystem>
            <AdTitle/>
            <Impression id="exotr">
                <![CDATA[https://syndication.myadserver.com/vregister.php?a=vimp&tracking_event=impression&idzone=22222&data=abcd]]></Impression>
            <Error>
                <![CDATA[https://syndication.myadserver.com/vregister.php?a=vview&errorcode=[ERRORCODE]&idzone=22222]]></Error>
            <Creatives>
                <Creative sequence="1" id="12345">
                    <Linear skipoffset="00:00:05">
                        <Duration>00:00:20.54</Duration>
                        <TrackingEvents>
                            <Tracking id="prog_1" event="progress" offset="00:00:10.000">
                                <![CDATA[https://syndication.myadserver.com/vregister.php?a=vview&tracking_event=progress&progress=00:00:10.000&idzone=22222&data=abcd]]></Tracking>
                        </TrackingEvents>
                        <VideoClicks>
                            <ClickThrough>
                                <![CDATA[https://syndication.myadserver.com/click.php?data=abcd]]></ClickThrough>
                        </VideoClicks>
                        <MediaFiles>
                            <MediaFile delivery="progressive" type="video/mp4">
                                <![CDATA[https://static.myadserver.com/library/12345/myvideo.mp4]]></MediaFile>
                        </MediaFiles>
                        <Icons>
                            <Icon>
                                <IconClicks>
                                    <IconClickThrough>exoclick.com</IconClickThrough>
                                </IconClicks>
                            </Icon>
                        </Icons>
                    </Linear>
                </Creative>
            </Creatives>
            <Extensions>
                <Extension>
                    <TitleCTA>
                        <MobileText>View More</MobileText>
                        <PCText>View More</PCText>
                        <DisplayUrl><![CDATA[]]></DisplayUrl>
                        <Tracking><![CDATA[https://syndication.myadserver.com/click.php?data=abcd]]></Tracking>
                    </TitleCTA>
                </Extension>
                <Extension>
                    <DSA>
                        <Behalf>Exoclick SL</Behalf>
                        <Paid>Exoclick SL</Paid>
                        <WhyThisAd>The time of day. Your general location (e.g. country or region). Websites or apps you may have visited.</WhyThisAd>
                        <ClickThrough>
                            <![CDATA[ https://a.magsrv.com/about-this-ad.html?data=eyJhZHZlcnRpc2VyX25hbWUiOiJFeG9jbGljayBTTCJ9 ]]>
                        </ClickThrough>
                    </DSA>
                </Extension>
            </Extensions>
        </InLine>
    </Ad>
</VAST>

Properties

Option
Explanation

<?xml version="1.0" encoding="UTF-8"?>

XML prolog with defined version and encoding.

Ad

Ad's root element that represents a single ad. It contains all of the information necessary for the video player to display and track the Ad creative. Exoclick currently supports one ad per VAST response since that is a common practice. Ad "id" attribute represents the bidding campaign id.

InLine

Element that contains all the files and URIs necessary to play and track the ad.

AdSystem

Element that contains descriptive name for the system that serves the ad, which every ad serving party must provide.

AdTitle

Not provided.

Impression

Element that contains impression tracking URI for the ad. Impression id attribute represents ad server id for the impression.

Error

Element that contains a URI that the player uses to notify the ad server when errors occur with ad playback. If the URI contains an [ERRORCODE] macro, the video player must populate the macro with an error code.

Creatives

Container element for one or more <Creative> element used to provide creative files for the ad. For an InLine ad, the <Creatives> element nests all the files necessary for executing and tracking the ad.

Creative

Each element contains nested elements that describe the type of ad being served using nested sub-elements for Linear or NonLinear Ads. Exoclick provides only one <Creative> element per VAST response. Creative sequence attribute represents sequence, so for a single creative value, the "sequence" will be 1. Exoclick Creative id attribute represents winning creative id.

Linear

Sets the video-formatted ads that play linearly within the streaming content, meaning before the streaming content, during a break, or after the streaming content. A Linear creative has to contain at minimum, <Duration> element to communicate the intended runtime and a <MediaFiles> element used to provide the needed video files for ad execution. Exoclick also provides TrackingEvents, VideoClicks and Icons (optional). Linear skipoffset attribute identifies when skip controls are made available to the end user.

Duration

Element to denote the intended playback duration for the Linear component of the ad. Time value may is in the format HH:MM:SS.

MediaFiles

Container element for one or more <MediaFile> elements, each of which contains a CDATA wrapped URI to the media file to be downloaded or streamed for the Linear creative. Linear creative are typically video files, but static images may also be used. Exoclick supports only a single MediaFile and no cross device or different bitrate MediaFile are supported.

MediaFile

Element contains URI to media file being served. MediaFile delivery attribute - either progressive for progressive download protocols (such as HTTP) or streaming for streaming protocols. MediaFile type attribute - MIME type for the file container, such as video/mp4 for MP4.

VideoClicks

Element which is used to specify what the video player should do if the user clicks directly within the video player frame while the ad is being displayed. When a <VideoClicks> element is provided, it contains a single child <ClickThrough> element with URI (or <ClickTracking> in case of Wrapper).

ClickThrough

Is a click URI that redirects to the advertiser's site when the Ad viewer clicks the ad. The clickthrough is only available in the InLine format and is used when the linear ad unit cannot handle a clickthrough.

TrackingEvents

Element used to send tracking information back to the ad server. The <TrackingEvents> element may contain one or more <Tracking> elements. An event attribute for the <Tracking> element enables ad server to include individual tracking URIs for events they want to track. Tracking "event" attribute - Exoclick is prepared for impression, progress, complete, but in most cases only progress is returned. Tracking offset attribute - when the progress of the linear creative has matched the value specified, the included URI is triggered. If the duration is not known when the offset is set to a percentage value, the progress event may be ignored.

Icons

Used for posting an icon with the linear ad. Exoclick provides only a single Icon under Icons. It can be disabled by setting imp.ext.icons_support = 0 in the RTB request.

Icon

Element containing <IconClicks> element.

IconCLicks

Element used to load an informational page in a new window as well as track when users clicks in the ad.

IconClickThrough

Element contains URI to the information page. The video player must load this page in a new window when the user clicks the icon.

Extensions

Element used for custom extensions, defined by the ad server. It must contain <Extension> element.

Extension

Element use for each custom feature

TitleCTA

Custom element to support CTA, it has following elements: <MobileText>, <PCText>, <DisplayUrl>, <Tracking>.

MobileText/PCText

Elements contains CTA text such as View More or Subscribe Now.

DisplayUrl

Optional friendly domain.

Tracking

Click tracking URI. On Exoclick it can be disabled by setting sending imp.ext.video_cta = 0 in the RTB request.

DSA

Custom element to support DSA, it has following elements: <Behalf>, <Paid>, <WhyThisAd>, <ClickThrough>. The Digital Service Act disclaimer.

Behalf and Paid

The name of the advertiser who paid for this ad

Why this ad

The specific user information that was collected

Clickthrough

Additional information related to DSA

Last updated

Was this helpful?