里程碑概述 milestone-overview

视频量度

变量类型

描述

内容

eVar
默认过期：访问

（必需）收集实施中指定的视频名称。

内容类型

eVar
默认过期：页面查看

收集由访客查看的内容类型相关数据。由视频测量发送的点击量会被分配 video. 内容类型。
无需专门为视频跟踪保留此变量。通过使用此相同变量让其他内容报告内容类型，您可以分析访客在不同内容类型之间的分布。例如，您可以使用此变量通过 article 或 product page 之类的值标记其他内容类型。
从视频测量的角度来看，“内容类型”**​允许您识别视频访客，从而计算视频转化率。

内容逗留时间

事件
类型：计数器

以秒为单位，计算自上次数据收集流程（图像请求）以来，观看视频所花费的时间。

视频初始化

事件
类型：计数器

表明访客已查看了视频的某些部分。但是，它并不提供有关访客查看了视频中的多少内容或哪一部分的信息。

视频结束

事件
类型：计数器

表明用户已查看了完整的视频。默认情况下，完整的事件会在视频结束前 1 秒进行测量。
在实施过程中，您可以指定希望在距离视频结束有多少秒时被视为查看完成。对于直播视频和其他没有定义结尾的流，您可以指定一个测量完成的自定义点。例如，在查看特定时间后。

变量

描述

语法：

s.Media.trackUsingContextData = true;
此选项可启用集成的视频跟踪。如果设置为 true，则媒体模块会生成用于媒体跟踪的上下文数据，而不是旧版 pev3。
可使用 Media.contextDataMapping 将上下文数据映射到选定的 eVar 和 event。
默认值：false

语法：

s.Media.contextDataMapping = {
     "a.media.name":"eVar2, prop2",
     "a.media.segment":"eVar3",
     "a.contentType":"eVar1",
     "a.media.timePlayed":"event3",
     "a.media.view":"event1",
     "a.media.segmentView":"event2",
     "a.media.complete":"event7",
     "a.media.milestones":{
         25:"event4",
         50:"event5",
         75:"event6"
     }
};

一个对象，可定义映射到要用于视频测量的 eVar 和 event 的变量。此对象必须映射以下字段：

a.media.name：（必需）在变量中填充视频名称。提供您选择用来存储视频名称的 eVar，以及要用于视频路径的“自定义分析视频”变量 (s.prop)。以逗号分隔列表的形式提供值。

a.media.segment：（可选）要用于存储媒体区段名称的 eVar。a.contentType：（可选）要用于存储视频值的 eVar，其中包含已启用的用于生成视频访问和访客报表的访问和访客跟踪。您选择的变量可能已用于存储文章幻灯片或产品页面之类的数据

a.media.view：（必需）要用于计数媒体查看次数的事件。

a.media.segmentView：（可选）要用于计数区段查看次数的事件。

a.media.complete：（可选）要用于计数完整查看次数的事件。

a.media.timePlayed：（可选，但强烈推荐）要用于存储已播放视频秒数的数字事件。

a.media.milestones：（可选）一个对象，可将 s.Media.trackMilestones 里程碑映射到计数器事件。如果您定义里程碑，则应将 Media.segmentByMilestones 设置为 true。

广告跟踪 要跟踪广告，可使用以下上下文数据变量：
a.media.ad.name：（必需）在变量中填充广告名称。提供您选择用来存储广告名称的 eVar，以及要用于路径的“自定义分析视频”变量 (s.prop)。以逗号分隔列表的形式提供值。

a.media.ad.pod： ​广告在主内容中播放的位置。

a.media.ad.podPosition：广告在面板中播放的位置。

a.media.ad.CPM：应用于此播放的 CPM 或加密 CPM（具有前缀“~”）。

a.media.ad.view： ​与 a.media.view 的工作方式相同

a.media.ad.clicked： ​计数广告的点击次数（Media.click 调用）

a.media.ad.timePlayed： ​与 a.media.timePlayed 的工作方式相同

a.media.ad.complete： ​与 a.media.complete 的工作方式相同 a.media.ad.segment：与 a.media.segment 的工作方式相同

a.media.ad.segmentView： ​与 a.media.segmentView 的工作方式相同

a.media.ad.milestones： ​与 a.media.milestones 的工作方式相同

a.media.ad.offsetMilestones： ​与 a.media.offsetMilestones 的工作方式相同

语法：

s.Media.trackVars =
   "events, prop2, eVar1, eVar2, eVar3";

在您的视频跟踪代码中设置的所有变量的逗号分隔列表。

语法：

s.Media.trackEvents =
   "event1, event2, event3, event4, event5, event6, event7"

在您的视频跟踪代码中设置的所有事件的逗号分隔列表。

