Zype Legacy App Templates Upgrade Path to Analytics 3 Zype Legacy App Templates Upgrade Path to Analytics 3
  1. Zype
  2. Analytics
  3. Analytics 3

Zype Legacy App Templates Upgrade Path to Analytics 3

We’re excited to roll out Zype Analytics 3 — a powerful, unified analytics tool launching on December 16th. This upgraded analytics system provides enhanced insight into video performance across Live and VOD content, supporting all major platforms: Web, Mobile, OTT, and Playout.

To take advantage of Analytics 3, customers using Zype’s Legacy App Templates will need to update their applications to support the new analytics beaconing flow.

 

Zype Analytics 3 introduces:

  • Real-time, session-level insights

  • Unified event taxonomy across VOD, Live, and Playout

  • Support for richer metadata including monetization, playout, and platform attribution

To enable Analytics 3, you’ll need to:

  1. Extract the analytics payload from the player response.

  2. Pass that payload into the Zype Analytics 3 SDK.

  3. Send beacons during playback events like play, pause, complete, error.

 

Applications

Apple iOS Mobile

Apple TV tvOS

Android Mobile and Android TV

Roku

videoJS (Web)

 

Platform-Specific Upgrade Instructions

Apple iOS

Files to Modify

  • VideoDetailViewController.swift

    • Locate the playStreamingVideo method.

    • Ensure you parse the analytics key from the player response.

SDK Integration

  • Use ACAnalyticsManager.swift:

    • Initialize the Analytics 3 SDK during view setup.

    • Send playback event data using the parsed analytics payload.


Apple tvOS

Files to Modify

  • PlayerVC.swift

    • Modify setupVideoPlayer() to extract the analytics object from the player response.

  • AnalyticsProtocolDelegate.swift

    • Implement getAnalyticsFromResponse() to map values.

SDK Integration

  • Use AnalyticsManager.swift:

    • Initialize the Zype Analytics 3 SDK.

    • Log key events (start, pause, complete, error).


Android Mobile and Android TV

Files to Modify

  • PlayerViewModel.kt

    • Inside the player folder, locate the createVideoPlayerListener() method.

    • Extract the analytics payload from the player metadata.

SDK Integration

  • Just below the highlighted player setup code, initialize the Analytics 3 SDK and begin sending playback events using the payload data.


Roku

Files to Modify

  • main.brs inside the source/ folder

    • Modify the playVideo() function to extract analytics metadata from the stream response.

SDK Integration

  • Pass values into the Analytics 3 library if integrated, or beacon manually using roUrlTransfer.


Web / VideoJS

javascript
import { VideojsAdapter } from 'zype-analytics'; const player = videojs('my-video', vjsOptions); const analytics = new VideojsAdapter(analyticsConfig, player);

Note: analyticsConfig should be derived from the analytics key in the player response. No additional config is required; the license key is included in the response.


Common Configuration Notes

  • Player response includes all required analytics configuration including the license key.

  • SDK initialization requires no manual configuration outside of injecting the response data.

  • Analytics beacons will fire on playback lifecycle events, not on actions outside of the player.


Sample Analytics Field Mappings

Field Name Analytics Field Type Description
videoId video_id String Video ID
title video_title String Title of video
customUserId consumer_id String Viewer ID
isLive on_air Boolean Is live stream
cdnProvider cdn String CDN name
site_id customData1 ObjectID Site ID
subscription_id customData2 ObjectID Subscription ID
transaction_id customData3 ObjectID Transaction ID
monetization_type customData4 String Monetization type (subscription, purchase, etc.)
playlist_id customData5 ObjectID Playlist ID
playlist_name customData6 String Playlist name
app_id customData7 String Application ID
app_name customData8 String Application Name
app_version customData9 String Application Version
player_name customData10 String Player name
player_version customData11 String Player version
content_type customData12 String VOD, Live, or Playout
playout_channel_id customData13 String Playout channel ID
playout_channel_name customData14 String Playout channel name
playout_destination_id customData15 String Playout destination ID
playout_destination_name customData16 String Playout destination name
platform_source customData17 String CMS or Apps Creator
external_user_id customData18 String SSO or external identifier

Need Help?

If you need assistance updating your app or validating your integration, please reach out to your Zype Customer Success Manager or support@zype.com.

Was this article helpful?

0 out of 0 found this helpful

Articles in this section