Zype Legacy App Templates Upgrade Path to Analytics 3 Zype Legacy App Templates Upgrade Path to Analytics 3

Zype Legacy App Templates Upgrade Path to Analytics 3

We are excited to announce that a new analytics tool, Zype Analytics 3, will be available on Zype’s platform starting December 16th. This significant enhancement to our native video analytics offering will provide you with more powerful insights into video streaming performance and a unified, more detailed analytics view across all live and VOD experiences powered by Zype across web, playout, Native Mobile apps and OTT applications.

However, if you are using Zype Legacy App Templates to power your Mobile or OTT apps, you will need to perform the following steps to upgrade your apps to continue to send data to Zype and consume the power of this newly launched Analytics tool, Zype Analytics 3.

 

Applications

Apple iOS Mobile

Apple TV tvOS

Android Mobile and Android TV

Roku

videoJS (Web)

 

Apple iOS Mobile

Steps to upgrade to Analytics 3.0

 

VideoDetailViewController:- Method playStreamingVideo used to get player response data including “analytics” key data as well

ACAnalyticsManager:- This Manager class is used to initialize and log analytics data , initialize Zype Analytics 3 SDK here

 

 

 

 

 

Apple TV tvOS

Steps to upgrade to Analytics 3.0

PlayerVC and AnalyticsProtocolDelegate:- PlayerVC method setupVideoPlayer and AnalyticsProtocolDelegate method getAnalyticsFromResponse used to get player response data including “analytics” key data as well

AnalyticsManager:- This Manager class is used to initialize and log analytics data , initialize Zype Analytics 3 SDK here

       

 

Android Mobile and AndroidTV

Steps to upgrade to Analytics 3.0

            Look for following file and method inside the repository:

            File: PlayerViewModel inside player folder
            Method: createVideoPlayerListener

 

We can initialize Zype Analytics 3 SDK just below highlighted code in the file.

            

 

Roku

Steps to upgrade to Analytics 3.0

            Look for following file and method inside repository:

            File: main.brs inside source folder
            Method: playVideo

 

videoJS (Web)

Steps to upgrade to Analytics 3.0

 

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

 

Common configuration across platforms:

           
We will get Zype configuration in the player request response itself including the license key. No extra configuration is needed.

 

Sample player response:

 

Analytics 3 Field Mappings

Field Name Analytics Field Mapping Type Description
videoId video_id String Unique identifier for the video being played
title video_title String Title of the video being played
customUserId consumer_id String Unique identifier for the viewer, if applicable
isLive on_air String Flag (boolean) to denote if the video content is a live event or not
cdnProvider cdn String Name of the current cdn configuration of the content being delivered.
       
site_id customData1 String / ObjectID Unique identifier for the site
subscription_id customData2 String / ObjectID Unique identifier for the viewer's subscription
transaction_id customData3 String / ObjectID Unique identifier for the viewer's transaction
monetization_type customData4 String The monetization type used to watch the video, value values are:
subscription, purchase, rental, event, pass, redemption, registration, free
playlist_id customData5 String / ObjectID Unique identifier for the playlist of the currently playing asset (when applicable)
playlist_name customData6 String / ObjectID Name of the playlist of the currently playing asset (when applicable)
app_id customData7 String Application ID
app_name customData8 String Application Name
app_version customData9 String Application Version
player_name customData10 String Uniquely identified playerName
player_version customData11 String Player version
content_type customData12 String Catalog Type or from CMS:
VOD, Live, Playout
playout_channel_id customData13 String Playout channel ID for playout O&O analytics
playout_channel_name customData14 String Playout channel name for playout O&O analytics
playout_destination_id customData15 String Playout destination ID for playout O&O analytics
playout_destination_name customData16 String Playout destination name for playout O&O analytics
platform_source customData17 String specifies source platform of the asset: CMS, AC
external_user_id customData18 String Identifier for external user reference including SSO member_ids for users, or other external user identifier

 

Was this article helpful?

0 out of 0 found this helpful