变量

描述

语法：

s.Media.autoTrack = true

为支持的播放器启用自动跟踪功能。支持的播放器包括：

• Open Source Media Framework (OSMF)
• FLVPlayback（Flash Professional 中的导入视频向导创建的视频播放器）
• Silverlight
• MediaDisplay
• MediaPlayback
• Brightcove API 版本 2 和 3（请参阅 Brightcove）
• 使用 JavaScript 的 Windows Media Player、Quicktime 或 Real Player

如果您没有使用以上任何一款播放器，则可以使用 Media.open、Media.play、Media.stop 和 Media.close 来跟踪播放器事件。

语法：

s.Media.autoTrackNetStreams = true

Flash 10.3 在 NetStream 组件中引入了新功能，以增强视频跟踪。如果您使用自定义 Flash NetStream 播放器，则可以启用此变量以实现类似于 autoTrack 的功能。此方法要求在 Flash 10.3 或更高版本中查看视频。

语法：



s.Media.completeByCloseOffset = true

此设置允许您在视频实际结束前几秒计为一次完整的视频查看。

该事件基于 completeCloseOffsetThreshold 中指定的秒数发送。如果视频播放器从不报告等于视频长度的偏移，您便可以通过此方法测量结束。

默认情况下，此值设置为 true，阈值设置为 1 秒。使用这些默认设置，结束事件会在视频结束前 1 秒发送。

语法：

s.Media.completeCloseOffsetThreshold = 1

此阈值允许您在视频实际结束前几秒计为一次完整的视频查看。Media.completeByCloseOffset 必须设置为 true 才能使用此阈值。

您提供的整数值可决定在关闭时距离视频长度的偏移秒数，并且这仍将计为一次结束。如果视频播放器从不报告等于视频长度的偏移，您便可以通过此方法测量结束。

默认的阈值为 1 秒。

语法：

s.Media.playerName = "Custom Player Name"

指定一个自定义视频播放器名称。

语法：

s.Media.trackSeconds = 15

定义在视频播放时将视频跟踪数据发送到 Adobe 数据收集服务器的间隔，以秒为单位。此值必须以 5 秒为增量进行设置。

启用 Media.trackSeconds 只会触发在 Media.contextDataMapping 中定义的事件。要发送为视频测量指定的变量以外的其他变量，您必须使用 Media.Monitor.

跟踪里程碑，以视频长度的百分比表示。

语法：

s.Media.trackMilestones = "25, 50, 75";

定义将视频跟踪数据发送到 Adobe 数据收集服务器的间隔，以视频长度的百分比表示。以逗号分隔整数列表的形式指定里程碑。例如：10 = 10%，23 = 23%。

由于这些里程碑是视频中的固定时间点，因此如果访客查看超过了 10% 里程碑，然后快退并再次超过 10% 里程碑，则媒体模块会发送跟踪数据多次。同样，如果访客快进超过了某个里程碑，则媒体模块不会发送该里程碑的跟踪数据。

启用 Media.trackMilestones 只会触发在 Media.contextDataMapping 中定义的事件。要发送为视频测量指定的变量以外的其他变量，您必须使用 Media.Monitor.

跟踪里程碑，以自视频开始后经过的秒数表示。

语法：

s.Media.trackOffsetMilestones = "20, 40, 60";

定义将视频跟踪数据发送到 Adobe 数据收集服务器的间隔，以自视频开始后经过的秒数表示。以逗号分隔整数列表的形式指定里程碑。例如：20 = 20 秒，40 = 40 秒。

由于这些里程碑是视频中的固定时间点，因此如果访客查看超过了 20 秒里程碑，然后快退并再次超过 20 秒里程碑，则媒体模块会发送跟踪数据多次。同样，如果访客快进超过了某个里程碑，则媒体模块不会发送该里程碑的跟踪数据。

启用 Media.trackOffsetMilestones 只会触发在 Media.contextDataMapping 中定义的事件。要发送为视频测量指定的变量以外的其他变量，您必须使用 Media.Monitor.

语法：

s.Media.segmentByMilestones = true;

根据媒体长度和在 Media.trackMilestones 中指定的里程碑，自动生成区段名称、区段编号和区段长度数据

如果使用 autoTrack，则按里程碑进行划分是定义区段的唯一方法。

默认值：false

语法：

s.Media.segmentByOffsetMilestones = true;

根据媒体长度和在 Media.trackOffsetMilestones 中指定的里程碑，自动生成区段名称、区段编号和区段长度数据

如果使用 autoTrack，则按里程碑进行划分是定义区段的唯一方法。

默认值：false

变量

描述

语法：

s.Media.adTrackSeconds = 15;

