Roku metadata keys

Metadata Name

Context Data Key

Constant Name

Advertiser

Campaign ID

Creative ID

Placement ID

Site ID

Creative URL

Constant

Description

Constant for Error source being Player

Constant

Description

Constant to set metadata on the MediaInfo trackLoad

Constant to set the ad metadata on the EventData trackEvent

Constant for sending a video-resumed heartbeat. To resume video tracking of previously stopped content, you need to set the MEDIA_RESUMED property on the mediaInfo object when you call mediaTrackLoad. (MEDIA_RESUMED is not an event that you can track using the mediaTrackEvent API.) MEDIA_RESUMED should be set to true when an application wants to continue to track content that a user stopped watching but now intends to resume watching.

For example, say a user watches 30% of the content, then closes the app. This will lead to the session being ended. Later, if the same user returns to the same content, and the application allows that user to resume from the same point where they left off, then the application should set MEDIA_RESUMED to “true” while calling the mediaTrackLoad API. The result is that these two different media sessions for the same video content can be linked together. Following is the implementation example:

mediaInfo =
  adb_media_init_mediainfo(
    "test_media_name",
    "test_media_id",
     10,
     "vod"
)
mediaInfo[ADBMobile().MEDIA_RESUMED] = true
mediaContextData = {}
ADBMobile().mediaTrackLoad(mediaInfo, mediaContextData)

This will create a new session for the video, but it also causes the SDK to send a heartbeat request with the event type “resume”, which can be used in reporting to tie two different media sessions together.