Package com.nagra.otvaa.sdk

Class OtvAnalyticsAgent

java.lang.Object

com.nagra.otvaa.sdk.OtvAnalyticsAgent

public class OtvAnalyticsAgent
extends Object

This class is the main interface for the OpenTV Analytics Agent

It handles event (activity) information provided by the application, validates the data, and converts this information to messages to pre-configured back-end endpoints - UAV and / or DWH.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OtvAnalyticsAgent.OtvAaReportListener	An interface for listeners to handle reports and errors

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_KEY_ACCOUNT_ID
static final String	JSON_KEY_ACTIVITY_DATE_TIME
static final String	JSON_KEY_AD_ID
static final String	JSON_KEY_AD_SUPPLIER
static final String	JSON_KEY_APP_NAME
static final String	JSON_KEY_APP_REFERENCE
static final String	JSON_KEY_APP_SESSION_ID
static final String	JSON_KEY_APP_VERSION
static final String	JSON_KEY_AVAILABLE_BITRATE
static final String	JSON_KEY_AVG_DOWNLOAD_BITRATE
static final String	JSON_KEY_BITRATE_SELECTED
static final String	JSON_KEY_BUFFER_DURATION
static final String	JSON_KEY_BYTES_DOWNLOADED
static final String	JSON_KEY_CONFIG
static final String	JSON_KEY_CONSENT_FOR_TARGETTED_AD
static final String	JSON_KEY_CONTENT_SOURCE
static final String	JSON_KEY_CONTENT_TYPE
static final String	JSON_KEY_CONTENT_URI
static final String	JSON_KEY_DEEP_LINK_ID
static final String	JSON_KEY_DEEP_LINK_PROVIDER_ID
static final String	JSON_KEY_DEPTH
static final String	JSON_KEY_DESTINATIONS
static final String	JSON_KEY_DEVICE_ID
static final String	JSON_KEY_DEVICE_TYPE
static final String	JSON_KEY_DROPPED_FRAMES
static final String	JSON_KEY_EDITORIAL_ID
static final String	JSON_KEY_ERROR_CODE
static final String	JSON_KEY_ERROR_MSG
static final String	JSON_KEY_HDEPTH
static final String	JSON_KEY_KEY
static final String	JSON_KEY_METADATA
static final String	JSON_KEY_NAME
static final String	JSON_KEY_PLAYBACK_PROGRESS
static final String	JSON_KEY_PLAYBACK_SESSION_ID
static final String	JSON_KEY_PLAYER_TYPE_VERSION
static final String	JSON_KEY_POLICY_CONSENT_GIVEN
static final String	JSON_KEY_POLICY_SHOWN
static final String	JSON_KEY_POLICY_TYPE
static final String	JSON_KEY_POSITION
static final String	JSON_KEY_PROGRAMME_ID
static final String	JSON_KEY_PROVIDER_RESOURCE_ID
static final String	JSON_KEY_RAIL_ID
static final String	JSON_KEY_SECTION_ID
static final String	JSON_KEY_SERIES_ID
static final String	JSON_KEY_SERIES_LINK
static final String	JSON_KEY_SOURCE
static final String	JSON_KEY_START_POSITION
static final String	JSON_KEY_STOP_POSITION
static final String	JSON_KEY_STREAM_BITRATE
static final String	JSON_KEY_TECHNICAL_ID
static final String	JSON_KEY_TEMPLATE_ID
static final String	JSON_KEY_TIMESTAMP
static final String	JSON_KEY_TOKEN
static final String	JSON_KEY_TOTAL_FRAMES
static final String	JSON_KEY_TRACKING_ASSET_ID
static final String	JSON_KEY_UAV
static final String	JSON_KEY_URL
static final String	JSON_KEY_USER_ID
static final String	JSON_KEY_VDEPTH

Constructor Summary

Constructors

Constructor	Description
OtvAnalyticsAgent(Context xContext)	constructor for OtvAnalyticsAgent.

Method Summary

