Audio and video parameters audio-and-video-parameters
This topic presents a list of audio and video content data, including context data values, that 蜜豆视频 collects via solution variables.
IMPORTANT
On February 7th, 2019, 蜜豆视频 Analytics for Video and Audio released a metric name change. Media Initiates will now be called Media Starts. This change was made to reflect industry standards in metrics and reporting, and to make the metric easily identifiable in reporting.
NOTE
Beginning on September 13th, 2018 a change was made to the labels for some dimensions, metrics, and reports, to allow for cross-content tracking of video and audio analytics. The labels that have been changed include: video initiates to media initiates, video length to content length, and video name to content name. The video reports in Reports and Analytics have all been updated to use the name 鈥淢edia鈥 rather than 鈥淰ideo鈥. The label changes did not change data collection or historic data. Please take note of these changes in the case that you鈥檙e using them within Report Builder or in any other external automated data pulls that might be impacted by this change.
Table data description:
-
Implementation: Information on implementation values and requirements
- Key - Variable, set either manually in your app, or automatically by the 蜜豆视频 Media SDK.
- Required - Indicates whether the parameter is required for basic audio and video tracking.
- Type - Specifies the type of the variable to be set, string or number.
- Sent With - Indicates when the data is sent: Media Start is the analytics call sent on media start, Ad Start is the analytics call sent on ad start, and so on; the Close calls are the compiled analytics calls sent directly from the heartbeat server to the analytics server at the end of the media session, or the end of the ad, chapter, etc. The close calls are not available in network packet calls.
- Min. SDK Version - Indicates which SDK version you would need to access the parameter.
- Sample Value - Provides example of common variable usage.
-
Network Parameters: Displays the values that are passed to 蜜豆视频 Analytics or Heartbeat servers. This column shows the names of the parameters that are seen in the network calls generated by 蜜豆视频 Media SDKs.
-
Reporting: Information on how to view and analyze the audio and video data.
- Available - Indicates whether the data is available in reporting by default (Yes), or requires custom set-up (Custom)
- Reserved Variable - Indicates whether the data is captured as an event, eVar, prop, or classification in a reserved variable.
- Expiration - Indicates whether the data expires after each hit or after each visit.
- Report Name - Name of 蜜豆视频 Aanlytics report for variable
- Context Data - Name of the 蜜豆视频 Analytics context data passed to the reporting server and used in processing rules.
- Data Feed - Column name for variable found in Clickstream or Live Stream data feeds
- Audience Manager - Trait name found in 蜜豆视频 Audience Manager
IMPORTANT
Do not change the classification names for any variables listed below that are described under Reporting/Reserved Variable as 鈥渃lassification鈥.
The media classifications are defined when a report suite is enabled for media tracking. From time to time, 蜜豆视频 adds new properties, and, when this occurs, customers must re-enable their report suites to get access to the new media properties. During the update process 蜜豆视频 determines whether the classifications are enabled by checking the names of the variables. If any of them is missing, 蜜豆视频 adds the missing ones again.
The media classifications are defined when a report suite is enabled for media tracking. From time to time, 蜜豆视频 adds new properties, and, when this occurs, customers must re-enable their report suites to get access to the new media properties. During the update process 蜜豆视频 determines whether the classifications are enabled by checking the names of the variables. If any of them is missing, 蜜豆视频 adds the missing ones again.
Core Streaming Media Data core-audio-and-video-data
Stream Type stream-type
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
mediaType - API Key:
media.streamType - Required:
Yes - Type:
string - Sent with:
Media Start, Media Close - Min. SDK Version: 2.2
Available in Media Collection API Overview or Download SDKs - Versions 2.2. - Sample value:
鈥渧颈诲别辞鈥 - Description:
Identifies the stream type. Valid values are 鈥渁udio鈥, 鈥渧颈诲别辞鈥, and " ".
Reporting Segments:
Media Stream Type: All -
Segment all media stream data; Rule: Content (ID) exists
Media Stream Type: Audio -
Segment all audio stream data; Rule: Content (ID) exists AND Media Stream Type = audio
Media Stream Type: 鈥淰ideo鈥 -
Segment all video stream data; Rule: Content (ID) exists AND Media Stream Type != audio
Release Date: 09/13/18
- 蜜豆视频 Analytics:
(a.media.streamType) - Heartbeats:
(s:meta:
a.media.streamType)
- Available:
Yes - Reserved Variable:
eVar - Expiration:
On HIT - Report Name:
Stream Type - Context Data:
(a.media.streamType) - Data Feed:
videostreamtype - Audience Manager:
(c_contextdata.
a.media.streamType) - XDM Field Path:
media.mediaTimed.primaryAssetReference.
streamType - Collection XDM Field Path:
mediaCollection.sessionDetails.streamType - Reporting XDM Field Path:
mediaReporting.sessionDetails.streamType
public static MediaObject createMediaObject(java.lang.String name,
java.lang.String mediaId,
java.lang.Double length,
java.lang.String streamType, // <==
MediaHeartbeat.MediaType mediaType)
Content ID
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
mediaId - API Key:
media.id - Required:
Yes - Type:
string - Sent with:
Media Start, Media Close - Min. SDK Version: Any
- Sample value:
鈥4586695础叠颁鈥 - Description:
Content ID of the content, which can be used to tie back to other industry / CMS IDs, equal to the last value ofs:asset:video_id.
- 蜜豆视频 Analytics:
(a.media.name) - Heartbeats:
(svideo_id)
- Available:
Yes - Reserved Variable:
eVar - Expiration:
On VISIT - Report Name:
Content - Context Data:
(a.media.name) - Data Feed:
video - Audience Manager:
(c_contextdata.
a.media.name) - XDM Field Path:
media.mediaTimed.primaryAssetReference.
iptc4xmpExt:Series.iptc4xmpExt:Identifier - Collection XDM Field Path:
mediaCollection.sessionDetails.name - Reporting XDM Field Path:
mediaReporting.sessionDetails.name
public static MediaObject createMediaObject(java.lang.String name,
java.lang.String mediaId, // <==
java.lang.Double length,
java.lang.String streamType,
MediaHeartbeat.MediaType mediaType)
Content Length (variable)
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
length - API Key:
media.length - Required:
Yes - Type:
number - Sent with:
Media Start, Media Close - Min. SDK Version: Any
- Sample value:
VOD: 128; Live: 86400; Linear: 1800. - Description:
Clip Length/Runtime - This is the maximum length (or duration) of the content being consumed (in seconds). It equals the last value ofl:asset:length
from events of type Main.
Ifl:asset:length
is not set, then the last value ofl:asset:duration
is used.
In reporting, Video Length is the classification, and Content Length (variable) is the eVAR.
Important: This property is used to compute several metrics, such as progress tracking metrics and Average Minute Audience. If this is not set, or not greater than zero, then these metrics are not available. For Live media with an unknown duration, the value of 86400 is the default.
Pre Version 1.5.1, this wasl:asset:duration
; after 1.5.1, this isl:asset:length.
Release Date: 09/13/18
- 蜜豆视频 Analytics:
(a.media.length) - Heartbeats:
(llength)
- Available:
Yes - Reserved Variable:
eVar - Expiration:
On HIT - Report Name:
Content Length (variable) - Context Data:
(a.media.length) - Data Feed:
videolength - Audience Manager:
(c_contextdata.
a.media.length) - XDM Field Path:
media.mediaTimed.primaryAssetReference.
xmpDM:duration - Collection XDM Field Path:
mediaCollection.sessionDetails.length - Reporting XDM Field Path:
mediaReporting.sessionDetails.length
public static MediaObject createMediaObject(java.lang.String name,
java.lang.String mediaId,
java.lang.Double length, // <==
java.lang.String streamType,
MediaHeartbeat.MediaType mediaType)
Video Length
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
length - API Key:
media.length - Required:
Yes - Type:
number - Sent with:
Media Start, Media Close - Min. SDK Version: Any
- Sample value:
VOD: 128; Live: 86400; Linear: 1800. - Description:
Clip Length/Runtime - This is the maximum length (or duration) of the content being consumed (in seconds). It equals the last value ofl:asset:length
from events of type Main. Ifl:asset:length
is not set, then the last value ofl:asset:duration
is used. In reporting, Video Length is the classification, and Content Length (variable) is the eVAR.
Important: This property is used to compute several metrics, such as progress tracking metrics and Average Minute Audience. If this is not set, or not greater than zero, then these metrics are not available. For Live media with an unknown duration, the value of 86400 is the default. Pre Version 1.5.1, this wasl:asset:duration
; after 1.5.1, this isl:asset:length.
Release Date: 09/13/18
- 蜜豆视频 Analytics:
(a.media.length) - Heartbeats:
(llength)
- Available:
Yes - Reserved Variable:
Classification - Expiration:
On HIT - Report Name:
Video Length - Context Data:
(a.media.length) - Data Feed:
N/A - Audience Manager:
(c_contextdata.
a.media.length) - XDM Field Path:
media.mediaTimed.primaryAssetReference.
xmpDM:duration - Collection XDM Field Path:
mediaCollection.sessionDetails.length - Reporting XDM Field Path:
mediaReporting.sessionDetails.length
public static MediaObject createMediaObject(java.lang.String name,
java.lang.String mediaId,
java.lang.Double length, // <==
java.lang.String streamType,
MediaHeartbeat.MediaType mediaType)
Content Type
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
streamType - API Key:
media.contentType - Required:
Yes - Type:
restricted string - Sent with:
Media Start, Media Close - Min. SDK Version: Any
- Sample value:
鈥渧辞诲鈥 - Description:
Available values per Stream Type:
Audio: 鈥渟ong鈥, 鈥減odcast鈥, 鈥渁udiobook鈥, 鈥渞adio鈥
Video: 鈥淰oD鈥, 鈥淟ive鈥, 鈥淟inear鈥, 鈥淯GC鈥, 鈥淒VoD鈥
Customers can provide custom values for this parameter. This equalss:stream:type.
If that is unset, this equalsmissing_content_type.
- 蜜豆视频 Analytics:
(a.contentType) - Heartbeats:
(s:stream:type
)
- Available:
Yes - Reserved Variable:
eVar - Expiration:
On HIT - Report Name:
Content Type - Context Data:
(a.contentType) - Data Feed:
videocontenttype - Audience Manager:
(c_contextdata.
a.contentType) - XDM Field Path:
media.mediaTimed.primaryAssetViewDetails.
broadcastContentType - Collection XDM Field Path:
mediaCollection.sessionDetails.contentType - Reporting XDM Field Path:
mediaReporting.sessionDetails.contentType
public static MediaObject createMediaObject(java.lang.String name,
java.lang.String mediaId,
java.lang.Double length,
java.lang.String streamType, // <==
MediaHeartbeat.MediaType mediaType)
Media Session ID
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
Automatically set - API Key:
Obtained from backend - Required:
Yes - Type:
number - Sent with:
Media Start, Media Close - Min. SDK Version: 1.5.8
- Sample value:
1482236761294786918253 - Description:
This identifies an instance of a content stream unique to an individual playback.
- 蜜豆视频 Analytics:
(a.media.vsid) - Heartbeat:
(s:event:sid
)
- Available:
Use processing rule - Reserved Variable:
N/A - Report Name:
Custom - Context Data:
(a.media.vsid) - Data Feed:
videosessionid - Audience Manager:
(c_contextdata.
a.media.vsid) - XDM Field Path:
media.mediaTimed.primaryAssetViewDetails.
@id - Reporting XDM Field Path:
mediaReporting.sessionDetails.ID
Media Downloaded Flag
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
config.downloadedcontent
- API Key:
Obtained from backend - Required:
No - Type:
boolean - Sent with:
Media Start, Media Close - Min. SDK Version:
Launch Android and iOS extension v1.1.0 - Sample value:
true - Description:
Set to true when the hit is generated due to playing a downloaded content media session. Not present when downloaded content is not played.
- 蜜豆视频 Analytics:
(a.media.downloaded) - Heartbeat:
(<s:meta:a.media.downloaded
)
- Available:
Use custom processing rule - Reserved Variable:
N/A - Report Name:
Custom - Context Data:
(a.media.downloaded) - Data Feed:
N/A - Audience Manager:
(c_contextdata.
a.media.downloaded) - XDM Field Path:
media.mediaTimed.primaryAssetViewDetails.
downloadedPlayback - Reporting XDM Field Path:
mediaReporting.sessionDetails.isDownloaded
Content Player Name
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
playerName - API Key:
media.playerName - Required:
Yes - Type:
string - Sent with:
Media Start, Media Close - Min. SDK Version: Any
- Sample value:
鈥淏谤颈驳丑迟肠辞惫别鈥 - Description:
Name of the player.
- 蜜豆视频 Analytics:
(a.media.
playerName) - Heartbeats:
(s:sp:player_name
)
- Available:
Yes - Reserved Variable:
eVar - Expiration:
On HIT - Report Name:
Content Player Name - Context Data:
(a.media.playerName) - Data Feed:
videoplayername - Audience Manager:
(c_contextdata.
a.media.playerName) - XDM Field Path:
media.mediaTimed.primaryAssetViewDetails.
playerName - Collection XDM Field Path:
mediaCollection.sessionDetails.playerName - Reporting XDM Field Path:
mediaReporting.sessionDetails.playerName
Content Channel
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
channel - API Key:
media.channel - Required:
Yes - Type:
string - Sent with:
Media Start, Media Close - Min. SDK Version: Any
- Sample value:
鈥沦辫辞谤迟蝉鈥 - Description:
Distribution Station/Channels or where the content is played. Any string value is accepted here.
- 蜜豆视频 Analytics:
(a.media.channel) - Heartbeats:
(s:sp:channel
)
- Available:
Yes - Reserved Variable:
eVar - Expiration:
On HIT - Report Name:
Content Channel - Context Data:
(a.media.channel) - Data Feed:
videochannel - Audience Manager:
(c_contextdata.
a.media.channel) - XDM Field Path:
media.mediaTimed.primaryAssetViewDetails.
broadcastChannel - Collection XDM Field Path:
mediaCollection.sessionDetails.channel - Reporting XDM Field Path:
mediaReporting.sessionDetails.channel
Content Segment
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
Automatically set - API Key:
N/A - Required:
Yes - Type:
string - Sent with:
Media Close - Min. SDK Version: Any
- Sample value:
鈥0-10鈥 - Description:
The interval that describes the part of the content that has been viewed (in minutes). The segment is computed as min and max of the playhead values during a playback session.
- 蜜豆视频 Analytics:
N/A - Heartbeats:
N/A
- Available:
Yes - Reserved Variable:
eVar - Expiration:
On HIT - Report Name:
Content Segment - Context Data:
(a.media.segment) - Data Feed:
videosegment - Audience Manager:
(c_contextdata.
a.media.segment) - XDM Field Path:
media.mediaTimed.primaryAssetViewDetails.
mediaSegmentView.value - Reporting XDM Field Path:
mediaReporting.sessionDetails.segment
Content Name (variable)
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
name - API Key:
media.name - Required:
No - Type:
string - Sent with:
Media Start, Media Close - Min. SDK Version: 1.5.1
- Sample value:
鈥淭he Big Bang Theory鈥 - Description:
This is the 鈥渇riendly鈥 (human-readable) name of the content, equal to the last value ofs:asset:name.
In reporting, Video Name is the classification, and Content Name (variable) is the eVAR.
Release Date: 09/13/18
- 蜜豆视频 Analytics:
(a.media.
friendlyName) - Heartbeats:
(sname)
- Available:
Yes - Reserved Variable:
eVar - Expiration:
On HIT - Report Name:
Content Name (variable) - Context Data:
(a.media.friendlyName) - Data Feed:
videoname - Audience Manager:
(c_contextdata.
a.media.friendlyName) - XDM Field Path:
media.mediaTimed.primaryAssetReference.
dc:title - Collection XDM Field Path:
mediaCollection.sessionDetails.friendlyName - Reporting XDM Field Path:
mediaReporting.sessionDetails.friendlyName
public static MediaObject createMediaObject(java.lang.String name,
java.lang.String mediaId, // <==
java.lang.Double length,
java.lang.String streamType,
MediaHeartbeat.MediaType mediaType)
Video Name
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
name - API Key:
media.name - Required:
No - Type:
string - Sent with:
Media Start, Media Close - Min. SDK Version: 1.5.1
- Sample value:
鈥淭he Big Bang Theory鈥 - Description:
This is the 鈥渇riendly鈥 (human-readable) name of the content, equal to the last value ofs:asset:name.
In reporting, Video Name is the classification, and Content Name (variable) is the eVAR.
Release Date: 09/13/18
- 蜜豆视频 Analytics:
(a.media.
friendlyName) - Heartbeats:
(sname)
- Available:
Yes - Reserved Variable:
Classification - Expiration:
On HIT - Report Name:
Video Name - Context Data:
(a.media.friendlyName) - Data Feed:
N/A - Audience Manager:
(c_contextdata.
a.media.friendlyName) - XDM Field Path:
media.mediaTimed.primaryAssetReference.
dc:title - Collection XDM Field Path:
mediaCollection.sessionDetails.friendlyName - Reporting XDM Field Path:
mediaReporting.sessionDetails.friendlyName
Video Path
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
Automatically set - API Key:
N/A - Required:
No - Type:
string - Sent with:
Media Start - Min. SDK Version: Any
- Sample value:
鈥4586695础叠颁鈥 - Description:
Provides the ability to track the path of a viewer across a site and/or App, to see the path they took to view a particular video. Any integer and/or letter combination.
- 蜜豆视频 Analytics:
(a.media.name) - Heartbeats:
(svideo_id)
- Available:
Yes - Reserved Variable:
prop - Report Name:
Video Path - Context Data:
(a.media.name) - Data Feed:
videopath - Audience Manager:
(c_contextdata.
a.media.name) - XDM Field Path:
media.mediaTimed.primaryAssetReference.
iptc4xmpExt:Series.iptc4xmpExt:Identifier - Collection XDM Field Path:
mediaCollection.sessionDetails.name - Reporting XDM Field Path:
mediaReporting.sessionDetails.name
SDK Version
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
appVersion - API Key:
media.sdkVersion - Required:
No - Type:
string - Sent with:
Media Close - Min. SDK Version: 1.5.7
- Sample value:
鈥2.62.0冲谤别濒别补蝉别鈥 - Description:
The SDK version used by the player. This could have any custom value that makes sense for your player.
Customers will have to create their own processing rules to have the value available for reporting.
- 蜜豆视频 Analytics:
(a.media.
sdkVersion) - Heartbeats:
(s:sp:sdk
)
- Available:
Use custom processing rule - Reserved Variable:
N/A - Report Name:
Custom - Context Data:
(a.media.sdkVersion) - Data Feed:
N/A - Audience Manager:
(c_contextdata.
a.media.sdkVersion) - XDM Field Path:
media.mediaTimed.primaryAssetViewDetails.
playerSDKVersion.version - Collection XDM Field Path:
mediaCollection.sessionDetails.appVersion - Reporting XDM Field Path:
mediaReporting.sessionDetails.appVersion
VHL Version
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
Automatically set - API Key:
N/A - Required:
No - Type:
string - Sent with:
Media Close - Min. SDK Version: 1.5.7
- Sample value:
鈥渏蝉-2.0.1.88-肠8肠0产1鈥 - Description:
The Media SDK version used for the tracking session.
Customers will have to create their own processing rules to have the value available for reporting.
- 蜜豆视频 Analytics:
(a.media.
vhlVersion) - Heartbeats:
(s:sp:hb_version
)
- Available:
Use custom processing rule - Reserved Variable:
N/A - Report Name:
Custom - Context Data:
(a.media.vhlVersion) - Data Feed:
N/A - Audience Manager:
(c_contextdata.
a.media.vhlVersion) - XDM Field Path:
media.mediaTimed.primaryAssetViewDetails.
vhlVersion - Collection XDM Field Path:
implementationDetails.
version - Reporting XDM Field Path:
implementationDetails.
version
Standard Streaming Media Metadata standard-audio-and-video-metadata
Show
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
SHOW - API Key:
media.show - Required:
No - Type:
string - Sent with:
Media Start, Media Close - Min. SDK Version: 1.5.7
- Sample value:
鈥淢odern Family鈥 鈥淭he Last Dance鈥 鈥淣ew Girl鈥 - Description:
Program/Series Name
Program Name is required only if the show is part of a series.
- 蜜豆视频 Analytics:
(a.media.show) - Heartbeats:
(s:meta:
a.media.show)
- Available:
Yes - Reserved Variable:
eVar - Expiration:
On HIT - Report Name:
Show - Context Data:
(a.media.show) - Data Feed:
videoshow - Audience Manager:
(c_contextdata.
a.media.show) - XDM Field Path:
media.mediaTimed.primaryAssetReference.
iptc4xmpExt:Series.iptc4xmpExt:Name - Collection XDM Field Path:
mediaCollection.sessionDetails.show - Reporting XDM Field Path:
mediaReporting.sessionDetails.show
Stream Format
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
STREAM_FORMAT - API Key:
media.streamFormat - Required:
No - Type:
string - Sent with:
Media Start, Media Close - Min. SDK Version: 1.5.7
- Sample value:
鈥淗顿鈥 - Description:
Format of the stream (HD, SD)
- 蜜豆视频 Analytics:
(a.media.format) - Heartbeats:
(s:meta:
a.media.format)
- Available:
Use custom processing rule - Reserved Variable:
N/A - Report Name:
Custom - Context Data:
(a.media.format) - Data Feed:
N/A - Audience Manager:
(c_contextdata.
a.media.format) - XDM Field Path:
media.mediaTimed.primaryAssetReference.
streamFormat - Collection XDM Field Path:
mediaCollection.sessionDetails.streamFormat - Reporting XDM Field Path:
mediaReporting.sessionDetails.streamFormat
Season
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
SEASON - API Key:
media.season - Required:
No - Type:
string - Sent with:
Media Start, Media Close - Min. SDK Version: 1.5.7
- Sample value:
鈥2鈥 - Description:
The season number the show belongs to. Season Series is required only if the show is part of a series.
- 蜜豆视频 Analytics:
(a.media.season) - Heartbeats:
(s:meta:
a.media.season)
- Available:
Yes - Reserved Variable:
eVar - Expiration:
On HIT - Report Name:
Season - Context Data:
(a.media.season) - Data Feed:
videoseason - Audience Manager:
(c_contextdata.
a.media.season) - XDM Field Path:
media.mediaTimed.primaryAssetReference.
iptc4xmpExt:Season.iptc4xmpExt:Number - Collection XDM Field Path:
mediaCollection.sessionDetails.season - Reporting XDM Field Path:
mediaReporting.sessionDetails.season
Episode
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
EPISODE - API Key:
media.episode - Required:
No - Type:
string - Sent with:
Media Start, Media Close - Min. SDK Version: 1.5.7
- Sample value:
鈥13鈥 - Description:
The number of the episode.
- 蜜豆视频 Analytics:
(a.media.episode) - Heartbeats:
(s:meta:
a.media.episode)
- Available:
Yes - Reserved Variable:
eVar - Expiration:
On HIT - Report Name:
Episode - Context Data:
(a.media.episode) - Data Feed:
videoepisode - Audience Manager:
(c_contextdata.
a.media.episode) - XDM Field Path:
media.mediaTimed.primaryAssetReference.
iptc4xmpExt:Episode.iptc4xmpExt:Number - Collection XDM Field Path:
mediaCollection.sessionDetails.episode - Reporting XDM Field Path:
mediaReporting.sessionDetails.episode
Asset ID
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
ASSET_ID - API Key:
media.assetId - Required:
No - Type:
string - Sent with:
Media Start, Media Close - Min. SDK Version: 1.5.7
- Sample value:
鈥89745363鈥 - Description:
This is the unique identifier for the content of the media asset, such as the TV series episode identifier, movie asset identifier, or live event identifier. Typically these IDs are derived from metadata authorities such as EIDR, TMS/Gracenote, or Rovi. These identifiers can also be from other proprietary or in-house systems.
- 蜜豆视频 Analytics:
(a.media.asset) - Heartbeats:
(s:meta:
a.media.asset)
- Available:
Yes - Reserved Variable:
Classification - Report Name:
Asset ID - Context Data:
(a.media.asset) - Data Feed:
N/A - Audience Manager:
(c_contextdata.
a.media.asset) - XDM Field Path:
media.mediaTimed.primaryAssetReference.
@id - Collection XDM Field Path:
mediaCollection.sessionDetails.assetID - Reporting XDM Field Path:
mediaReporting.sessionDetails.assetID
Genre
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
GENRE - API Key:
media.genre - Required:
No - Type:
string - Sent with:
Media Start, Media Close - Min. SDK Version: 1.5.7
- Sample value:
鈥淒rama鈥, 鈥淐omedy鈥 - Description:
Type or grouping of content as defined by content producer. Values should be comma delimited in variable implementation. In reporting, the list eVar will split each value into a line item, with each line item receiving equal metrics weight.
- 蜜豆视频 Analytics:
(a.media.genre) - Heartbeats:
(s:meta:
a.media.genre)
- Available:
Yes - Reserved Variable:
List eVar - Expiration:
On HIT - Report Name:
Genre - Context Data:
(a.media.genre) - Data Feed:
videogenre - Audience Manager:
(c_contextdata.
a.media.genre) - XDM Field Path:
media.mediaTimed.primaryAssetReference.
iptc4xmpExt:Genre - Collection XDM Field Path:
mediaCollection.sessionDetails.genre - Reporting XDM Field Path:
mediaReporting.sessionDetails.genre
First Air Date
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
FIRST_AIR_DATE - API Key:
media.firstAirDate - Required:
No - Type:
string - Sent with:
Media Start - Min. SDK Version: 1.5.7
- Sample value:
鈥2016-01-25鈥 - Description:
The date when the content first aired on television. Any date format is acceptable, but 蜜豆视频 recommends: YYYY-MM-DD
- 蜜豆视频 Analytics:
(a.media.airDate) - Heartbeats:
(s:meta:
a.media.airDate)
- Available:
Yes - Reserved Variable:
Classification - Expiration:
On HIT - Report Name:
First Air Date - Context Data:
(a.media.airDate) - Data Feed:
N/A - Audience Manager:
(c_contextdata.
a.media.airDate) - XDM Field Path:
media.mediaTimed.primaryAssetReference.
firstAirDate - Collection XDM Field Path:
mediaCollection.sessionDetails.firstAirDate - Reporting XDM Field Path:
mediaReporting.sessionDetails.firstAirDate
First Digital Date
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
FIRST_DIGITAL_DATE - API Key:
media.firstDigitalDate - Required:
No - Type:
string - Sent with:
Media Start, Media Close - Min. SDK Version: 1.5.7
- Sample value:
鈥2016-01-25鈥 - Description:
The date when the content first aired on any digital channel or platform. Any date format is acceptable but 蜜豆视频 recommends: YYYY-MM-DD
- 蜜豆视频 Analytics:
(a.media.digitalDate) - Heartbeats:
(s:meta:
a.media.digitalDate)
- Available:
Yes - Reserved Variable:
Classification - Report Name:
First Digital Date - Context Data:
(a.media.digitalDate) - Data Feed:
N/A - Audience Manager:
(c_contextdata.
a.media.digitalDate) - XDM Field Path:
media.mediaTimed.primaryAssetReference.
xmpDM:releaseDate - Collection XDM Field Path:
mediaCollection.sessionDetails.
firstDigitalDate - Reporting XDM Field Path:
mediaReporting.sessionDetails.
firstDigitalDate
Content Rating
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
RATING - API Key:
media.rating - Required:
No - Type:
string - Sent with:
Media Start, Media Close - Min. SDK Version: 1.5.7
- Sample value:
TVY, TVG, TVPG, TVMA - Description:
Rating as defined by TV Parental Guidelines.
- 蜜豆视频 Analytics:
(a.media.rating) - Heartbeats:
(s:meta:
a.media.rating)
- Available:
Yes - Reserved Variable:
Classification - Report Name:
Content Rating - Context Data:
(a.media.rating) - Data Feed:
N/A - Audience Manager:
(c_contextdata.
a.media.rating) - XDM Field Path:
media.mediaTimed.primaryAssetReference.
iptc4xmpExt:Rating.[N].
iptc4xmpExt:RatingValue - Collection XDM Field Path:
mediaCollection.sessionDetails.rating - Reporting XDM Field Path:
mediaReporting.sessionDetails.rating
Originator
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
ORIGINATOR - API Key:
media.originator - Required:
No - Type:
string - Sent with:
Media Start, Media Close - Min. SDK Version: 1.5.7
- Sample value:
鈥淲arner Brothers鈥, 鈥淪ony鈥, 鈥淒isney鈥 - Description:
Creator of the content.
- 蜜豆视频 Analytics:
(a.media.originator) - Heartbeats:
(s:meta:
a.media.originator)
- Available:
Yes - Reserved Variable:
Classification - Report Name:
Originator - Context Data:
(a.media.originator) - Data Feed:
N/A - Audience Manager:
(c_contextdata.
a.media.originator) - XDM Field Path:
media.mediaTimed.primaryAssetReference.
iptc4xmpExt:Creator.[N].
iptc4xmpExt:Name - Collection XDM Field Path:
mediaCollection.sessionDetails.originator - Reporting XDM Field Path:
mediaReporting.sessionDetails.originator
Network
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
NETWORK - API Key:
media.network - Required:
No - Type:
string - Sent with:
Media Start, Media Close - Min. SDK Version: 1.5.7
- Sample value:
鈥淔ox鈥, 鈥淏ravo鈥, 鈥淓SPN鈥 - Description:
The network/channel name.
- 蜜豆视频 Analytics:
(a.media.network) - Heartbeats:
(s:meta:
a.media.network)
- Available:
Yes - Reserved Variable:
eVar - Expiration:
On HIT - Report Name:
Network - Context Data:
(a.media.network) - Data Feed:
videonetwork - Audience Manager:
(c_contextdata.
a.media.network) - XDM Field Path:
media.mediaTimed.primaryAssetViewDetails.
broadcastNetwork - Collection XDM Field Path:
mediaCollection.sessionDetails.network - Reporting XDM Field Path:
mediaReporting.sessionDetails.network
Show Type
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
SHOW_TYPE - API Key:
media.showType - Required:
No - Type:
string - Sent with:
Media Start, Media Close - Min. SDK Version: 1.5.7
- Sample value:
鈥0鈥 = Full episode; 鈥1鈥 = Preview/trailer; 鈥2鈥 = Clip; 鈥3鈥 = Other. - Description:
Type of content, expressed as an integer between 0 and 3.
- 蜜豆视频 Analytics:
(a.media.type) - Heartbeats:
(s:meta:
a.media.type)
- Available:
Yes - Reserved Variable:
eVar - Expiration:
On HIT - Report Name:
Show Type - Context Data:
(a.media.type) - Data Feed:
videoshowtype - Audience Manager:
(c_contextdata.
a.media.type) - XDM Field Path:
media.mediaTimed.primaryAssetReference.
showType - Collection XDM Field Path:
mediaCollection.sessionDetails.showType - Reporting XDM Field Path:
mediaReporting.sessionDetails.showType
MVPD
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
MVPD - API Key:
media.pass.mvpd - Required:
No - Type:
string - Sent with:
Media Start, Media Close - Min. SDK Version: 1.5.7
- Sample value:
鈥淐omcast鈥, 鈥淒irecTV鈥, 鈥淒ish鈥 - Description:
MVPD provided via 蜜豆视频 authentication.
- 蜜豆视频 Analytics:
(a.media.pass.mvpd) - Heartbeats:
(s:meta:
a.media.pass.
mvpd)
- Available:
Yes - Reserved Variable:
eVar - Expiration:
On HIT - Report Name:
MVPD - Context Data:
(a.media.pass.mvpd) - Data Feed:
videomvpd - Audience Manager:
(c_contextdata.
a.media.pass.mvpd) - XDM Field Path:
media.mediaTimed.idp - Collection XDM Field Path:
mediaCollection.sessionDetails.mvpd - Reporting XDM Field Path:
mediaReporting.sessionDetails.mvpd
Authorized
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
AUTHORIZED - API Key:
media.pass.auth - Required:
No - Type:
string - Sent with:
Media Start, Media Close - Min. SDK Version: 1.5.7
- Sample value:
鈥淭搁鲍贰鈥 - Description:
The user has been authorized via 蜜豆视频 authentication.
Important: This can only be true if it is set. If it is not set, no value is returned.
- 蜜豆视频 Analytics:
(a.media.pass.auth) - Heartbeats:
(s:meta:
a.media.pass.
auth)
- Available:
Yes - Reserved Variable:
event - Report Name:
Authorized - Context Data:
(a.media.pass.auth) - Data Feed:
videoauthorized - Audience Manager:
(c_contextdata.
a.media.pass.auth) - XDM Field Path:
media.mediaTimed.mediaAuth - Collection XDM Field Path:
mediaCollection.sessionDetails.
authorized - Reporting XDM Field Path:
mediaReporting.sessionDetails.
authorized
Day Part
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
DAY_PART - API Key:
media.dayPart - Required:
No - Type:
string - Sent with:
Media Start, Media Close - Min. SDK Version: 1.5.7
- Sample value:
- Description:
A property that defines the time of the day when the content was broadcast or played. This could have any value set as necessary by customers.
- 蜜豆视频 Analytics:
(a.media.dayPart) - Heartbeats:
(s:meta:
a.media.dayPart)
- Available:
Yes - Reserved Variable:
eVar - Expiration:
On HIT - Report Name:
Day Part - Context Data:
(a.media.dayPart) - Data Feed:
videodaypart - Audience Manager:
(c_contextdata.
a.media.dayPart) - XDM Field Path:
media.mediaTimed.dayPart - Collection XDM Field Path:
mediaCollection.sessionDetails.dayPart - Reporting XDM Field Path:
mediaReporting.sessionDetails.dayPart
Media Feed Type
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
FEED - API Key:
media.feed - Required:
No - Type:
string - Sent with:
Media Start, Media Close - Min. SDK Version: 1.5.7
- Sample value:
鈥淓ast-HD鈥, 鈥淲est-HD鈥, 鈥淓ast-SD鈥 - Description:
Type of feed.
Release Date: 09/13/18
- 蜜豆视频 Analytics:
(a.media.feed) - Heartbeats:
(s:meta:
a.media.feed)
- Available:
Yes - Reserved Variable:
eVar - Expiration:
On HIT - Report Name:
Media Feed Type - Context Data:
(a.media.feed) - Data Feed:
videofeedtype - Audience Manager:
(c_contextdata.
a.media.feed) - Collection XDM Field Path:
mediaCollection.sessionDetails.feed - XDM Field Path:
media.mediaTimed.primaryAssetViewDetails.
sourceFeed - Reporting XDM Field Path:
mediaReporting.sessionDetails.feed
Artist
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
- API Key:
media.artist - Required:
No - Type:
string - Sent with:
Media Start, Media Close - Min. SDK Version: 1.5.7
Available in Media Collection Overview or Download SDKs - Versions 2.2. - Sample value:
鈥淭he Beatles鈥 - Description:
Name of the artist.
Release Date: 09/13/18
- 蜜豆视频 Analytics:
(a.media.artist) - Heartbeats:
(s:meta:
a.media.artist)
- Available:
Yes - Reserved Variable:
eVar - Expiration:
On HIT - Report Name:
Artist - Context Data:
(a.media.artist) - Data Feed:
videoaudioartist - Audience Manager:
(c_contextdata.
a.media.artist) - XDM Field Path:
media.mediaTimed.primaryAssetReference.
Audio.xmpDM:artist - Collection XDM Field Path:
mediaCollection.sessionDetails.artist - Reporting XDM Field Path:
mediaReporting.sessionDetails.artist
Album
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
- API Key:
media.album - Required:
No - Type:
string - Sent with:
Media Start, Media Close - Min. SDK Version: 1.5.7
Available in Media Collection Overview or Download SDKs - Versions 2.2. - Sample value:
鈥凌别惫辞濒惫别谤鈥 - Description:
Name of the album.
Release Date: 09/13/18
- 蜜豆视频 Analytics:
(a.media.album) - Heartbeats:
(s:meta:
a.media.album)
- Available:
Yes - Reserved Variable:
eVar - Expiration:
On HIT - Report Name:
Album - Context Data:
(a.media.album) - Data Feed:
videoaudioalbum - Audience Manager:
(c_contextdata.
a.media.album) - XDM Field Path:
media.mediaTimed.primaryAssetReference.
Audio.xmpDM:album - Collection XDM Field Path:
mediaCollection.sessionDetails.album - Reporting XDM Field Path:
mediaReporting.sessionDetails.album
Label
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
- API Key:
media.label - Required:
No - Type:
string - Sent with:
Media Start, Media Close - Min. SDK Version: 1.5.7
Available in Media Collection Overview or Download SDKs - Versions 2.2. - Sample value:
鈥凌别惫辞濒惫别谤鈥 - Description:
Name of the record label.
Release Date: 09/13/18
- 蜜豆视频 Analytics:
(a.media.label) - Heartbeats:
(s:meta:
a.media.label)
- Available:
Yes - Reserved Variable:
eVar - Expiration:
On HIT - Report Name:
Label - Context Data:
(a.media.label) - Data Feed:
videoaudiolabel - Audience Manager:
(c_contextdata.
a.media.label) - XDM Field Path:
media.mediaTimed.recordLabel - Collection XDM Field Path:
mediaCollection.sessionDetails.label - Reporting XDM Field Path:
mediaReporting.sessionDetails.label
Author
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
- API Key:
media.author - Required:
No - Type:
string - Sent with:
Media Start, Media Close - Min. SDK Version: 1.5.7
Available in Media Collection Overview or Download SDKs - Versions 2.2. - Sample value:
鈥淛ohn Kennedy Toole鈥 - Description:
Name of the author (of an audiobook).
Release Date: 09/13/18
- 蜜豆视频 Analytics:
(a.media.author) - Heartbeats:
(s:meta:
a.media.author)
- Available:
Yes - Reserved Variable:
eVar - Expiration:
On HIT - Report Name:
Author - Context Data:
(a.media.author) - Data Feed:
videoaudioauthor - Audience Manager:
(c_contextdata.
a.media.author) - XDM Field Path:
media.mediaTimed.primaryAssetReference.
Audio.dc:creator - Collection XDM Field Path:
mediaCollection.sessionDetails.author - Reporting XDM Field Path:
mediaReporting.sessionDetails.author
Station
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
- API Key:
media.station - Required:
No - Type:
string - Sent with:
Media Start, Media Close - Min. SDK Version: 1.5.7
Available in Media Collection Overview or Download SDKs - Versions 2.2. - Sample value:
鈥淣笔搁鈥 - Description:
Name / ID of the radio station.
Release Date: 09/13/18
- 蜜豆视频 Analytics:
(a.media.station) - Heartbeats:
(s:meta:
a.media.station)
- Available:
Yes - Reserved Variable:
eVar - Expiration:
On HIT - Report Name:
Station - Context Data:
(a.media.station) - Data Feed:
videoaudiostation - Audience Manager:
(c_contextdata.
a.media.station) - XDM Field Path:
media.mediaTimed.primaryAssetReference.
_id3.audio._id3.TRSN - Collection XDM Field Path:
mediaCollection.sessionDetails.station - Reporting XDM Field Path:
mediaReporting.sessionDetails.station
Publisher
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
- API Key:
media.publisher - Required:
No - Type:
string - Sent with:
Media Start, Media Close - Min. SDK Version: 1.5.7
Available in Media Collection Overview or Download SDKs - Versions 2.2. - Sample value:
鈥淩andom Bauhaus鈥 - Description:
Name of the audio content publisher.
Release Date: 09/13/18
- 蜜豆视频 Analytics:
(a.media.publisher) - Heartbeats:
(s:meta:
a.media.publisher)
- Available:
Yes - Reserved Variable:
eVar - Expiration:
On HIT - Report Name:
Custom - Context Data:
(a.media.publisher) - Data Feed:
videoaudiopublisher - Audience Manager:
(c_contextdata.
a.media.publisher) - XDM Field Path:
media.mediaTimed.primaryAssetReference.
_id3.audio._id3.TPUB - Collection XDM Field Path:
mediaCollection.sessionDetails.publisher - Reporting XDM Field Path:
mediaReporting.sessionDetails.publisher
Streaming Media Metrics audio-and-video-metrics
Media Starts
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
Automatically set - API Key:
N/A - Type:
string - Sent with:
Media Start - Min. SDK Version: Any
- Sample value:
TRUE - Description:
Load event for the media. (This occurs when the viewer clicks the Play button). This would count even if there are pre-roll ads, buffering, errors, and so on.
Important: This can only be true if it is set. If it is not set, no value is returned.
Release Date: 09/13/18
- 蜜豆视频 Analytics:
(a.media.view) - Heartbeats:
(s:event:
type=start)
- Available:
Yes - Reserved Variable:
event - Report Name:
Media Starts - Context Data:
(a.media.view) - Data Feed:
videostart - Audience Manager:
(c_contextdata.
a.media.view) - XDM Field Path:
media.mediaTimed.impressions.value - Reporting XDM Field Path:
mediaReporting.sessionDetails.isViewed
Content Starts
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
Automatically set - API Key:
N/A - Type:
string - Sent with:
Media Close - Min. SDK Version: Any
- Sample value:
TRUE - Description:
First frame of media is consumed. If the user drops during ad, buffering, etc., then there would be no 鈥淐ontent Start鈥 event.
Important: This can only be true if it is set. If it is not set, no value is returned.
- 蜜豆视频 Analytics:
N/A - Heartbeats:
N/A
- Available:
Yes - Reserved Variable:
event - Report Name:
Content Starts - Context Data:
(a.media.play) - Data Feed:
videoplay - Audience Manager:
(c_contextdata.
a.media.play) - XDM Field Path:
media.mediaTimed.starts.value - Reporting XDM Field Path:
mediaReporting.sessionDetails.isPlayed
Content Complete content-complete
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
Automatically set - API Key:
N/A - Type:
string - Sent with:
Media Close - Min. SDK Version: Any
- Sample value:
TRUE - Description:
A stream that was watched to completion. This does not necessarily mean the user watched or listened to the whole stream; they could have skipped ahead. This only means that the user reached the end of the stream, 100%.
Also see Session End
Important: This can only be true if it is set. If it is not set, no value is returned.
- 蜜豆视频 Analytics:
N/A - Heartbeats:
(s:event:
type=complete)
- Available:
Yes - Reserved Variable:
event - Report Name:
Content Completes - Context Data:
(a.media.complete) - Data Feed:
videocomplete - Audience Manager:
(c_contextdata.
a.media.complete) - XDM Field Path:
media.mediaTimed.completes.value - Reporting XDM Field Path:
mediaReporting.sessionDetails.isCompleted
Content Time Spent
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
Automatically set - API Key:
N/A - Type:
number - Sent with:
Media Close - Min. SDK Version: Any
- Sample value:
105 - Description:
Sums the event duration (in seconds) for all events of type PLAY on the main content. The value will be displayed in the time format(HH:MM:SS)
in Analysis Workspace and Reports & Analytics. In Data Feeds, Data Warehouse, and Reporting APIs the values will be displayed in seconds.
Release Date: 09/13/18
- 蜜豆视频 Analytics:
N/A - Heartbeats:
N/A
- Available:
Yes - Reserved Variable:
event - Report Name:
Content Time Spent - Context Data:
(a.media.timePlayed) - Data Feed:
videotime - Audience Manager:
(c_contextdata.
a.media.timePlayed) - XDM Field Path:
media.mediaTimed.timePlayed.value - Reporting XDM Field Path:
mediaReporting.sessionDetails.timePlayed
Media Time Spent
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
Automatically set - API Key:
N/A - Type:
number - Sent with:
Media Close - Min. SDK Version: Any
- Sample value:
120 - Description:
Sums the event duration (in seconds) for all events of type PLAY, both main and ad content. The value will be displayed in the time format(HH:MM:SS)
in Analysis Workspace and Reports & Analytics. In Data Feeds, Data Warehouse, and Reporting APIs the values will be displayed in seconds.
Release Date: 09/13/18
- 蜜豆视频 Analytics:
N/A - Heartbeats:
N/A
- Available:
Yes - Reserved Variable:
event - Report Name:
Media Time Spent - Context Data:
(a.media.totalTimePlayed) - Data Feed:
videototaltime - Audience Manager:
(c_contextdata.
a.media.totalTimePlayed) - XDM Field Path:
media.mediaTimed.totalTimePlayed.value - Reporting XDM Field Path:
mediaReporting.sessionDetails.
totalTimePlayed
Unique Time Played
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
Automatically set - API Key:
N/A - Type:
number - Sent with:
Media Close - Min. SDK Version: Any
- Sample value:
94 - Description:
The value in seconds of the unique segments of content played during a session. Excludes time played on seek back scenarios in which a viewer is watching the same segment of the content multiple times. The value will be displayed in the time format(HH:MM:SS)
in Analysis Workspace and Reports & Analytics. In Data Feeds, Data Warehouse, and Reporting APIs the values will be displayed in seconds.
Release Date: 09/13/18
- 蜜豆视频 Analytics:
N/A - Heartbeats:
N/A
- Available:
Yes - Reserved Variable:
event - Report Name:
Unique Time Played - Context Data:
(a.media.uniqueTimePlayed) - Data Feed:
videouniquetimeplayed - Audience Manager:
(c_contextdata.
a.media.uniqueTimePlayed) - XDM Field Path:
media.mediaTimed.uniqueTimePlayed.value - Reporting XDM Field Path:
mediaReporting.sessionDetails.
uniqueTimePlayed
Ten % Progress Marker
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
Automatically set - API Key:
N/A - Type:
string - Sent with:
Media Close - Min. SDK Version: Any
- Sample value:
TRUE - Description:
Playhead passes the 10% marker of content based on length. The marker is only counted once, even if seeking backwards. If seeking forward, markers that are skipped are not counted.
Important: This can only be true if it is set. If it is not set, no value is returned.
- 蜜豆视频 Analytics:
N/A - Heartbeats:
N/A
- Available:
Yes - Reserved Variable:
event - Report Name:
10% Progress Marker - Context Data:
(a.media.progress10) - Data Feed:
videoprogress10 - Audience Manager:
(c_contextdata.
a.media.progress10) - XDM Field Path:
media.mediaTimed.progress10.value - Reporting XDM Field Path:
mediaReporting.sessionDetails.hasProgress10
Twenty-five % Progress Marker
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
Automatically set - API Key:
N/A - Type:
string - Sent with:
Media Close - Min. SDK Version: Any
- Sample value:
TRUE - Description:
Playhead passes the 25% marker of content based on content length. Marker only counted once, even if seeking backwards. If seeking forward, markers that are skipped are not counted.
Important: This can only be true if it is set. If it is not set, no value is returned.
- 蜜豆视频 Analytics:
N/A - Heartbeats:
N/A
- Available:
Yes - Reserved Variable:
event - Report Name:
25% Progress Marker - Context Data:
(a.media.progress25) - Data Feed:
videoprogress25 - Audience Manager:
(c_contextdata.
a.media.progress25) - XDM Field Path:
media.mediaTimed.progress25.value - Reporting XDM Field Path:
mediaReporting.sessionDetails.hasProgress25
50% Progress Marker
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
Automatically set - API Key:
N/A - Type:
string - Sent with:
Media Close - Min. SDK Version: Any
- Sample value:
TRUE - Description:
Playhead passes the 50% marker of content based on content length. Marker only counted once, even if seeking backwards. If seeking forward, markers that are skipped are not counted.
Important: This can only be true if it is set. If it is not set, no value is returned.
- 蜜豆视频 Analytics:
N/A - Heartbeats:
N/A
- Available:
Yes - Reserved Variable:
event - Report Name:
50% Progress Marker - Context Data:
(a.media.progress50) - Data Feed:
videoprogress50 - Audience Manager:
(c_contextdata.
a.media.progress50) - XDM Field Path:
media.mediaTimed.progress50.value - Reporting XDM Field Path:
mediaReporting.sessionDetails.hasProgress50
Seventy-five % Progress Marker
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
Automatically set - API Key:
N/A - Type:
string - Sent with:
Media Close - Min. SDK Version: Any
- Sample value:
TRUE - Description:
Playhead passes the 75% marker of content based on content length. Marker only counted once, even if seeking backwards. If seeking forward, markers that are skipped are not counted.
Important: This can only be true if it is set. If it is not set, no value is returned.
- 蜜豆视频 Analytics:
N/A - Heartbeats:
N/A
- Available:
Yes - Reserved Variable:
event - Report Name:
75% Progress Marker - Context Data:
(a.media.progress75) - Data Feed:
videoprogress75 - Audience Manager:
(c_contextdata.
a.media.progress75) - XDM Field Path:
media.mediaTimed.progress75.value - Reporting XDM Field Path:
mediaReporting.sessionDetails.hasProgress75
Ninety-five % Progress Marker
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
Automatically set - API Key:
N/A - Type:
string - Sent with:
Media Close - Min. SDK Version: Any
- Sample value:
TRUE - Description:
Playhead passes the 95% marker of content based on content length. Marker only counted once, even if seeking backwards. If seeking forward, markers that are skipped are not counted.
Important: This can only be true if it is set. If it is not set, no value is returned.
- 蜜豆视频 Analytics:
N/A - Heartbeats:
N/A
- Available:
Yes - Reserved Variable:
event - Report Name:
95% Progress Marker - Context Data:
(a.media.progress95) - Data Feed:
videoprogress95 - Audience Manager:
(c_contextdata.
a.media.progress95) - XDM Field Path:
media.mediaTimed.progress95.value - Reporting XDM Field Path:
mediaReporting.sessionDetails.hasProgress95
Average Minute Audience
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
Automatically set - API Key:
N/A - Type:
number - Sent with:
Media Close - Min. SDK Version: Any
- Sample value:
Greater than or equal to 1 - Description:
Average Minute Audience metric is computed as Total Content Time Spent, for one specific media item, divided by its length for all of its playback sessions:average_minute_audience = timeSpent / videoLength;
- 蜜豆视频 Analytics:
N/A - Heartbeats:
N/A
- Available:
Yes - Reserved Variable:
event - Report Name:
Average Minute Audience - Context Data:
(a.media.averageMinuteAudience) - Data Feed:
videoaverageminuteaudience - Audience Manager:
(c_contextdata.
a.media.averageMinuteAudience) - XDM Field Path:
media.mediaTimed.
averageMinuteAudience.value - Reporting XDM Field Path:
mediaReporting.sessionDetails.
averageMinuteAudience
Seconds Since Last Call
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
Automatically set - API Key:
N/A - Type:
number - Sent with:
Media Close - Min. SDK Version: Any
- Sample value:
600 - Description:
The seconds since last call metric is 0 if the stream was closed with a complete event or with an end event, and is usually 600 if it was closed due to timeout. This metric does not have a solution variable and auto processing rules, so you have to create a custom processing rule to save it.
- 蜜豆视频 Analytics:
N/A - Heartbeats:
N/A
- Available:
Use custom processing rule - Reserved Variable:
N/A - Report Name:
Custom - Context Data:
(a.media.secondsSinceLastCall) - Data Feed:
videosecondssincelastcall - Audience Manager:
(c_contextdata.
a.media.secondsSinceLastCall) - XDM Field Path:
media.mediaTimed.primaryAssetViewDetails.
sessionTimeout - Reporting XDM Field Path:
mediaReporting.sessionDetails.
secondsSinceLastCall
Federated Data
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
Automatically set - API Key:
N/A - Type:
boolean - Sent with:
Media Close - Min. SDK Version: Any
- Sample value:
true - Description:
Set to true when the hit is federated (i.e., received by the customer as part of a federated data share, rather than their own implementation).
- 蜜豆视频 Analytics:
N/A - Heartbeats:
N/A
- Available:
Use custom processing rule - Reserved Variable:
N/A - Report Name:
N/A - Context Data:
(a.media.federated) - Data Feed:
N/A - Audience Manager:
(c_contextdata.
a.media.federated) - XDM Field Path:
media.mediaTimed.federated.value - Reporting XDM Field Path:
mediaReporting.sessionDetails.isFederated
Estimated Streams
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
Automatically set - API Key:
N/A - Type:
number - Sent with:
Media Close - Min. SDK Version: Any
- Sample value:
1 - For a 19 minutes playback;
2 - For a 31 minutes playback;
3 - For a 78 minutes playback. - Description:
The estimated number of video or audio streams per each individual content. This value is increased for each 30 minutes of play time (content + ads). Customers must create their own processing rules to have the value available for reporting.
A stream is counted every 30 minutes, based on thems_s
(or totalTimePlayed = Video Total Time), similar to:estimatedStreams =
听听FLOOR(ms_s/1800) + 1
- 蜜豆视频 Analytics:
N/A - Heartbeats:
N/A
- Available:
Use custom processing rule - Reserved Variable:
N/A - Report Name:
Custom - Context Data:
(a.media.estimatedStreams) - Data Feed:
N/A - Audience Manager:
(c_contextdata.
a.media.estimatedStreams) - XDM Field Path:
media.mediaTimed.estimatedStreams.value - Reporting XDM Field Path:
mediaReporting.sessionDetails.
estimatedStreams
Paused Impacted Streams
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
Automatically set - API Key:
N/A - Type:
string - Sent with:
Media Close - Min. SDK Version: 1.5.6
- Sample value:
TRUE - Description:
This value is either true or false. It is true if one or more pauses occurred during playback of a single media item.
Important: This can only be true if it is set. If it is not set, no value is returned.
- 蜜豆视频 Analytics:
N/A - Heartbeats:
(s:event:
type=pause)
- Available:
Yes - Reserved Variable:
event - Report Name:
Paused Impacted Stream - Context Data:
(a.media.pause) - Data Feed:
videopause - Audience Manager:
(c_contextdata.
a.media.pause) - XDM Field Path:
media.mediaTimed.
pauseImpactedStreams.value > 0 => 鈥淭搁鲍贰鈥 - Reporting XDM Field Path:
mediaReporting.sessionDetails.
hasPauseImpactedStreams
Pause Events
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
Automatically set - API Key:
N/A - Type:
number - Sent with:
Media Close - Min. SDK Version: 1.5.6
- Sample value:
2 - Description:
This metric is computed as a count of pause periods that occurred during a playback session.
- 蜜豆视频 Analytics:
N/A - Heartbeats:
(s:event:
type=pause)
- Available:
Yes - Reserved Variable:
event - Report Name:
Pause Events - Context Data:
(a.media.pauseCount) - Data Feed:
videopausecount - Audience Manager:
(c_contextdata.
a.media.pauseCount) - XDM Field Path:
media.mediaTimed.pauses.value - Reporting XDM Field Path:
mediaReporting.sessionDetails.pauseCount
Total Pause Duration
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
Automatically set - API Key:
N/A - Type:
number - Sent with:
Media Close - Min. SDK Version: 1.5.6
- Sample value:
190 - Description:
Sums the duration (in seconds) of all events of type PAUSE. The value will be displayed in the time format(HH:MM:SS)
in Analysis Workspace and Reports & Analytics. In Data Feeds, Data Warehouse, and Reporting APIs the values will be displayed in seconds.
Release Date: 09/13/18
- 蜜豆视频 Analytics:
N/A - Heartbeats:
N/A
- Available:
Yes - Reserved Variable:
event - Report Name:
Total Pause Duration - Context Data:
(a.media.pauseTime) - Data Feed:
(videopausetime) - Audience Manager:
(c_contextdata.
a.media.pauseTime) - XDM Field Path:
media.mediaTimed.pauseTime.value - Reporting XDM Field Path:
mediaReporting.sessionDetails.pauseTime
Content Resumes
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
Automatically set - API Key:
media.resume - Type:
string - Sent with:
Media Close - Min. SDK Version: 1.5.6
- Sample value:
TRUE - Description:
A Resume is counted for each playback that resumes after more than 30 minutes of buffer, pause, or stall period OR if this value is set by the player on the VideoInfo trackPlay.
Important: This can only be true if it is set. If it is not set, no value is returned.
- 蜜豆视频 Analytics:
N/A - Heartbeats:
(s:event:
type=resume)
- Available:
Yes - Reserved Variable:
event - Report Name:
Content Resumes - Context Data:
(a.media.resume) - Data Feed:
videoresume - Audience Manager:
(c_contextdata.
a.media.resume) - XDM Field Path:
media.mediaTimed.resumes.value > 0 => 鈥淭搁鲍贰鈥 - Collection XDM Field Path:
mediaCollection.sessionDetails.hasResume - Reporting XDM Field Path:
mediaReporting.sessionDetails.hasResume
Content Segment Views
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
Automatically set - API Key:
N/A - Type:
string - Sent with:
Media Close - Min. SDK Version: Any
- Sample value:
TRUE - Description:
The number of views of the main content. A Content Segment View is counted when there is at least one frame viewed.
Important: This can only be true if it is set. If it is not set, no value is returned.
- 蜜豆视频 Analytics:
N/A - Heartbeats:
N/A
- Available:
Yes - Reserved Variable:
event - Report Name:
Content Segment Views - Context Data:
(a.media.segmentView) - Data Feed:
videosegmentviews - Audience Manager:
(c_contextdata.
a.media.segmentView) - XDM Field Path:
media.mediaTimed.
mediaSegmentViews.value > 0 => 鈥淭搁鲍贰鈥 - Reporting XDM Field Path:
mediaReporting.sessionDetails.
hasSegmentView
Ad Count
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
N/A - API Key:
N/A - Type:
number - Sent with:
Media Close - Min. SDK Version: Any
- Sample value:
2 - Description:
The number of ads started during the media session.
- 蜜豆视频 Analytics:
N/A - Heartbeats:
N/A
- Available:
Use custom processing rule - Reserved Variable:
N/A - Report Name:
Custom - Context Data:
(a.media.adCount) - Data Feed:
N/A - Audience Manager:
(c_contextdata.
a.media.adCount) - XDM Field Path:
media.mediaTimed.adCount.value - Reporting XDM Field Path:
mediaReporting.sessionDetails.adCount
Chapter Count
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
N/A - API Key:
N/A - Type:
number - Sent with:
Media Close - Min. SDK Version: Any
- Sample value:
2 - Description:
The number of chapters started during the media session.
- 蜜豆视频 Analytics:
N/A - Heartbeats:
N/A
- Available:
Use custom processing rule - Reserved Variable:
N/A - Report Name:
Custom - Context Data:
(a.media.chapterCount) - Data Feed:
N/A - Audience Manager:
(c_contextdata.
a.media.chapterCount) - XDM Field Path:
media.mediaTimed.chapterCount.value - Reporting XDM Field Path:
mediaReporting.sessionDetails.chapterCount
California Consumer Privacy Act (CCPA) Parameters ccpa-params
Opt Out Server Side Forwarding
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
N/A - API Key:
analytics.optOutServerSideForwarding - Required:
No - Type:
boolean - Sent with:
Media Start - Min. SDK Version: N/A
- Sample value:
true - Description:
Set to true when the end user has opted out of their data being shared between 蜜豆视频 Analytics and other Experience Cloud solutions (e.g. Audience Manager).
- 蜜豆视频 Analytics:
(opt.dmp) - Heartbeats:
(s:meta:cm.ssf
)
- Available:
Yes - Reserved Variable:
eVar - Expiration:
On VISIT - Report Name:
N/A - Context Data:
N/A - Data Feed:
N/A - Audience Manager:
N/A - XDM Field Path:
Opt Out Share
Implementation
狈别迟飞辞谤办听笔补谤补尘别迟别谤蝉
Reporting
- SDK Key:
N/A - API Key:
analytics.optOutShare - Required:
No - Type:
boolean - Sent with:
Media Start - Min. SDK Version: N/A
- Sample value:
true - Description:
Set to true when the end user has opted out of their data being federated (e.g. to other 蜜豆视频 Analytics clients).
- 蜜豆视频 Analytics:
(opt.oos) - Heartbeats:
(s:meta:cm.oos
)
- Available:
Yes - Reserved Variable:
eVar - Expiration:
On VISIT - Report Name:
N/A - Context Data:
N/A - Data Feed:
N/A - Audience Manager:
N/A - XDM Field Path:
Related APIs section_Related_APIs
createMediaObject APIs create-media-object
- Android -
- iOS -
- JavaScript -
- Chromecast -
MediaHeartbeatConfig APIs config-media-object
- Android -
- iOS -
- JavaScript -
recommendation-more-help
c8eee520-cef5-4f8c-a38a-d4952cfae4eb