Testing Pre-Release Advertising Plugins

Product(s)
Video Cloud
Brightcove Player
Role(s)
Player Developer
Topic(s)
Advertising
Plugins

In this topic, you will learn how to use pre-release versions of the IMA3 and FreeWheel plugins with your player.

Overview

Showing video ads in Brightcove Player can be a complex task. Multiple entities (Brightcove Player itself, an ad server and the specific ad plugin) are all involved in successful delivery of advertising. To provide a testing environment for updates to the IMA3 and FreeWheel plugins, Brightcove will make available pre-release versions of the plugins. This document provides instructions on how to test with these pre-releases.

The pre-releases will be announced in the Brightcove Web Player Developer Forum, as well as in the changelog sections of the Advertising with the IMA3 Plugin and Advertising with the FreeWheel Plugin documents.

Testing IMA3 in Studio

The following steps guide you on how to test a pre-release IMA3 plugin in Studio:

  1. For safety's sake, you should record the current versions of the plugin you are currently using. This will allow you to restore the plugin version you were using before testing. You can always find the latest version of the plugin in the Plugin Version Reference document.
  2. Open the PLAYERS module and either create a new player or locate the player to which you wish to add the plugin.
  3. Click the link for the player to open the player's properties.
  4. Click Advertising in the left navigation menu.
  5. Uncheck the Enable Client-Side (IMA). You do not want this enabled as it may interfere with the version you will soon manually load.
  6. Click Save.
  7. Click Plugins in the left navigation menu.
  8. Next, click Add a Plugin.
  9. For the Plugin Name enter ima3.
  10. For the JavaScript URL, enter the URL to the pre-release JavaScript file.
  11. For the CSS URL, enter the URL to the pre-release CSS file.
  12. Enter the configuration options in the Options(JSON) text box. If you have previously configured the IMA3 plugin using the Plugins section, you will most likely not need to make any changes to the options.
  13. Click Save.
  14. To use the player, click Publish & Embed. you will be able to test using the Preview Player, or you can publish and use the Published Player.
  15. To close the open dialog, click Close.

Testing FreeWheel in Studio

The following steps guide you on how to test a pre-release FreeWheel plugin in Studio:

  1. For safety's sake, you should record the current versions of the plugin you are currently using. This will allow you to restore the plugin version you were using before testing. You can always find the latest version of the plugin in the Plugin Version Reference document.
  2. Open the PLAYERS module and either create a new player or locate the player to which you wish to add the plugin.
  3. Click the link for the player to open the player's properties.
  4. Click Plugins in the left navigation menu.
  5. Next, click Add a Plugin OR if you see FreeWheelPlugin in the list of plugins, click that.
  6. For the Plugin Name enter FreeWheelPlugin.
  7. For the JavaScript URL, enter the URL to the pre-release JavaScript file.
  8. For the CSS URL, enter the URL to the pre-release CSS file.
  9. Enter the configuration options in the Options(JSON) text box. If you have previously configured the IMA3 plugin using the Plugins section, you will most likely not need to make any changes to the options.
  10. Click Save.
  11. To use the player, click Publish & Embed. you will be able to test using the Preview Player, or you can publish and use the Published Player.
  12. To close the open dialog, click Close.

Testing programmatic implementation

Testing where you have implemented the plugin programmatically is the same whether you are using the IMA3 or FreeWheel plugin. Basically, you simply replace the existing paths to the JavaScript and CSS files with those for the pre-release version. The steps to perform this task follow.

  1. For safety's sake, you should record the current versions of the plugin you are currently using. This will allow you to restore the plugin version you were using before testing. You can always find the latest version of the plugin in the Plugin Version Reference document.
  2. In your code, locate the <link> and <script> tags that pull in the CSS and JavaScript for the appropriate plugin. In the code below, examples for the IMA3 plugin are highlighted.
  3. Replace those paths with the pre-release versions.
  4. Refresh your page and you will be using the pre-release version.
  5. Once testing is complete, again edit the paths to the JavaScript and CSS files using the paths recorded to restore your original configuration.
<!doctype html>
<html>

<head>
  <meta charset="UTF-8">
  <title>IMA3 Plugin Code Example</title>
  <style>
    .video-js {
      height: 344px;
      width: 610px;
    }
  </style>
  <link href="https://players.brightcove.net/videojs-ima3/2/videojs.ima3.min.css" rel="stylesheet">
</head>
<body>

  <video-js  id="myVideoID"
    data-video-id="3851380732001"
    data-account="1752604059001"
    data-player="Hy3gDJHu"
    data-embed="default"
    class="video-js"
    controls></video-js>
  <script src="https://players.brightcove.net/1752604059001/Hy3gDJHu_default/index.min.js"></script>

  <script src="https://players.brightcove.net/videojs-ima3/2/videojs.ima3.min.js"></script>

  <script>
    var myPlayer;

    bc('myPlayerID').ima3({
      serverUrl: 'http://solutions.brightcove.com/bcls/brightcove-player/vmap/simple-vmap.xml';
    });
    videojs.getPlayer('myPlayerID').ready(function() {
      myPlayer = this;
      ...
    });
  </script>
</body>

</html>