OpenTV Analytics Activities
The OpenTV Analytics Agent (otvaa) captures activities, and submits them to the User Activity Vault (UAV). A description of the activities can be found in Reporting activity and event metrics to UAV.
The otvaa wrapper eases the integration burden on the client application by capturing some of these activities automatically, and both the wrapper and agent help populate some of the metadata associated with each activity.
This page describes which activities will be automatically captured and submitted by the wrapper, and which metadata will be populated by the agent and wrapper.
The metadata population requirements have one of four values:
Metadata population requirement | Meaning |
---|---|
Client-supplied (not cached) | This metadata is expected, and should be populated by the client application. If the metadata is not populated, the data will be missing, but the continued operation of otvaa will not be adversely affected |
Client-supplied (will be cached) | The metadata should be populated by the client application, and will be cached by otvaa for use in other activities. If the metadata is not populated, then otvaa will be unable to automatically populate the corresponding “Cache-fill” metadata |
Cache-fill | The metadata will be automatically populated by otvaa, providing it was previously supplied in “Client-supplied (will be cached)” metadata. The client may still supply a value which will override the cached value for this activity |
Auto-fill | This metadata will be automatically populated by otvaa. The client may still supply a value which will override the auto-fill value for this activity |
The list of Activities below corresponds to the Activity’s name as defined on the UAV interface (see Reporting activity and event metrics to UAV) which do not apply a consistent naming convention. However, their corresponding Activities in the domain of the OTV Analytics Agent use the PascalCase
naming convention.
For more details of the Activity names refer to the API documentation of the relevant OTV Analytics Agent platform.
appStart
Metadata | Using Agent | Using Wrapper |
---|---|---|
| Client-supplied (will be cached) | Client-supplied (will be cached) |
| Auto-fill | Auto-fill |
appEnd
Metadata | Using Agent | Using Wrapper |
---|---|---|
| Cache-fill | Cache-fill |
| Auto-fill | Auto-fill |
playbackStart
Metadata | Using Agent | Using Wrapper |
---|---|---|
| Cache-fill | Cache-fill |
| Client-supplied (will be cached) | Client-supplied (will be cached) |
| Client-supplied (will be cached) | Client-supplied (will be cached) |
| Client-supplied (will be cached) | Client-supplied (will be cached) |
| Client-supplied (will be cached) | Client-supplied (will be cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
playbackStop
Metadata | Using Agent | Using Wrapper |
---|---|---|
| Cache-fill | Cache-fill |
| Cache-fill | Cache-fill |
| Cache-fill | Cache-fill |
| Cache-fill | Cache-fill |
| Cache-fill | Cache-fill |
| Client-supplied (not cached) | Auto-fill |
playbackPause
Do not submit this activity if using the wrapper API. This is automatically detected and submitted by the wrapper
Metadata | Using Agent |
---|---|
| Cache-fill |
| Cache-fill |
| Cache-fill |
| Cache-fill |
| Cache-fill |
| Client-supplied (not cached) |
playbackResume
Do not submit this activity if using the wrapper API. This is automatically detected and submitted by the wrapper
Metadata | Using Agent |
---|---|
| Cache-fill |
| Cache-fill |
| Cache-fill |
| Cache-fill |
| Cache-fill |
| Client-supplied (not cached) |
playbackSkipAhead
Do not submit this activity if using the wrapper API. This is automatically detected and submitted by the wrapper
Metadata | Using Agent |
---|---|
| Cache-fill |
| Cache-fill |
| Cache-fill |
| Cache-fill |
| Cache-fill |
| Client-supplied (not cached) |
| Client-supplied (not cached) |
playbackSkipBack
Do not submit this activity if using the wrapper API. This is automatically detected and submitted by the wrapper
Metadata | Using Agent |
---|---|
| Cache-fill |
| Cache-fill |
| Cache-fill |
| Cache-fill |
| Cache-fill |
| Client-supplied (not cached) |
| Client-supplied (not cached) |
privacyPolicy
Metadata | Using Agent | Using Wrapper |
---|---|---|
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
adDelivered
Metadata | Using Agent | Using Wrapper |
---|---|---|
| Cache-fill | Cache-fill |
| Cache-fill | Cache-fill |
| Client-supplied (will be cached) | Client-supplied (will be cached) |
| Client-supplied (will be cached) | Client-supplied (will be cached) |
| Client-supplied (will be cached) | Client-supplied (will be cached) |
adWatched
Metadata | Using Agent | Using Wrapper |
---|---|---|
| Cache-fill | Cache-fill |
| Cache-fill | Cache-fill |
| Cache-fill | Cache-fill |
| Cache-fill | Cache-fill |
| Cache-fill | Cache-fill |
adSkipped
Metadata | Using Agent | Using Wrapper |
---|---|---|
| Cache-fill | Cache-fill |
| Cache-fill | Cache-fill |
| Cache-fill | Cache-fill |
| Cache-fill | Cache-fill |
| Cache-fill | Cache-fill |
scheduleRecording
Metadata | Using Agent | Using Wrapper |
---|---|---|
| Cache-fill | Cache-fill |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
watch
Metadata | Using Agent | Using Wrapper |
---|---|---|
| Cache-fill | Cache-fill |
| Cache-fill | Cache-fill |
| Client-supplied (not cached) | Auto-fill |
| Cache-fill | Cache-fill |
| Cache-fill | Cache-fill |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
Playback_Metrics
Do not submit this activity if using the wrapper API. This is automatically detected and submitted by the wrapper
Metadata | Using Agent |
---|---|
| Cache-fill |
| Cache-fill |
| Client-supplied (not cached) |
| Client-supplied (not cached) |
| Cache-fill |
| Client-supplied (not cached) |
| Client-supplied (not cached) |
| Client-supplied (not cached) |
| Client-supplied (not cached) |
| Client-supplied (not cached) |
| Client-supplied (not cached) |
| Client-supplied (not cached) |
| Client-supplied (not cached) |
playerError
Metadata | Using Agent |
---|---|
| Cache-fill |
| Cache-fill |
| Cache-fill |
| Client-supplied (not cached) |
| Client-supplied (not cached) |
| Client-supplied (not cached) |
genericError
Metadata | Using Agent | Using Wrapper |
---|---|---|
| Cache-fill | Cache-fill |
| Cache-fill | Cache-fill |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
thirdPartyAppStart
Metadata | Using Agent | Using Wrapper |
---|---|---|
| Cache-fill | Cache-fill |
| Client-supplied (will be cached) | Client-supplied (will be cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
returnToLauncher
Metadata | Using Agent | Using Wrapper |
---|---|---|
| Cache-fill | Cache-fill |
| Cache-fill | Cache-fill |
deepLinkTriggered
Metadata | Using Agent | Using Wrapper |
---|---|---|
| Cache-fill | Cache-fill |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
downloadTriggered
Metadata | Using Agent | Using Wrapper |
---|---|---|
| Cache-fill | Cache-fill |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
railView
Metadata | Using Agent | Using Wrapper |
---|---|---|
| Cache-fill | Cache-fill |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
railSelection
Metadata | Using Agent | Using Wrapper |
---|---|---|
| Cache-fill | Cache-fill |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |
| Client-supplied (not cached) | Client-supplied (not cached) |