Modifier and Type	Method	Description
void	addReportListener(OtvAnalyticsAgent.OtvAaReportListener xReportListener)	Add a listener to the list of report listeners handling errors and reports
OtvAaError	appStart(JSONObject xMetadata)	Submit the appStart Activity
void	close()	Close the analytics session.
OtvAaError	initialise(JSONObject xAgentConfig, OtvAnalyticsAgent.OtvAaReportListener xReportListener)	Initialise the OpenTv Analytics Agent
boolean	isInitialised()	Check if the agent is initialised The agent is considered initialised if the desitnation endpoints have been configured correctlu.
void	onActivityReport(String xActivityName, String xUrl, String xMetadata, int xHttpResponse, String xResponse)	hidden
void	removeAllReportListeners()	Remove all listeners handling errors and reports
void	removeReportListener(OtvAnalyticsAgent.OtvAaReportListener xReportListener)	Remove a specific listener from the list of report listeners handling errors and reports
OtvAaError	submitActivity(OtvActivity xActivity, JSONObject xMetadata)	Submit an activity appStart activity should not be submitted using this method
OtvAaError	updateConfig(JSONObject xAgentConfig)	Provide an updated configuration The configuration object should only contain the updated attributes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

JSON_KEY_ACCOUNT_ID

public static final String JSON_KEY_ACCOUNT_ID

See Also:

• Constant Field Values

JSON_KEY_ACTIVITY_DATE_TIME

public static final String JSON_KEY_ACTIVITY_DATE_TIME

See Also:

• Constant Field Values

JSON_KEY_AD_ID

public static final String JSON_KEY_AD_ID

See Also:

• Constant Field Values

JSON_KEY_AD_SUPPLIER

public static final String JSON_KEY_AD_SUPPLIER

See Also:

• Constant Field Values

JSON_KEY_APP_NAME

public static final String JSON_KEY_APP_NAME

See Also:

• Constant Field Values

JSON_KEY_APP_VERSION

public static final String JSON_KEY_APP_VERSION

See Also:

• Constant Field Values

JSON_KEY_APP_SESSION_ID

public static final String JSON_KEY_APP_SESSION_ID

See Also:

• Constant Field Values

JSON_KEY_APP_REFERENCE

public static final String JSON_KEY_APP_REFERENCE

See Also:

• Constant Field Values

JSON_KEY_AVAILABLE_BITRATE

public static final String JSON_KEY_AVAILABLE_BITRATE

See Also:

• Constant Field Values

JSON_KEY_AVG_DOWNLOAD_BITRATE

public static final String JSON_KEY_AVG_DOWNLOAD_BITRATE

See Also:

• Constant Field Values

JSON_KEY_BITRATE_SELECTED

public static final String JSON_KEY_BITRATE_SELECTED

See Also:

• Constant Field Values

JSON_KEY_BUFFER_DURATION

public static final String JSON_KEY_BUFFER_DURATION

See Also:

• Constant Field Values

JSON_KEY_BYTES_DOWNLOADED

public static final String JSON_KEY_BYTES_DOWNLOADED

See Also:

• Constant Field Values

JSON_KEY_CONFIG

public static final String JSON_KEY_CONFIG

See Also:

• Constant Field Values

JSON_KEY_CONSENT_FOR_TARGETTED_AD

public static final String JSON_KEY_CONSENT_FOR_TARGETTED_AD

See Also:

• Constant Field Values

JSON_KEY_CONTENT_SOURCE

public static final String JSON_KEY_CONTENT_SOURCE

See Also:

• Constant Field Values

JSON_KEY_CONTENT_TYPE

public static final String JSON_KEY_CONTENT_TYPE

See Also:

• Constant Field Values

JSON_KEY_CONTENT_URI

public static final String JSON_KEY_CONTENT_URI

See Also:

• Constant Field Values

JSON_KEY_DEEP_LINK_ID

public static final String JSON_KEY_DEEP_LINK_ID

See Also:

• Constant Field Values

JSON_KEY_DEEP_LINK_PROVIDER_ID

public static final String JSON_KEY_DEEP_LINK_PROVIDER_ID

See Also:

• Constant Field Values

JSON_KEY_DEPTH

public static final String JSON_KEY_DEPTH

See Also:

• Constant Field Values

JSON_KEY_DESTINATIONS

public static final String JSON_KEY_DESTINATIONS

See Also:

• Constant Field Values

JSON_KEY_DEVICE_ID

public static final String JSON_KEY_DEVICE_ID

