Release Notes |
Data Points
Akamai AMP (iOS)
Events
- Custom Event - Add any user or system behavioral event to the Datazoom data stream. Requires custom coding on the page or in the app by customer developer.
- Datazoom Loaded - Signifies that the Datazoom SDK has been loaded and activated. At this point, the video player can be instantiated or custom events can be sent by the application.
- Media Loaded (Content) - Fired when the video is fully loaded into the player & ready to begin playback.
- Media Loaded (Google IMA) - Fired when the video is fully loaded into the player & ready to begin playback.
- Media Request (Google IMA) - Event signifies the video player requests the video from the server. The could be triggered by the user clicking on a play button of a thumbnail. If the video is played automatically, this may be fired when the player starts loading.
- Playback Complete (Google IMA) - This event signifies that the video player has reached the end of the currently playing content.
- Playback Start (Google IMA) - This event is fired when the video starts playing for the user, also known as First Frame.
- Playing (Google IMA) - The media is no longer blocked from playback, and has started playing. Fired when playback resumes from Stall, Buffering or Seek.
Fluxdata
- Playhead Position - Returns the current point in the video timeline in seconds.
- ASN - Autonomous System Number: a unique number identifying a group of IP networks that serves the content to the end-user. Client ASN as determined from a lookup of the client IP
- ASN Org - The organization that owns the Autonomous System Number. Often an ISP, sometimes a private company or institution.
- City - The city or town where the user is located
- Client IP Address - IP address of the user's device
- Country - Full name of the user's country
- Country Code - The country from which the browser initiated the event. For a list of country codes, see ISO 3166-1 alpha-2 .
- Custom Metadata - Customers can add any user or system data to the Datazoom data stream. Requires custom coding on the page or in the app by customer developer.
- Device ID - Unique identifier of the user's device.
- Device Manufacturer - Manufacturer of the user's device.
- Device Name - Name of the device model used by the viewer.
- Device Type - Describes the type of device category being used during the session such as phone, tablet, desktop, connected device, game console, etc.
- ISP - Name of the end-user's internet service provider.
- Latitude - Location information for the user
- Longitude - Location information for the user
- Media Type (Google IMA) - Specifies whether the event relates to an Ad or Content asset.
- Postal Code - The specific administrative division within a country where the event occurred. In the United States, zip codes correspond to postal region locator
- Region - The specific administrative division within a country where the event occurred. In the United States, regions correspond to state names ; for example, Washington or New York.
- Region Code - The specific administrative division within a country where the event occurred. In the United States, regions correspond to state codes ; for example, WA or NY.
- Source - Returns the URL of the current media file
- User Agent - Contains a number of tokens that refer to aspects of the user device, including the user's browser name and version, rendering engine, device’s model number, operating system and its version, etc.
Akamai AMP (tvOS)
Events
- Datazoom Loaded - Signifies that the Datazoom SDK has been loaded and activated. At this point, the video player can be instantiated or custom events can be sent by the application.
- City - The city or town where the user is located
- Configuration ID - Datazoom Collector configuration ID. Allows customers to differentiate data on the Connector from different Collectors. This could be useful for separating test content from production data.
- Country - Full name of the user's country
- Country Code - The country from which the browser initiated the event. For a list of country codes, see ISO 3166-1 alpha-2 .
- Device ID - Unique identifier of the user's device.
- Device Name - Name of the device model used by the viewer.
- ISP - Name of the end-user's internet service provider.
- Latitude - Location information for the user
- Longitude - Location information for the user
- OS Name - Operating System of the user's device
- OS Version - Version of Operating System being used during the session
- Postal Code - The specific administrative division within a country where the event occurred. In the United States, zip codes correspond to postal region locator
- Region - The specific administrative division within a country where the event occurred. In the United States, regions correspond to state names ; for example, Washington or New York.
- Region Code - The specific administrative division within a country where the event occurred. In the United States, regions correspond to state codes ; for example, WA or NY.
- Timestamp - Time of the event occurrence in Epoch UTC milliseconds.
Bitmovin (Android)
- App Session ID - Unique identifier for the user's current Datazoom session. Session will persist as long as the user is viewing content uninterrupted. A 20 minute pause in activity will close the session.
Bitmovin (iOS)
- App Session ID - Unique identifier for the user's current Datazoom session. Session will persist as long as the user is viewing content uninterrupted. A 20 minute pause in activity will close the session.
Bitmovin (Roku)
Events
- Ad Break End (Roku) - Fired at the end of an advertising break, signifies that the advertisements have ended and content is ready to resume.
- Ad Break Start (Roku) - Fired at the beginning of an advertising break, signifies that content has been delayed while the advertisements are played.
- Ad Impression (Roku) - Fired when an Ad impression is recorded by the video player.
Fluxdata
- Buffer Duration - Ads - Cumulative time that content has been buffering during ad playback in current Content Session.
- Number of Ad Plays - Running count of the number of ads played during the user's current session.
- Number of Errors - Running count of the number of errors that have occurred during the user's current session.
- Number of Errors - Content - Running count of the number of errors that have occurred while content is playing during the user's current session.
- Time Since Last Ad Break Start - Time interval since the current pod of advertisements began.
- Time Since Last Ad Completed - Time interval since the last advertisement completed.
- Time Since Last Ad Request - Time interval since advertisement was requested.
- Time Since Last Ad Started - Time interval since advertisement started playing.
- Time Since Last Buffer Start - Ad - Time interval since Buffer Start event began during advertisement playback.
- Time Since Last Milestone - Ad - Time interval since Milestone event was last sent for ad.
- Time Since Last Stall Start - Ad - Time interval since Stall Start event began during advertisement playback.
- Ad Break ID - UUID to denote the specific ad break. This can be used to tie events together that occurred during a specific ad break.
- Ad Duration - The length of the advertisement in seconds.
- Ad Position (Roku) - Where the ad appears in relation to the video content. Pre-roll ads run before the content, mid-roll ads run during the middle of the content & post-roll ads run after the content has completed streaming.
- Ad Session ID - A Datazoom generated UUID to denote the specific ad asset playback. This can be used to tie events together that occurred during a specific ad item.
- Milestone Percent (Ad) (Roku) - Number indicating the percentage milestone represented by the event fired. Attribute of Milestone events.
Brightcove
FluxData
- Playback Rate - The speed of the audio/video playback. Describes the speed that the video is played back to the user in relation to normal playback time. .5x, 1x, 1.5x, 2x
- Time Since Last Seek Start - Time interval since the occurrence of a Seek Start event.
- Time Since Last Stall Start - Time interval since Stall Start event began, reported in milliseconds. Value is reset to zero at the start of a new video View or when another Stall Start event occurs.
- Time Since Last Stall Start - Ad - Time interval since Stall Start event began during advertisement playback.
- Time Since Last Stall Start - Content - Time interval since Stall Start event began during content playback.
- Page Title - The title of the page from which the event originated.
- Page URL - The address of the page from which the event originated.
- Player Height - Height dimension in pixels of the current playback area.
- Player Width - Width dimension in pixels of the current playback area.
Dash.js
- Buffer Starvation (CMCD) - Key is included without a value if the buffer was starved at some point between the prior request and this object request, resulting in the player being in a rebuffering state and the video or audio playback being stalled. This key MUST NOT be sent if the buffer was not starved since the prior request. If the object type ‘ot’ key is sent along with this key, then the ‘bs’ key refers to the buffer associated with the particular object type. If no object type is communicated, then the buffer state applies to the current session.
- Content ID (CMCD) - A unique string identifying the current content.
- Playback Rate (CMCD) - 1 if real-time, 2 if double speed, 0 if not playing. SHOULD only be sent if not equal to 1.
- Startup (CMCD) - Key is included without a value if the object is needed urgently due to startup, seeking or recovery after a buffer-empty event. The media SHOULD not be rendering when this request is made. This key MUST not be sent if it is FALSE.
- Version (CMCD) - The version of the CMCD specification used for interpreting the defined key names and values.
ExoPlayer
Events
- Ad Break End (Google IMA) - Fired at the end of an advertising break, signifies that the advertisements have ended and content is ready to resume.
- Error (Content) - Thrown if an error occurs during content playback or retrieval of the video
- Media Loaded (Ad) (Google IMA) - Fired when the video is fully loaded into the player & ready to begin playback.
- Playback Complete (Ad) (Google IMA) - This event signifies that the video player has reached the end of the currently playing content.
- Playback Start (Ad) (Google IMA) - This event is fired when the video starts playing for the user, also known as First Frame.
- Playing (Ad) (Google IMA) - The media is no longer blocked from playback, and has started playing. Fired when playback resumes from Stall, Buffering or Seek.
- Resume (Content) - This event is fired when the user begins playing again after pausing the video during playback.
FluxData
- Current Subtitles - Identifies which available subtitle or closed captioning track has been selected by the user. Multiple captioning tracks are usually used for alternate languages. Values returned may vary by content publisher & player.
- Event Count - Incremental counter of the events generated during a user session. This field is valuable for ensuring proper sequencing of events and detecting any potential data loss.
- Number of Errors - Content - Running count of the number of errors that have occurred while content is playing during the user's current session.
- Stall Duration - Content - The cumulative amount of time elapsed where the user's playback of Content has been interrupted by an unexpected video stall due to buffer depletion.
- Time Since Content Started - Time interval since current content playback began.
- App Session ID - Unique identifier for the user's current Datazoom session. Session will persist as long as the user is viewing content uninterrupted. A 20 minute pause in activity will close the session.
- App Session Start Timestamp - Start time of the current user session
- Error Code (Content) - Error object representing a code explicitly identified by the player
- Error Message (Content) - Error object representing a message about the error explicitly identified by the player
- Media Type (Ad) (Google IMA) - Specifies whether the event relates to an Ad or Content asset.
- Source - Returns the URL of the current media file
HLS.js
Events
- Buffer End (Content) - Event is fired when video starts playing again after a buffer is completed.
- Buffer Start (Content) - Buffer Start identifies anytime the player has to wait for the video buffer to fill with video segments . This event includes all visible buffering activity including during playback startup, connectivity issues or buffering that may occur when resuming after seek or pause.
- Error (Content) - Thrown if an error occurs during content playback or retrieval of the video
- Milestone (Content) - Fired when the playheadPosition passes a predetermined percentile milestone of the video's duration. This event is used for both Ads & Content. Current milestones are fired at the 10, 25, 50, 75, 90 & 95 percentiles.
- Resume (Content) - This event is fired when the user begins playing again after pausing the video during playback.
- Stall End (Content) - Event fired when video starts playing again after a stall and the buffer has been replenished and playback resumes.
- Stall Start (Content) - Stall Start event is triggered when playback of video stops because the buffer has been depleted causing an unexpected interruption for the user.
Fluxdata
- Buffer Duration - Content - Cumulative time that content has been buffering during content playback in current Content Session.
- Content Session Start Timestamp - Start time of a new Content Session for the current user session. Typically a new Content Session begins with a Playback Request.
- Number of Content Plays - The amount of content assets that started playback during the current user app session.
- Number of Content Requests - The amount of content assets requested during the current user session.
- Playback Duration - Content - Cumulative time that content has been playing during the current video Content Session. Excludes time accrued while user pauses content or buffering.
- Stall Duration - Content - The cumulative amount of time elapsed where the user's playback of Content has been interrupted by an unexpected video stall due to buffer depletion.
- Time Since Content Request - Time interval since content playback was requested.
- Time Since Content Started - Time interval since current content playback began.
- Time Since Last Buffer Start - Content - Time interval since Buffer Start event began during content playback, reported in milliseconds. Value is reset to zero at the start of a new video View or when another Buffer Start event occurs.
- Time Since Last Milestone - Content - Time interval since Milestone event was last sent for content.
- Time Since Last Stall Start - Content - Time interval since Stall Start event began during content playback.
- Error Message (Content) - Error object representing a message about the error explicitly identified by the player
- Milestone Percent (Content) - Number indicating the percentage milestone represented by the event fired. Attribute of Milestone events.
- Startup Duration - Content - This timer represents the total time a user spent waiting for content to begin playback excluding any time related to requesting, loading or playing pre-roll ads.
HTML5
Events
- Cast End (Content) - Fired when a user ends streaming on a remote screen & returns playback to their local device.
- Cast Start (Content) - Fired when a user sends a stream from their local device to a remote screen.
- Casting - Is the player currently in casting mode where the content selected will be played on an external device?
Events
- Resume (Content) - This event is fired when the user begins playing again after pausing the video during playback.
- Ad Session ID - A Datazoom generated UUID to denote the specific ad asset playback. This can be used to tie events together that occurred during a specific ad item.
Roku
Fluxdata
- Rendition Video Bitrate - Target bitrate of the currently selected video rendition from the manifest. The manifest may contain multiple versions (i.e. renditions) of the video encoded at varying qualities to support varying network conditions.
tvOS
FluxData
- Current Subtitles - Identifies which available subtitle or closed captioning track has been selected by the user. Multiple captioning tracks are usually used for alternate languages. Values returned may vary by content publisher & player.
Video.js
Events
- Resume (Ad) (Google IMA) - This event is fired when the user begins playing again after pausing the video during playback.
- Resume (Content) - This event is fired when the user begins playing again after pausing the video during playback.
Fluxdata
- Playback Duration - Cumulative time that content & ads have been playing during the Content Session. Excludes time accrued while user pauses content or buffering.
- Playback Duration - Ads - Cumulative time that ads have been playing during the current Content Session. Excludes time accrued while user pauses content or buffering.
- Playback Rate - The speed of the audio/video playback. Describes the speed that the video is played back to the user in relation to normal playback time. .5x, 1x, 1.5x, 2x
- Time Since Last Seek Start - Time interval since the occurrence of a Seek Start event.
- Time Since Last Stall Start - Time interval since Stall Start event began, reported in milliseconds. Value is reset to zero at the start of a new video View or when another Stall Start event occurs.
- Time Since Last Stall Start - Ad - Time interval since Stall Start event began during advertisement playback.
- Time Since Last Stall Start - Content - Time interval since Stall Start event began during content playback.
- Page Title - The title of the page from which the event originated.
- Page URL - The address of the page from which the event originated.
- Player Height - Height dimension in pixels of the current playback area.
- Player Width - Width dimension in pixels of the current playback area.
- Server Timestamp Offset - Time difference between the client side timestamp and the server side timestamp in milliseconds. A negative offset value would indicate that the Client is ahead of the server.
|
---|
Comments
0 comments
Article is closed for comments.