定义在视频播放时将视频广告跟踪数据发送到 Adobe 数据收集服务器的间隔，以秒为单位。此值必须以 5 秒为增量进行设置。

启用 Media.adTrackSeconds 只会触发在 Media.contextDataMapping 中定义的事件。要发送为视频测量指定的变量以外的其他变量，您必须使用 Media.monitor。

跟踪广告里程碑，以广告长度的百分比表示。

语法：

s.Media.adTrackMilestones = "25, 50, 75";

定义将广告跟踪数据发送到 Adobe 数据收集服务器的间隔，以广告长度的百分比表示。以逗号分隔整数列表的形式指定里程碑。例如：10 = 10%，23 = 23%。

由于这些里程碑是广告中的固定时间点，因此如果访客查看超过了 10% 里程碑，然后快退并再次超过 10% 里程碑，则媒体模块会发送跟踪数据多次。同样，如果访客快进超过了某个里程碑，则媒体模块不会发送该里程碑的跟踪数据。

启用 Media.adTrackMilestones 只会触发在 Media.contextDataMapping 中定义的事件。要发送为视频测量指定的变量以外的其他变量，您必须使用 Media.monitor。

跟踪广告里程碑，以自广告开始后经过的秒数表示。

语法：

s.Media.adTrackOffsetMilestones = "20, 40, 60";

定义将广告跟踪数据发送到 Adobe 数据收集服务器的间隔，以自广告开始后经过的秒数表示。以逗号分隔整数列表的形式指定里程碑。例如：20 = 20 秒，40 = 40 秒。

由于这些里程碑是广告中的固定时间点，因此如果访客查看超过了 20 秒里程碑，然后快退并再次超过 20 秒里程碑，则媒体模块会发送跟踪数据多次。同样，如果访客快进超过了某个里程碑，则媒体模块不会发送该里程碑的跟踪数据。

启用 Media.adTrackOffsetMilestones 只会触发在 Media.contextDataMapping 中定义的事件。要发送为视频测量指定的变量以外的其他变量，您必须使用 Media.monitor。

语法：

s.Media.adSegmentByMilestones = true;

根据媒体长度和在 Media.adTrackMilestones 中指定的里程碑，自动生成区段名称、区段编号和区段长度数据

如果使用 autoTrack，则按里程碑进行划分是定义区段的唯一方法。

默认值：false

语法：

s.Media.adSegmentByOffsetMilestones = true;

根据媒体长度和在 Media.adTrackOffsetMilestones 中指定的里程碑，自动生成区段名称、区段编号和区段长度数据

如果使用 autoTrack，则按里程碑进行划分是定义区段的唯一方法。

默认值：false

方法

描述

语法：

s.Media.open(mediaName, mediaLength, mediaPlayerName)

准备好媒体模块以收集视频跟踪数据。此方法采用以下参数：

• mediaName：（必需）您希望在视频报表中显示的视频名称。
• mediaLength：（必需）视频的长度，以秒为单位。
• mediaPlayerName：（必需）您希望在视频报表中显示的用来查看视频的媒体播放器名称。

语法：

s.Media.openAd(name, length, playerName, parentName,
parentPod, parentPodPosition, CPM)

准备好媒体模块以收集广告跟踪数据。此方法采用以下参数：

• name：（必需）广告的名称或 ID。
• length：（必需）广告的长度。
• playerName：（必需）用来查看广告的媒体播放器名称。
• parentName： ​广告被嵌入到的主内容的名称或 ID。
• parentPod： ​广告在主内容中播放的位置。
• parentPodPosition： ​广告在面板中播放的位置。
• CPM： ​应用于此播放的 CPM 或加密 CPM（具有前缀“~”）。

语法：

s.Media.click(name, offset)

跟踪广告何时在视频中被点击。此方法采用以下参数：

• name： ​广告的名称。此名称必须匹配 Media.openAd 中使用的名称。
• offset： ​发生单击时广告的偏移量。

语法：

s.Media.close(mediaName)

结束视频数据收集并向 Adobe 数据收集服务器发送信息。在视频的结尾调用此方法。此方法采用以下参数：

mediaName： ​视频的名称。此名称必须匹配 Media.open 中使用的名称。

语法：

s.Media.complete(name, offset)

此方法可手动跟踪结束事件。如果您在触发事件时需要使用的特殊逻辑无法使用 Media.completeByCloseOffset 进行处理，则可以使用此方法。

例如，如果您测量的实时流未定义结尾，您可能会在用户查看实时流长达 X 秒后触发一次结束。您可以使用基于内容长度和类型的百分比计算来测量完成情况。此方法采用以下参数：