See Also:

• Constant Field Values

JSON_KEY_DEVICE_TYPE

public static final String JSON_KEY_DEVICE_TYPE

See Also:

• Constant Field Values

JSON_KEY_DROPPED_FRAMES

public static final String JSON_KEY_DROPPED_FRAMES

See Also:

• Constant Field Values

JSON_KEY_EDITORIAL_ID

public static final String JSON_KEY_EDITORIAL_ID

See Also:

• Constant Field Values

JSON_KEY_ERROR_CODE

public static final String JSON_KEY_ERROR_CODE

See Also:

• Constant Field Values

JSON_KEY_ERROR_MSG

public static final String JSON_KEY_ERROR_MSG

See Also:

• Constant Field Values

JSON_KEY_HDEPTH

public static final String JSON_KEY_HDEPTH

See Also:

• Constant Field Values

JSON_KEY_KEY

public static final String JSON_KEY_KEY

See Also:

• Constant Field Values

JSON_KEY_METADATA

public static final String JSON_KEY_METADATA

See Also:

• Constant Field Values

JSON_KEY_NAME

public static final String JSON_KEY_NAME

See Also:

• Constant Field Values

JSON_KEY_PLAYBACK_PROGRESS

public static final String JSON_KEY_PLAYBACK_PROGRESS

See Also:

• Constant Field Values

JSON_KEY_PLAYBACK_SESSION_ID

public static final String JSON_KEY_PLAYBACK_SESSION_ID

See Also:

• Constant Field Values

JSON_KEY_PLAYER_TYPE_VERSION

public static final String JSON_KEY_PLAYER_TYPE_VERSION

See Also:

• Constant Field Values

JSON_KEY_POLICY_CONSENT_GIVEN

public static final String JSON_KEY_POLICY_CONSENT_GIVEN

See Also:

• Constant Field Values

JSON_KEY_POLICY_SHOWN

public static final String JSON_KEY_POLICY_SHOWN

See Also:

• Constant Field Values

JSON_KEY_POSITION

public static final String JSON_KEY_POSITION

See Also:

• Constant Field Values

JSON_KEY_POLICY_TYPE

public static final String JSON_KEY_POLICY_TYPE

See Also:

• Constant Field Values

JSON_KEY_PROGRAMME_ID

public static final String JSON_KEY_PROGRAMME_ID

See Also:

• Constant Field Values

JSON_KEY_PROVIDER_RESOURCE_ID

public static final String JSON_KEY_PROVIDER_RESOURCE_ID

See Also:

• Constant Field Values

JSON_KEY_RAIL_ID

public static final String JSON_KEY_RAIL_ID

See Also:

• Constant Field Values

JSON_KEY_SECTION_ID

public static final String JSON_KEY_SECTION_ID

See Also:

• Constant Field Values

JSON_KEY_SERIES_LINK

public static final String JSON_KEY_SERIES_LINK

See Also:

• Constant Field Values

JSON_KEY_SERIES_ID

public static final String JSON_KEY_SERIES_ID

See Also:

• Constant Field Values

JSON_KEY_START_POSITION

public static final String JSON_KEY_START_POSITION

See Also:

• Constant Field Values

JSON_KEY_SOURCE

public static final String JSON_KEY_SOURCE

See Also:

• Constant Field Values

JSON_KEY_STOP_POSITION

public static final String JSON_KEY_STOP_POSITION

See Also:

• Constant Field Values

JSON_KEY_STREAM_BITRATE

public static final String JSON_KEY_STREAM_BITRATE

See Also:

• Constant Field Values

JSON_KEY_TECHNICAL_ID

public static final String JSON_KEY_TECHNICAL_ID

See Also:

• Constant Field Values

JSON_KEY_TEMPLATE_ID

public static final String JSON_KEY_TEMPLATE_ID

See Also:

• Constant Field Values

JSON_KEY_TIMESTAMP

public static final String JSON_KEY_TIMESTAMP

See Also:

• Constant Field Values

JSON_KEY_TOKEN

public static final String JSON_KEY_TOKEN

See Also:

• Constant Field Values

JSON_KEY_TOTAL_FRAMES

public static final String JSON_KEY_TOTAL_FRAMES

