Ads in the video player

General provisions

VAST is a standard that describes the process of serving banners by a video player and sending statistics to an ad server.

Ads are served in accordance with the international media industry standards. This article describes the final solutions within the framework of these standards.

Here's how ads are served: the player requests a video banner, plays the content returned in the VAST response, and sends statistics on impressions and other events to Adfox. This data can also be sent to third-party systems using tracking pixels. This can happen either directly between the video player and Adfox, or between the video player, Adfox, and a third-party ad server. When accessing Adfox, the player receives VAST XML as shown in the example.

The Wrapper response contains the Wrapper tag with a link to a third-party ad server. A third-party server can send a Linear Ad or Wrapper banner that links to another ad server. As a result, the last server in the chain must send all the files required for ad serving.

Requirements for advertising materials

Available preset templates

Linear Ads Video

A full-frame ad that pauses the playback of video content. This is usually a video ad, but static images displayed at a certain time may also be used. This type of ad can be served before the video content is played (pre-roll), in a break during content playback (mid-roll), or after the video playback (post-roll).

The content type is a video file.

Linear-Ad (Pre / Mid / Post-roll) VAST 3.0 Viewability

A template with a viewability check. If more than 50% of the player is within the viewable area, a viewability event is triggered after 2 seconds. Event statistics are available in reports.

Linear-Ad (Pre / Mid / Post-roll) VAST 2.0 Compatible No Click

A template for a video without click support.

Linear-Ad (Pre / Mid / Post-roll) VAST 3.0

A template with click support.

Linear Ads Audio

The content type is an audio file.

Linear-Ad (Pre / Mid / Post-roll) Audio VAST 3.0

A template for an audio without click support.

Nonlinear Ads

An overlay ad that's served simultaneously with the main video playback. This is usually a static image that's placed in the player and occupies part of the player area.

Non-Linear Adfox Overlay Image VAST 3.0

A template that displays an image on top of a video. The content type is an image.

Parameters for adding banners to Adfox:

• Image: A file or link to an image.
• Width: The image width.
• Height: The image height.
• Bottom margin: The player's lower margin (%).
• Transition URL: The click link.
• box-shadow: The CSS property that describes the style of shadow cast by the image on the video.

The required parameters are the image, width, and height.

Sample VAST

Non-Linear Adfox Overlay HTML VAST 3.0

A template for displaying arbitrary HTML on top of a video. The content type is HTML code. The entire banner area is clickable.

Parameters for adding banners to Adfox:

• HTML code: The HTML code of the creative.
• Width: The iframe banner width.
• Height: The iframe banner height.
• Bottom margin: The player's lower margin (%).
• Transition URL: The click link.
• box-shadow: The CSS property that describes the style of shadow cast by the image on the video.

The required parameters are the HTML code, width, and height.

Sample VAST

Non-Linear Adfox Overlay HTML Custom VAST 3.0

A template for displaying arbitrary HTML on top of a video. The content type is HTML code. A template where you can set clickable areas.

Parameters for adding banners to Adfox:

• HTML code: The HTML code of the creative.
• Width: The iframe banner width.
• Height: The iframe banner height.
• Bottom margin: The player's lower margin (%).
• Transition URL: The click link.
• box-shadow: The CSS property that describes the style of shadow cast by the image on the video.

The required parameters are the HTML code, width, and height.

Sample VAST

Wrapper (VAST redirect)

A VAST instance that redirects to another URL for receiving ads and contains additional pixels. Used for forwarding third-party ads and measuring events in Adfox.

VAST 2.0 Wrapper can link to the contents of VAST 3.0, and VAST 3.0 Wrapper can link to VAST 2.0.

The content type is a link to VAST XML.

Preset InPage templates available in Adfox

Linear-Ad (Pre / Mid / Post-roll) VAST 2.0 for InPage

A template for the video file content type.

Linear-Ad (Pre / Mid / Post-roll) VAST 3.0 for InPage Viewability

A template for the video file content type with a viewability check.

Wrapper VAST 2.0 for InPage

A template for Wrapper VAST XML content.

To learn more about templates and how to apply them, see InPage video.

Get a link to VAST XML

You can get the VAST link the same way as regular Adfox ad tags.

Instead of a code, there will be a link that looks like this:

https://yandex.ru/ads/adfox/168627/getCode?p1=bigha&p2=eojh&puid1=&puid2=&puid3=

Check links

You can check the links at a special page.

Use a custom player

1. Connect the ADSDK library in the <head> tag.

   <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
       <script
            type="text/javascript"
            charset="utf-8"
            src="https://yandex.ru/ads/system/adsdk.js">
       </script>
   </head>
   </html>
   

2. Declare a variable: an object with Adfox parameters.

   var adFoxParameters = {
       adFoxParameters: {
           ownerId: 168627,
           // ID of the tag's parent container <video></video>
           containerId: 'videoParent',
           // Adfox parameters
           params: {
               p1: 'bdcfe',
               p2: 'ekza',
               pfc: 'bupfm',
               pfb: 'frtqn'
           },
       }
    }
   

3. To start playback, call the play method and pass the Adfox configuration as an argument.

   ya.videoAd.play({
       // Video element
       videoSlot: document.querySelector('#video'),
       // An element for displaying controls. The element must not be positioned statically.
       // You can use the video's parent element.
       slot: document.querySelector('#videoParent'),
       // Loading config and ad playback config.
       config: adFoxParameters,
   });
   

Integration instructions:

• Standard integration
• Adfox integration

Advertising label