• mediaName： ​视频的名称。此名称必须匹配 Media.open 中使用的名称。
• mediaOffset： ​应发送完整事件时视频的秒数。从零秒开始，指定基于视频的偏移。
  
  如果您的媒体播放器使用毫秒跟踪，请确保将此值转化为调用 Media.complete 之前的秒数。

如果您计划手动调用 complete，请设置

s.Media.completeByCloseOffset = false。

语法：

s.Media.play(name, offset, segmentNum, segment, segmentLength)

无论视频何时开始播放，都调用此方法。在使用手动视频测量时，您可以在发送视频测量数据时提供当前区段数据。

无论出于什么原因，如果您的播放器从一个区段更改为另一个区段，则应该调用 Media.stop 和 Media.play。

此方法采用以下参数：

mediaName： ​视频的名称。此名称必须匹配 Media.open 中使用的名称。

mediaOffset: ​开始播放的视频中的秒数。从零秒开始，指定基于视频的偏移。如果您的媒体播放器使用毫秒跟踪，请确保将此值转化为调用 Media.play 之前的秒数。

segmentNum：（可选）当前区段编号，市场营销报告使用它对报表中显示的区段进行排序。segmentNum 参数必须大于零。

segment：（可选）当前区段名称。

segmentLength：（可选）

当前区段长度，以秒为单位。

例如：

s.Media.play("My Video", 1800, 2,"Second Quarter", 1800)

s.Media.play("My Video", 0, 1,"Preroll", 30)

语法：

s.Media.stop(mediaName, mediaOffset)

跟踪指定视频的停止事件（停止、暂停等）。此方法采用以下参数：

• mediaName： ​视频的名称。此名称必须匹配 Media.open 中使用的名称。
• mediaOffset： ​停止或暂停事件在视频中发生的秒数。从零秒开始，指定基于视频的偏移。

语法：

s.Media.monitor(s, media)

Silverlight 语法：

s.Media.monitor =
   new AppMeasurement_Media_Monitor(myMediaMonitor);

Silverlight 应用程序媒体监视器可实施 Objective-C 代理设计模式。myMediaMonitor 类方法采用 s 和 media 参数。

使用此方法可发送其他视频量度。您可以设置其他变量（prop、eVar、event），并基于所播放视频的当前状态使用 Media.track 发送它们。

请参阅使用 Media.monitor 测量其他量度。

此方法采用以下参数：

s：AppMeasurement 实例（或 JavaScript s 对象）。

media： ​包含提供视频状态的成员的对象。这些成员包括：

• media.name: 视频的名称。此名称必须匹配 Media.open 中使用的名称；
• media.length: 在对 Media.open 的调用中给定的视频长度，以秒为单位；
• media.playerName: 在对 Media.open 的调用中给定的媒体播放器名称；
• media.openTime: 一个 NSDate 对象，其中包含有关何时调用了 Media.open 的数据；
• media.offset: 视频中的当前偏移，以秒为单位（视频中的实际时间点）。偏移从零开始（视频的第一秒为零秒）；
• media.percent: 已播放视频的当前百分比，基于视频长度和当前偏移；
• media.timePlayed: 截至目前播放的总秒数；
• media.eventFirstTime: 指明这是否是第一次为该视频调用此媒体事件；
• media.mediaEvent: 一个字符串，其中包含可导致监视器调用的事件名称。

media.mediaEvent 事件：

• OPEN: 通过 Media.autoTrack 首次观察到播放，或者调用 Media.play 时；
• CLOSE: 通过 Media.autoTrack 观察到播放在视频完成时结束，或者调用 Media.close 时；
• PLAY: 通过 Media.autoTrack 观察到播放在暂停或推移后恢复，或者第二次调用 Media.play 时；
• STOP: 通过 Media.autoTrack 观察到播放由于暂停或开始推移而停止，或者调用 Media.stop 时；
• MONITOR: 我们的自动监视检查正在播放的视频的状态（每秒检查一次）；
• SECONDS: 处于由 Media.trackSeconds 变量定义的秒数间隔时；
• MILESTONE: 处于由 Media.trackMilestones 变量定义的里程碑时；

语法：

s.Media.track(mediaName)

立即发送当前视频状态，以及您定义的任何 Media.trackVars 和 Media.trackEvents。此方法在 Media.monitor 内使用。

请参阅使用 Media.monitor 测量其他量度。

在调用此方法之前，应对视频调用 Media.open 和 Media.play。此方法采用以下参数：

• mediaName： ​视频的名称。此名称必须匹配 Media.open 中使用的名称。

此方法是在播放视频时发送其他变量的唯一方法。它将秒数间隔和百分比里程碑计数器重置为零以防止多次跟踪点击。