Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Standardising event types, introducing new attributes and updating documentation #76

Open
wants to merge 16 commits into
base: master
Choose a base branch
from

Conversation

bmendiratta137
Copy link

@bmendiratta137 bmendiratta137 commented Nov 28, 2024

IN PROGRESS, PLEASE DO NOT MERGE

This PR consists of 4 tasks:

  1. JIRA : NR-339475

Currently RokuVideo groups all actions related to content{video, ad} tracking and RokuSystem groups all actions related to system tracking. This task is for streamlining event-types{VideoAction, VideoErrorAction, VideoAdAction, VideoCustomAction} with other media streaming agents.

  • VideoAction groups actions related to content playing on Roku.
image
  • VideoErrorAction groups errors such as HTTP_ERROR, CONTENT_ERROR & AD_ERROR.
image
  • VideoAdAction groups actions related to ad playing on Roku.
image
  • VideoCustomAction groups actions related to custom events added by customer.

  • RokuVideo do not return anything.

image
  1. JIRA : NR-339476

As part of standardising event type and attribute management across all media streaming agents , some attributes have been added/updated which are not a part of RokuVideo/RokuSystem.

Event Type Added Attributes
VideoAction deviceName, deviceUuid, contentRenditionName, deviceSize, contentTitle, contentIsFullscreen, elapsedTime & bufferType
VideoAdAction elapsedTime
VideoErrorAction contentTitle & elapsedTime
  1. JIRA : NR-347311

The code changes add a function setUserId(userId) that takes a userId as a parameter and appends it to the attributes under a new attribute enduser.id.

  1. JIRA : NR-339480

Here I have made a new DATAMODEL.md for data model of event types and their attributes and updated the README.md

@bmendiratta137 bmendiratta137 changed the title NR-339475 Changing RokuVideo,RokuSystem to VideoAction, VideoErrorAction, VideoAdAction, VideoCustomAction NR-339475 Standardizing management or event type Dec 2, 2024
@bmendiratta137 bmendiratta137 changed the title NR-339475 Standardizing management or event type NR-339475 Standardising management for event type Dec 2, 2024
@bmendiratta137 bmendiratta137 marked this pull request as ready for review December 3, 2024 06:02
@mlychndnnr
Copy link

LGTM

@bmendiratta137 bmendiratta137 changed the title NR-339475 Standardising management for event type Standardising event types, introducing new attributes and updating documentation Dec 18, 2024
@@ -1062,6 +1152,7 @@ function nrAddVideoAttributes(ev as Object) as Object
ev.AddReplace("contentDuration", m.nrVideoObject.duration * 1000)
ev.AddReplace("contentPlayhead", m.nrVideoObject.position * 1000)
ev.AddReplace("contentIsMuted", m.nrVideoObject.mute)
ev.AddReplace("ContentIsfullscreen","true")

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

check attribute name, casing looks incorrect.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Corrected. Thanks

Copy link

@bhansa-nr bhansa-nr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants