Conviva JavaScript thePlatform Plugin Sensor Integration

4. Handle User Actions

Handle specific user actions such as:

• app backgrounding / foregrounding

• dialogues

• pin popups

• startover dialogues

• video slates and so on

Use the corresponding API as prescribed on the corresponding pages.

User Actions: Backgrounding

Conviva.Analytics.reportAppBackgrounded();

Conviva.Analytics.reportAppForegrounded();

User Actions: User Dialogue

User Dialogues such as:

• pin popup

• accepting strong language / violence

• confirming age

• startover / resume dialogue

convivaVideoAnalytics.reportPlaybackEvent(Conviva.Constants.USER_WAIT_STARTED);

convivaVideoAnalytics.reportPlaybackEvent(Conviva.Constants.USER_WAIT_ENDED);

Report Network Metrics

Metrics like connection type which is common for all the concurrent playback within one Analytics instance can be reported.

Conviva.Analytics.reportDeviceMetric(/* Conviva.Constants.Network / metricKey, / string */ metricValue):

• metricKey: Conviva.Constants.Network type key for reporting Network Metrics.

• metricValue: Value of the reported network metric.

Refer to the sample code mentioned below:

Conviva.Analytics.reportDeviceMetric(Conviva.Constants.Network.CONNECTION_TYPE, "WiFi");

The table below shows the representation string values for setting connection type:

Data Collection and User Preferences

By default, Conviva collects a set of data for better user analytics. However, the appropriate legal agreement with Conviva is required in order for Conviva to begin collecting data that would be considered PII, personal information, personal data or the like under applicable data privacy laws such as the General Data Protection Regulation (GDPR) and the California Consumer Privacy Act (CCPA). Further below in this document, there is a description of the user-preference APIs that control data collection, including opt-out and deletion of data, in compliance with data privacy laws. These APIs are in addition to existing, offline processes for opt-out and data deletion requests.

This document describes the identifiers that the libraries are capable of collecting, however actual collection of identifiers is contingent upon the customer's legal department providing written instructions to Conviva to begin collection. At the discretion of the customer's legal department, some or all of these identifiers may be collected. Conviva provides this flexibility to allow the customer to determine the precise identifiers to be collected.

Send unique identifier's data such as unique identifier for a device or user, for example deviceId, Mac address, advertisingIdentifier, and other identifiers, use the Conviva.Analytics.setUniqueIdentifier(/* object / identifiers, / function */ callback=):

• identifiers: JSON object with key value pairs of identifiers and values.

• callback: Optional callback function that needs to be notified if the identifiers were honored or collected by Conviva. Below mentioned are the sample result messages from Conviva:

"Data collection successful" "End-user chose to opt-out of personal data collection" "End-user used privacy settings and chose to opt-out of personal data collection"

Refer to the sample code mentioned below:

var identifiers = {};
identifiers["androidId"] = "xyzabd123cvqn";
Conviva.Analytics.setUniqueIdentifier(identifiers, function (msg) {
console.log("Result of the setUniqueIdentifier API:" + msg);
});

Control the data collection, set the user preference to collect or stop collecting PII data items using Conviva.Analytics.setUserPreferenceForDataCollection(/* object / identifiers, / boolean */forAllApps):

• identifiers: string key/value pair, where key indicates a probable data name and value is false/true. A value of false causes the SDK to stop collecting that specific data item.

• forAllApps: boolean value indicates if the preference applies to current app or all apps on the device. A value of true indicates all apps; false indicates only the current app.

Refer to the sample code mentioned below:

var identifiers = {};
identifiers["androidId"] = "false";
Conviva.Analytics.setUserPreferenceForDataCollection(identifiers, false);

Set the user preference to delete and stop collecting specific data items using Conviva.Analytics.setUserPreferenceForDataDeletion(/* object */ identifiers):

• identifiers: string key/value pair, where key indicates a probable data name and value is false/true. A value of false causes the SDK to stop collecting that specific data item.

Refer to the sample code mentioned below:

var identifiers = {};
identifiers["androidId"] = "true";
Conviva.Analytics.setUserPreferenceForDataCollection(identifiers);

Report Custom Events

Player Insight is an advanced feature which allows you to track custom events that are not related to video rendering, but rather specific to your player's functionality. These events and their attributes are then tabulated in the Player Insight dashboard at Conviva VSI (Pulse). Contact your Conviva representative to enable Player Insights in Pulse.

You may send a custom Player Insight event that can be associated with a video playback using the following method:

Report video-related events by the method videoAnalytics.reportPlaybackEvent(/* string / eventType, / object */ eventDetail=):

• eventType: Mandatory argument of event type of the video player event of string type.

• eventDetail: Optional argument of event details of the video player event of object type.

// Sample code snippet illustrating event on explicit change of video quality in the player for video
var eventType = "fullscreen";
var attr = {};
attr["old_quality"] = "SD";
attr["new_quality"] = "HD";
attr["player"] = "WEB player";

convivaVideoAnalytics.reportPlaybackEvent(eventType, attr);

Report app-level events by the method Conviva.Analytics.reportAppEvent(/* string / eventType, / object */ eventDetail=):

• eventType: Mandatory argument of event type of the app event of string type.

• eventDetail: Optional argument of event details of the app event of object type.

/ Sample for "share-click" event with 3 arguments
var eventType = "share-click";
var attr = {};
attr["location"] =  "Toolbar";
attr["assetName"] = "Sample Video";
attr["shareService"] = "Facebook";
Conviva.Analytics.reportAppEvent(eventType, attr);

5. Cleanup

When the video playback ends, thePlatform Plugin cleans up videoAnalytics, adAnalytics and cleans up Conviva SDK on pdk player event OnPlayerDestroyed event which is raised when player gets destroyed.

Limitations

Known Conviva thePlatform Plugin limitations:

Self Validation

Upon completion of your integration, and before submission to Conviva QA team, developers should complete a comprehensive self-validation test pass of each Device Application.

Conviva provides sample test cases with detailed steps and expected results.

Developers should be checking for both metric and metadata accuracy. Based on our experience, comprehensive self-validation can reduce your QE cycles, saving your costly project time.