Skip to main content

Vimeo media tracking

This plugin enables the automatic tracking of a Vimeo video, utilising the Snowplow Media Plugin.

Example app

To illustrate the tracked events and entities, you can visit an example app that showcases the tracked media events and entities live as you watch a video.

There are examples for both the iframe and player methods of tracking a Vimeo video.

Source code for the app is available here.

Vimeo media events and entities are automatically tracked once configured.

Install pluginโ€‹

Tracker DistributionIncluded
sp.jsโŒ
sp.lite.jsโŒ

Download:

Download from GitHub Releases (Recommended)Github Releases (plugins.umd.zip)
Available on jsDelivrjsDelivr (latest)
Available on unpkgunpkg (latest)
window.snowplow(
'addPlugin',
'https://cdn.jsdelivr.net/npm/@snowplow/browser-plugin-vimeo-tracking@latest/dist/index.umd.min.js',
['snowplowVimeoTracking', 'VimeoTrackingPlugin']
);

Basic usageโ€‹

The snippets below show how to get started with the plugin, after setting up your tracker.

Accepted video attribute values

The plugin's video attribute will accept either:

iFrameโ€‹

<iframe
id='vimeo-iframe'
src='https://player.vimeo.com/video/535907279?h=db7ea8b89c'
></iframe>
const id = 'XXXXX'; // randomly generated ID
const video = document.getElementById('vimeo-iframe')

window.snowplow('startVimeoTracking', { id, video });

// Vimeo events are tracked...

window.snowplow('endVimeoTracking', id);

Vimeo.Playerโ€‹

<div id='vimeo-player'></div>
const id = 'XXXXX'; // randomly generated ID
const video = new Vimeo.Player('vimeo-player', {
videoId: 'zSM4ZyVe8xs'
});

window.snowplow('startVimeoTracking', { id, video });

// Vimeo events are tracked...

window.snowplow('endVimeoTracking', id);
caution

It's important to call endVimeoTracking as this will end any recurring ping events, clear all listeners set by the Vimeo plugin, along with resetting statistics counters used by the Snowplow Media plugin.

Selecting events to trackโ€‹

The plugin provides automatic tracking of the following events
Vimeo Event NameDescription
ReadySent when the media tracking is successfully attached to the player and can track events.
PlaySent when the player changes state to playing from previously being paused.
PauseSent when the user pauses the playback.
EndSent when playback stops when end of the media is reached or because no further data is available.
SeekStartSent when a seek operation begins.
SeekEndSent when a seek operation completes.
PlaybackRateChangeSent when the playback rate has changed.
VolumeChangeSent when the volume has changed.
FullscreenChangeSent immediately after the browser switches into or out of full-screen mode.
PictureInPictureChangeSent immediately after the browser switches into or out of picture-in-picture mode.
BufferStartSent when the player goes into the buffering state and begins to buffer content.
BufferEndSent when the the player finishes buffering content and resumes playback.
QualityChangeSent when the video playback quality changes automatically.
ErrorSent when the Vimeo player encounters an error
CuePointSent when a cue point is reached.
ChapterChangeSent when the chapter changes.
TextTrackChangeSent when the text track changes.
InteractiveHotspotClickedSent when an interactive hotspot is clicked.
InteractiveOverlayPanelClickedSent when an interactive overlay panel is clicked.

If you wish to track only a subset of these events, you can pass an array of VimeoEvents to the startVimeoTracking function:

window.snowplow('startVimeoTracking',  {
id,
video,
captureEvents: ['play', 'pause'],
})

Advanced usageโ€‹

As the Vimeo plugin uses Snowplow Media internally, for more granular control over events, you can utilise any of the functions provided by the Snowplow Media Plugin.

For example, if you wish to include additional behaviour when a video is paused, you can create callback on the pause event of an instance of a Vimeo player.

note

In the following example, ensure you aren't passing the pause event to the startVimeoTracking function, as this will result in the event being tracked twice.

const id = 'XXXXX'; // randomly generated ID

const video = new Vimeo.Player('vimeo-player', {
videoId: 'zSM4ZyVe8xs'
});

window.snowplow('startVimeoTracking', { id, video, captureEvents: ['play']});

video.on('pause', () => {
// Do something when the video is paused
window.snowplow('trackPauseEvent', { id });
});

Tracking advertising eventsโ€‹

Advertising events are not tracked automatically, but can be tracked using the trackAd* functions provided by Snowplow Media. For a full list of available functions, see the Snowplow Media Plugin documentation.

const id = 'XXXXX'; // randomly generated ID

const video = new Player('vimeo-player', {
videoId: 'zSM4ZyVe8xs'
});

window.snowplow('startVimeoTracking', { id, video });

...

// When your ad break starts
window.snowplow('trackMediaAdBreakStart', { id });

// When your ad break ends
window.snowplow('trackMediaAdBreakEnd', { id });

...

window.snowplow('endVimeoTracking', id);;
Was this page helpful?