You must include an ad label and specify the advertiser and (or) their website when running ads in Russia. To learn more about the label and the banner menu, see Ad label and banner menu in Adfox banners.

To add an ad label to the player where the Yandex Video Ads SDK library is connected, open the Ad label list in the banner parameters and select Ad or Social ad. The ad label will be displayed automatically.

Enable the Show banner menu option if you have provided the advertiser information in the ad campaign parameters. The banner will include a banner menu shown as the icon, displaying the advertiser's information and a token (if ad register is enabled in the banner settings or a third-party token is provided).

The banner menu contains a link to the rules for using recommendation technologies. That is necessary to comply with paragraph 3, section 1, article 10.2-2 of Federal Law No. 149-FZ On information, information technologies, and information protection", dated July 27, 2006.

If you're not using the Yandex Video Ads SDK to display ads, add support of the extension tag to the player in this format:

<Extensions>
        <Extension type="AdTitle">
                <![CDATA[
                        {
                                "show": %banner.ad_label%,
                                "domain": "%banner.domain:jsenc%",
                                "socialAdvertising": %banner.ad_label_social%
                        }
                ]]>
        </Extension>
        <Extension type="AdTune">
                <![CDATA[
                        {
                                "show": %banner.ad_tune%,
                                "token": "%banner.token:jsenc%",
                                "advertiserInfo": "%campaign.advertiser:jsenc%"
                        }
                ]]>
        </Extension>
</Extensions>

Depending on the ad label settings of the banner, the macros may take the following values:

Examples of the extension tag:

<Extensions>
        <Extension type="AdTitle">
                <![CDATA[
                        {
                                "show": 1,
                                "domain": "",
                                "socialAdvertising": 0
                        }
                ]]>
        </Extension>
        <Extension type="AdTune">
                <![CDATA[
                        {
                                "show": 1,
                                "token": "token",
                                "advertiserInfo": "Advertiser information"
                        }
                ]]>
        </Extension>
</Extensions>

<Extensions>
        <Extension type="AdTitle">
                <![CDATA[
                        {
                                "show": 1,
                                "domain": "example.ru",
                                "socialAdvertising": 0
                        }
                ]]>
        </Extension>
        <Extension type="AdTune">
                <![CDATA[
                        {
                                "show": 1,
                                "token": "token",
                                "advertiserInfo": "Advertiser information"
                        }
                ]]>
        </Extension>
</Extensions>

<Extensions>
        <Extension type="AdTitle">
                <![CDATA[
                        {
                                "show": 0,
                                "domain": "example.ru",
                                "socialAdvertising": 1
                        }
                ]]>
        </Extension>
        <Extension type="AdTune">
                <![CDATA[
                        {
                                "show": 0,
                                "token": "token",
                                "advertiserInfo": "Advertiser information"
                        }
                ]]>
        </Extension>
</Extensions>           

<Extensions>
        <Extension type="AdTitle">
                <![CDATA[
                        {
                                "show": 1,
                                "domain": "",
                                "socialAdvertising": 1
                        }
                ]]>
        </Extension>
        <Extension type="AdTune">
                <![CDATA[
                        {
                                "show": 0,
                                "token": "token",
                                "advertiserInfo": "Advertiser information"
                        }
                ]]>
        </Extension>
</Extensions>           

Events

The preset Adfox templates have a <TrackingEvents> container with the <Tracking> tags in it. Every <Tracking> element contains the Adfox URI that the video player must use to make a request when a certain event occurs. The event name is passed in the event attribute.

List of events:

• The start of viewing (start).
• The video is selected (creativeView).
• The video is loaded (impression).
• The first quarter of viewing (firstQuartile).
• The middle of viewing (midpoint).
• The third quarter of viewing (thirdQuartile).
• Full view (complete).
• Turn the sound off (mute).
• Turn the sound on (unmute).
• Pause (pause).
• View from the beginning (rewind).
• Continue viewing (resume).
• Go to full screen (fullscreen).
• Expand (expand).
• Collapse (collapse).
• Go to the next video (acceptInvitationLinear).
• Click on the Close button, the user's exit (close).
• Click on the Skip ad text bar (skip).
• Click on the Go to the advertiser's website text bar (addclick).
• Error (Error).
• Progress: Available starting with VAST 3.0.

Response if there's no ad

When there's no suitable ad to serve, Adfox returns the following XML:

• InStream banner type:

  <?xml version=”1.0”?><nobanner></nobanner>
  

• InPage banner type:

  <?xml version=”1.0”?><VAST version="2.0"/>
  

To add a backup ad for VAST player ads, you need an ad request link. Put this link in square brackets in the VASTAdTagURI block:

<?xml version="1.0" encoding="UTF-8"?>
<VAST version="2.0">
    <Ad id="%placeId%">
        <Wrapper>
            <AdSystem>Adfox.ru</AdSystem>
            <VASTAdTagURI>
                <![CDATA[//yandex.ru/ads/adfox/XXXXXX/getCode?p1=xxx&p2=xxx&pfc=a&pfb=a&plp=a&pli=a&pop=a&puid1=%userValue1%]]>
            </VASTAdTagURI>
            <Impression></Impression>
            <Creatives></Creatives>
        </Wrapper>
    </Ad>
</VAST>

If you need to pass additional parameters to the request code forwarded, use macros:

• For values of user characteristics: puidN with the %request.puidN% value, where N is the characteristic number. For example, &puid1=%request.puid1%.
• To send a referer: dl with the %request.referrer:urlenc% value. For example, &dl=%request.referrer:urlenc%.

Copy the code and install it in the XML code of the placement's backup ad and/or banner type.

Contact support

Send an email