Nagra OTV Analytics Javascript Agent

Nagra OTV Analytics Javascript Agent

Class: OtvActivity

OtvActivity

Enumeration of activities

eg OtvActivity.PlaybackStart

Activities have names (used in the messages to the end-points).

Activities have destinations (not all activities are sent to all end-points).

(At the moment all activities are only sent to UAV, but in future this will change).

OtvActivity.PlaybackPause.name ("playbackPause")
OtvActivity.PlaybackStart.destinations (["uav", "dwh"])
if (myActivity instanceof OtvActivity) { ... }

Unfortunately this style of enumeration is not iterable.

Note: There are subtle naming conventions in the API:

  • UAV API names do not have a consistent naming convention mixing camelCase, sometimes PascalCase, sometimes snake_case.
  • the OTVAa API ALWAYS uses PascalCase for consistency with the other platforms.

Note: There is no need for the integrator to call new on this class as it handled internally to the SDK.

new OtvActivity()

Classes

OtvActivity

Members

AdDelivered

Ad delivered in a stream. Capture adverts that are delivered, useful for reference if the user skips the ad.

AdSkipped

Skipping adverts where allowed. Capture the action of skipping an ad where allowed.

AdWatched

Completion of viewing a delivered advert. For ad tracking, allows the client to capture data on the adverts watched by the user.

AppEnd

When app is shut down or times out due to inactivity.

AppStart

When app starts up.

DeepLinkTriggered

To be created when a deep linked asset is selected via the client. Clicking through to watch content from a Rail or other client source on a deep link provider.

DownloadTriggered

To be created when content is downloaded for watching off line, aka D2G. Capture the action when a user triggers the download of content.

GenericActivity

GenericActivity activity

GenericError

GenericError activity

PlaybackMetrics

To be reported back at a consistent interval, this can be configured by clients. We recommend recording this activity every 60 seconds. Metrics as supplied by the player and reported back via the client.

PlaybackPause

User pauses playout.

PlaybackResume

PlaybackResume activity

PlaybackSkipAhead

Fast forward or drag timeline forward. Covering fast forward or skip, allowing the tracking of the start point and the endpoint when playback resumes.

PlaybackSkipBack

Rewind or drag timeline backward. Covering rewind or skip back, allowing the tracking of the start point and the endpoint when playback resumes.

PlaybackStart

Start of playback.

PlaybackStop

User stops playback either with stop action or browsing away from playout.

PlayerError

Log client side errors as required. Where required, useful to capture basic error information that relates to the user experience.

PrivacyPolicy

Allows the client to capture the user's consent and related information in relation to any local or global policy.

RailSelection

Created when a user selects a Rail item to open the media card/more detail.

RailView

Created when the Rail is shown on the screen (user engagement measure).

ReturnToLauncher

To be created when the launcher becomes the active app.

ScheduleRecording

User triggers a recording to be created on OPF.

ThirdPartyAppStart

To be created when a third-party application is triggered/opened on the launcher. Capture the act of starting a third-party application due to a deep link or the client acting as a launcher (Netflix, Prime, etc.).

Watch

Created when the user clicks the play option on content. Current activity that is reported on first playback.