See Also:

• Constant Field Values

JSON_KEY_TRACKING_ASSET_ID

public static final String JSON_KEY_TRACKING_ASSET_ID

See Also:

• Constant Field Values

JSON_KEY_UAV

public static final String JSON_KEY_UAV

See Also:

• Constant Field Values

JSON_KEY_URL

public static final String JSON_KEY_URL

See Also:

• Constant Field Values

JSON_KEY_USER_ID

public static final String JSON_KEY_USER_ID

See Also:

• Constant Field Values

JSON_KEY_VDEPTH

public static final String JSON_KEY_VDEPTH

See Also:

• Constant Field Values

Constructor Details

OtvAnalyticsAgent

public OtvAnalyticsAgent(@NonNull
 Context xContext)

constructor for OtvAnalyticsAgent.

Parameters:

xContext - the context of application

Method Details

initialise

public OtvAaError initialise(@NonNull
 JSONObject xAgentConfig,
 @NonNull
 OtvAnalyticsAgent.OtvAaReportListener xReportListener)

Initialise the OpenTv Analytics Agent

Call this method once, before calling any other

Do not call again unless close is called first

Typical configuration { "destinations" : [ { "name" : "uav", // Only 'uav' and 'dwh' are valid names "config" : { "url" : "https://path.to.uav/apis", "token" : "tokenINBase64JWT==" } }, { "name" : "dwh", "url" : "https://path.to.dwh/apis" } ] "appVersion" : "1.0.0" }

Parameters:

xAgentConfig - configuration data defining destination endpoints and a possible UAV token and optional appVersion

xReportListener - Reference for listener to handle reports and errors

Returns:

OtvAaError.OK if successful, another error enumeration otherwise

close

public void close()

Close the analytics session. After calling this method, do not call any other unless initialis() is called again

updateConfig

public OtvAaError updateConfig(@NonNull
 JSONObject xAgentConfig)

Provide an updated configuration The configuration object should only contain the updated attributes. Not all attributes may be updated - only token, userId and accountId attributes refresh are accepted. Other attributes are ignored.

Parameters:

xAgentConfig - configuration

Returns:

OtvAaError.OK if successful, another error enumeration otherwise

appStart

public OtvAaError appStart(@Nullable
 JSONObject xMetadata)

Submit the appStart Activity

Must be the first activity submitted (must be called before any other calls to submitActivity(com.nagra.otvaa.sdk.OtvActivity, org.json.JSONObject))

Should not be called again without first submitting an appEnd activity

Typical appStart metadata: "appSessionId" : "<UUID>", "activityDateTime": "2020-03-20T10:53:19Z"

Parameters:

xMetadata - Containing key-value pairs of metadata for the appStart activity

Returns:

OtvAaError.OK if successful, another error enumeration otherwise

submitActivity

public OtvAaError submitActivity(@NonNull
 OtvActivity xActivity,
 @Nullable
 JSONObject xMetadata)

Submit an activity appStart activity should not be submitted using this method

Parameters:

xActivity - The activity being submitted

xMetadata - Containing key-value pairs of metadata for the submitted activity

Returns:

OtvAaError.OK if successful, another error enumeration otherwise

isInitialised

public boolean isInitialised()

Check if the agent is initialised The agent is considered initialised if the desitnation endpoints have been configured correctlu.

Returns:

true if initialised, false otherwise

addReportListener

public void addReportListener(@NonNull
 OtvAnalyticsAgent.OtvAaReportListener xReportListener)

Add a listener to the list of report listeners handling errors and reports

Parameters:

xReportListener - an instance / implementation of OtvAnalyticsAgent.OtvAaReportListener

removeReportListener

public void removeReportListener(@NonNull
 OtvAnalyticsAgent.OtvAaReportListener xReportListener)

Remove a specific listener from the list of report listeners handling errors and reports

Parameters:

xReportListener - the listener instance to remove from list

removeAllReportListeners

public void removeAllReportListeners()

Remove all listeners handling errors and reports

onActivityReport

public void onActivityReport(@NonNull
 String xActivityName,
 @NonNull
 String xUrl,
 @NonNull
 String xMetadata,
 int xHttpResponse,
 @NonNull
 String xResponse)

hidden