Video related analytics are an important part of a successful online video strategy. It can tell you which content works best for your audience and help with identifying viewing issues.
Our Google analytics integration will help you track video-centric data coming from Radiant Media Player in both real-time or "next-day" reporting. We have done most of the heavy lifting for you, essentially you just need to enter your Google Analytics property ID as an input setting and the player will start sending logs to your Google Analytics back-end.
You can also refer to our analytics API for more advanced use-cases and custom integration.
gaTrackingId: String
Google Analytics property ID. Typically looks like UA-XXXXXXXX-Y. Default: ''.
gaCategory: String
Set the Google analytics tracking category. Typically the object that was interacted with (e.g. 'Video'). Default: 'RMP'.
gaLabel: String
Set the Google analytics label for each events. Use it to uniquely identify your content (e.g. 'Fall Campaign'). Default: 'RMP label'
gaNamedTracker: String
In some cases you might want to send data to multiple properties from a single page. This is useful for sites that have multiple owners overseeing sections of a site; each owner could view their own property. In such cases we need to configure
Google Analytics to
work with multiple trackers. When set this setting allows to do just that with a custom tracker based on
gaNamedTracker. The player will automatically send data with this named tracker. Default: '' which means no specific named tracker is used.
gaEvents: Array
Lets you customise which events should be sent to Google Analytics. Default: ['context', 'ready', 'playerstart', 'error', 'adimpression', 'adloadererror', 'aderror'].
gaAnonymizeIp: Boolean
When gaAnonymizeIp is set to true, hits sent to Google Analytics will have
anonymized IP addresses. This can help with compliance to specific privacy laws like GDRP.
Default: false.
gaNonInteractionEvents: Boolean
When set to true this setting enables to send Google Analytics video-related events as non-interaction events. Default: false.
rmp.getGALabel()
This methods returns a
String representing the current label used for Google Analytics.
rmp.setGALabel('new video title')
This methods takes as an input a non-empty String and sets this input to be used as the current label for Google Analytics.
rmp.getGACategory()
This methods returns a
String representing the current category used for Google Analytics.
rmp.setGACategory('new video category')
This methods takes as an input a non-empty String and sets this input to be used as the current category for Google Analytics.
rmp.sendGAEvent('hlslevelswitching')
This methods takes as an input a non-empty String representing a player or custom event and sends this event to Google Analytics according to current player configuration. See below for a complete usage example.
<script src="https://cdn.radiantmediatechs.com/rmp/5.1.6/js/rmp.min.js"></script>
<div id="rmpPlayer"></div>
<script>
var src = {
hls: 'https://your-hls-url.m3u8'
};
var settings = {
licenseKey: 'your-license-key',
src: src,
width: 640,
height: 360,
poster: 'https://your-poster-url.jpg',
// Our Google Analytics settings
gaTrackingId: 'UA-XXXXXXXX-Y',
gaCategory: 'E-learning video',
gaLabel: 'How to start with HTML5 video',
gaEvents: ['context', 'ready', 'playerstart', 'error', 'adimpression', 'adloadererror', 'aderror']
};
var elementID = 'rmpPlayer';
var rmp = new RadiantMP(elementID);
rmp.init(settings);
</script>
Our implementation is based on the analytics.js event tracking documentation. Refer to this documentation for more information. Events can be tracked in both real-time and "next-day" reporting in your Google Analytics back-end (events can be tracked in Behavior > Events).
Note that Google Analytics imposes Limits and Quotas. As such the data collected by our Google Analytics implementation may only be partial - if you go over your account limit Google decides when to collect data or not. Our implementation takes this into account and allows to be customised to just send the events you are after. If you have a high volume of monthly video views you may consider upgrading to a Google Analytics 360/premium account for better analytics data accuracy.
Below is the list of default tracked events when a valid gaTrackingId setting is provided:
ready: the player has reached the ready state. This event only fires once per player session.playerstart: this event fires when the first frame of content or pre-roll ad, if any, is presented to the viewer. When using related, playlist or the setSrc API method this event will fire each time a new item has started within
the player.error: fires when a fatal error is encountered by the player (often due to a network issue where the player is unable to fetch content).adimpression: fires when the impression URL has been pinged. This event may fire multiple times per player session.adloadererror: the player could not load the ad parser to start loading ads (either IMA or rmp-vast). Most of the time this means an ad-blocker is used. This event only fires once per player session.aderror: the player has registered an aderror. The two types of aderror are: adloaderror and adplayerror. adloaderror and adplayerror events can be logged separately to Google analytics (see section below).
Additional events for gaEvents setting:
enterfullscreen: the player has entered fullscreen mode. This event may fire multiple times per player session.ended: the player has reached the end of the content. This event may fire multiple times per player session. When loop setting is used this event may not fire. seeking: the player has received a seek order. This event may fire multiple times per player session.adclick: the player has registered a click for an ad. This event may fire multiple times per player session.adloaderror: indicates that the error was encountered when the ad was being loaded. Possible causes: there was no response from the ad server, malformed ad response was returned ...adplayerror: indicates that the error was encountered after the ad loaded, during ad play. Possible causes: ad assets could not be loaded, player received an Ad type that it was not expecting and/or cannot display ...adclientsidewaterfallrequested: fires when the player tries to load a new VAST tag with the adTagWaterfall setting. A aderror event shall also fire as fallback VAST tags from adTagWaterfall are orderly used when a aderror event is detected.Note that when both aderror and adloaderror/adplayerror are registered for logging the adloaderror/adplayerror events come in supplement to the aderror event. This means
that for each
aderror event you will have one adloaderror or
adplayerror event logged as well.
If the 'context' event is also provided through the
gaEvents setting ('context' is included by default), the player will also send data about the context in which it is rendered. Note that 'context' event requires 'ready' event to be registered as well. The value of the context event
can be one of the following (the related context event only fires once per player session):
html5-hls: the player is loaded in HTML5 mode with HLS.html5-hlsHevc: the player is loaded in HTML5 mode with HLS-fmp4 HEVC.html5-dash: the player is loaded in HTML5 mode with DASH.html5-mp4: the player is loaded in HTML5 mode with MP4 progressive download (H.264/AAC).html5-mp4Hevc: the player is loaded in HTML5 mode with MP4 progressive download (H.265/AAC).html5-webm: the player is loaded in HTML5 mode with WebM progressive download.html5-m4a: the player is loaded in HTML5 mode with M4A (audio-only) progressive download.html5-mp3: the player is loaded in HTML5 mode with MP3 (audio-only) progressive download.html5-ogg: the player is loaded in HTML5 mode with OGG (audio-only) progressive download.html5-outstream: the player is loaded in HTML5 mode with outstream ads (no content).nosupport: the player displays a no-support message to the viewer because it has no valid playback option.Through the sendGAEvent API method it is possible to send custom events to your Google Analytics account. In the following example we will send a new event each time one full minute of content has been consumed by the viewer. We will
be using the getTimeViewed
analytics API method to get this information.
<script src="https://cdn.radiantmediatechs.com/rmp/5.1.6/js/rmp.min.js"></script>
<div id="rmpPlayer"></div>
<script>
var src = {
hls: 'https://your-hls-url.m3u8'
};
var settings = {
licenseKey: 'your-license-key',
src: src,
width: 640,
height: 360,
poster: 'https://your-poster-url.jpg',
// Our Google Analytics settings
gaTrackingId: 'UA-XXXXXXXX-Y',
gaCategory: 'E-learning video',
gaLabel: 'How to start with HTML5 video',
gaEvents: ['context', 'ready', 'playerstart']
};
var elementID = 'rmpPlayer';
var rmp = new RadiantMP(elementID);
rmp.init(settings);
// Here we start our custom script
var lastDifferential = 0;
// fullminutewatched event will be sent each time differential threshold has been reached (60000 ms === 1 minute)
var sendingThreshold = 60000;
// We will use an interval checking our differential threshold every 500 ms
setInterval(function () {
var timeViewed = rmp.getTimeViewed();
if (timeViewed > 0) {
var diff = timeViewed - lastDifferential;
if (diff >= sendingThreshold) {
lastDifferential = timeViewed;
console.log('fullminutewatched');
rmp.sendGAEvent('fullminutewatched');
}
}
}, 500);
</script>