Skip to content

Version 5.3.0
Compare
Choose a tag to compare
@matus-tomlein matus-tomlein released this 30 Jun 13:47
· 87 commits to master since this release
5.3.0
b2748c4

This release brings the new media tracking APIs and improvements in remote configuration!

The media tracking APIs enable tracking of media events from video or audio playback. They provide the following key features:

  1. Integrate with any media player: Instead of integrating with a specific media player, the plugin provides universal media tracking APIs that can be utilized to track media events regardless of the media player being used to play the content.
  2. Media session tracking: The plugin adds a new media session context entity to tracked events that identifies the media playback. The entity also adds statistics calculated using edge analytics on the tracker such as the time spent playing, buffering or the number of ads played.
  3. Support for tracking live video: With the addition of media ping events, the plugin now supports periodically tracking the progress within a live streamed video. The media ping events are fired periodically when the media is being played with configurable frequency and settings. Moreover, the plugin also makes sure that page ping events are being tracked during playback even if the user is not interacting with the page.
  4. Tracking ads during playback: The plugin provides out-of-the-box events and entities for tracking ads within linear, non-linear and companion ad breaks during playback.
  5. New media event schemas: The tracked events follow new schemas with additional properties. New events and entities for data quality and error tracking have been added.
  6. Customizable: The plugin supports tracking custom media events and custom entities to meet your specific requirements.
  7. AVPlayer auto-tracking: The plugin provides APIs to auto-track media events from the AVPlayer media player.

Here is an example of how to track media events on iOS:

let id = "XXXXX"
let tracker = Snowplow.defaultTracker()

// Initialize the media tracking identified by the `id`. It will start tracking media ping events.
let mediaTracking = tracker.media.startMediaTracking(id: id)
// Track a media play event within the media tracking.
mediaTracking.track(MediaPlayEvent())
// Update the current playback position without tracking any events.
mediaTracking.update(player: MediaPlayerEntity().currentTime(10.0))
// Track the start of an ad.
let ad = MediaAdEntity(adId: "1234").name("Podcast Ad").duration(15)
mediaTracking.track(MediaAdStartEvent(), ad: ad)
// End and clear the state for the media tracking.
tracker.media.endMediaTracking(id: id)

The release also brings improvements in the remote configuration. It adds support for configuring emitter configuration through remote configuration. It also respects default configuration for properties that are not configured through remote configuration.

Enhancements

  • Add media controller with APIs to track media events (#765)
  • Add emitter configuration support to remote configuration (#782)
  • Use default configuration for properties that are not configured using remote configuration (#785)

Bug fixes

  • Truncate URL scheme for page_url and page_refr properties (#793)
  • Truncate language in platform context entity to max 8 characters (#795)
  • Fix emit range configuration in Emitter not respected if using SQLite event store (#789)
Assets 2
Loading