Brightcove Video Integration Guide

These instructions allow you to enable IAS Campaign Monitoring solution within the Brightcove Video Platform using the IAS library.

Note: The guide does not cover enabling VAST ads for your player.

Prerequisites

In order to proceed with the Brightcove Video Platform Integration, you are required to have an account with Brightcove, as well as have a video player already created in Brightcove's Video Cloud.

In order to ensure access to the latest library, IAS recommends you use the library hosted at:

https://static.adsafeprotected.com/videojs-integral.js

or

http://static.adsafeprotected.com/videojs-integral.js

Alternatively, you may download the latest IAS library from the GitHub repository and host on a public accessible location.

Note: contact your IAS Solution Engineer if you wish to use the GitHub repository. The Solution Engineer with give you access the repository and notify you of library updates.

Plugin Initialization

You can initialize the plugin two ways, either statically through the Brightcove Studio or dynamically through the page.

Statically

Note: This option infers the campaign and placement IDs don't change and you have one player per ad unit.

After logging into your Brightcove account, click the Home drop down to go to the Players section:

BrightCoveVideoCloud

Then, click on the video player you want to enable IAS's technology:

CreatePlayer

Note: You must configure whichever plugin the publisher is using to play ads (for example, Google IMA or Brightcove SSAI) before configuring the Javascript and Name, Options (JSON) sections for the IAS library in order for the plugin to work properly.

In the "PLUGINS" panel, click the Edit button and then click on the JavaScript section:

DefaultPlayer

If you have downloaded the IAS plugin from the GitHub repository, you would need to point to the public URL location of the videojs-integral.js hosted file in the text field that appears. Once you do that, just click the + button next to it.

Whether you are using a hosted IAS plugin or downloaded the plugin, click Save before continuing.

BrightCovePluginChanges

Next, you need to add IAS options. Click Name, Options (JSON) section:

BrightCovePublish

Then, in the Enter a Plugin Name text field, enter "integral" (without quotes) and in the "plugin options", enter your IAS account details and campaign related details for tracking to work correctly. You need to provide the anId, campId (the campId is the widthxheight of the ad), and chanId (the Brightcove player ID).

This version of the IAS plugin uses chanId for the Brightcove player ID whereas older versions used placementId. Only use chanId for the Brightcove player ID.

For example:

{ "anId" : 12345, "campId" : "1280x720", "chanId" : "1001/placement", "custom" : "custom value"}

Macro

IAS UI Field

Brightcove

Added by plugin

Description

anId

Not applicable



Integer value for the advertiser ID property.

campId

Size


No

Hardcode size of the creative, for example: "campId" : "1280x720"

chanId

Ad Unit

Player ID

No

Hardcode the Brigthcove player ID, for example, "chanId" : "1001/placement"

placementId

Line Item

Ad ID

Yes (All)

Ad ID (publisher's ad ID is the line item)

pubId

Advertiser

Advertiser

Yes (IMA/SSAI)

Advertiser name or "Unknown Advertiser"

pubOrder

Order


Yes (IMA/SSAI)

AdX Deal ID (when available) or "Video Orders" (hardcoded by adapter for all other cases)

pubCreative

Creative

creativeId

Yes (IMA/SSAI)

Creative ID of the ad (publisher's creative ID)

custom

Varies per client

custom

No

Publisher must specify, for example, "custom" : "custom value"

custom2

Varies per client

custom2

No

Publisher must specify

custom3

Varies per client

custom3

No

Publisher must specify

ias_xps

Not in UI

ias_xps

No

Autoplay or click-to-play. Possible values include: "autoplayed" or "clicktoplay"

ias_xpb

Not in UI yet

ias_xpb

No

Break position (when in a video that ad played). Possible values include: "1" - pre-roll, "2" - mid-roll, "3" - post-roll, "4" - stand-alone

ias_xar

Not in UI

ias_xar

No

Autorefresh. Possible values include: "0" - false, or "1" - true

Note: Clients work with IAS to determine how the custom, custom2, and custom3 appear in the IAS UI.

Here's an example (please make sure to replace the actual values with your own):

BrightCovePublishChangesSample

Once you have all the details in place, click the + button and then Save.

At this point, the Brightcove platform should notify you that you have unpublished changes, so please make sure to click Publish Now?:

PublishNow

or the big Publish button from the top-right corner:

PublishButton

When the changes have been published you should now be able to preview the player or refresh any page that already has the video player embedded.

Dynamically

You can integrate the plugin directly on the web page for customers who are dynamically generating / varying ad tags or have one player per multiple ad units. Instead of providing the name/options in the Brightcove Studio, you can put JavaScript code on a page. You need to provide the anId, campId (the campId is the widthxheight of the ad), and chanId (the Brightcove player ID).

For example:

<myPlayerReference>.integral({'anId':####,'campId':'640x480','chanId':'####/tenplay'})

Summary

Once the plugin is initialized, whenever a VAST ad plays, it is automatically measured by IAS's technology.

Was this article helpful?

Need further help?

Create an IAS case with details of your inquiry to receive help from our internal support team.