Setup
Troubleshooting
Overview
Brightcove is a high-performance, cross-platform HTML5-first video player that loads quickly, delivers high-quality video across desktop and mobile platforms. Our integration with Brightcove enables video event collection and targeting. This integration is both a Source and Destination:- Source: Permutive is able to track video events from the Brightcove player.
- Destination: Permutive is able to activate your cohorts for video ads served in the player.
- Track video events in Permutive, for insights, advanced segmentation or modeling.
- Add Permutive cohorts to your Google Ad Manager (GAM) ad requests so that they can be used for decisioning and targeting in realtime.
Environment Compatibility
Prerequisites
- Public API key: This can be found in the Permutive dashboard, in your project settings. We recommend provisioning a new one, by clicking Add Key and choosing Public.
- Brightcove Video Player: You should already have a Brightcove video player installed on your site. You must also have access to the Brightcove Cloud Studio dashboard, where you can configure your player.
Setup
- Primary Setup Steps
1
Enable in Permutive Dashboard
You must enable the Brightcove Video Player integration in the Permutive Dashboard, if this has not already be done.
In the Permutive dashboard, navigate to your workspace’s integrations page. Click Add Integration and select Brightcove Video Player.
There is nothing to configure in the Permutive Dashboard for this integration.
2
Install the Player Plugin
The Permutive plugin for Brightcove can be installed into your player using the Brightcove Cloud Studio dashboard. The following steps must be performed for every player where you want Permutive enabled:
3
Configure Video Ad Targeting
You can now configure the player to make Permutive cohorts available for targeting video ads served in your the player via the GAM ad server.
Targeting for pre-roll ads is only supported when using the “on play” Brightcove Request Ads setting. If “on load” is used, Permutive cohorts will not be included on the ad request.
4
Verify Setup
In the Permutive Dashboard, navigate to your events page. Having completed the above steps, plugin installation is now complete. You should start seeing video event data appear in the Permutive Dashboard.For your cohorts with a GAM activation configured, you should now see these cohorts available for targeting on video ad requests from the player.
Data Types
With your Brightcove integration setup, you’ll see the following additional event types collected in Permutive:VideoPlay
VideoPlay
Tracks each time a video is played.
VideoProgress
VideoProgress
Tracks progress of a video play, as a percentage watched.
VideoEvent
VideoEvent
Tracks additional events emitted by the player, such as when a user enters full screen mode or presses pause.
VideoLoad
VideoLoad
Tracks the first time a video loads on the page.
VideoAdPlay
VideoAdPlay
Tracks when a video ad is played, includes all ad information available from IMA.
The ID of the selected creative for the ad, or the empty string if this information is unavailable.
Returns the first deal ID present in the wrapper chain for the current ad, starting from the top. Returns the empty string if unavailable.
The registry associated with cataloging the UniversalAdId of the selected creative for the ad.
Returns the minimum suggested duration in seconds that the nonlinear creative should be displayed. Returns -2 if the minimum suggested duration is unknown. For linear creative it returns the entire duration of the ad.
VideoAdProgress
VideoAdProgress
Tracks progress of a video ad play, as a percentage watched.
The ID of the selected creative for the ad, or the empty string if this information is unavailable.
Returns the first deal ID present in the wrapper chain for the current ad, starting from the top. Returns the empty string if unavailable.
The registry associated with cataloging the UniversalAdId of the selected creative for the ad.
Returns the minimum suggested duration in seconds that the nonlinear creative should be displayed. Returns -2 if the minimum suggested duration is unknown. For linear creative it returns the entire duration of the ad.
VideoAdEvent
VideoAdEvent
Tracks additional events emitted by the player whilst an ad is being watched, such as when a user enters full screen mode, pressed pause or resumed play.
The ID of the selected creative for the ad, or the empty string if this information is unavailable.
Returns the first deal ID present in the wrapper chain for the current ad, starting from the top. Returns the empty string if unavailable.
The registry associated with cataloging the UniversalAdId of the selected creative for the ad.
Returns the minimum suggested duration in seconds that the nonlinear creative should be displayed. Returns -2 if the minimum suggested duration is unknown. For linear creative it returns the entire duration of the ad.
VideoAdClick
VideoAdClick
Tracks when a user clicks on a video ad.
The ID of the selected creative for the ad, or the empty string if this information is unavailable.
Returns the first deal ID present in the wrapper chain for the current ad, starting from the top. Returns the empty string if unavailable.
The registry associated with cataloging the UniversalAdId of the selected creative for the ad.
Returns the minimum suggested duration in seconds that the nonlinear creative should be displayed. Returns -2 if the minimum suggested duration is unknown. For linear creative it returns the entire duration of the ad.
Troubleshooting
Targeting for pre-roll video ads not working as expected
Targeting for pre-roll video ads not working as expected
Targeting for pre-roll ads is only supported when using the “on play” Brightcove Request Ads setting. If “on load” is used, Permutive targeting will not be included on the ad request. Check your settings in Brightcove Cloud Studio.
Related
Tracking Video Ad Impressions
Which ad identifiers are available when tracking video ad impressions, and why creative IDs on third-party hosted creatives may not match your ad server.
Changelog
November 2019
- Improved tracking of
VideoPlay, to include details of video duration and whether auto start was used.
For detailed changelog information, visit our Changelog.