文档AnalyticsMedia Analytics 指南

播放器状态参数 player-state-parameters

Last update: Tue Jun 06 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

创建对象：

  • User
  • Admin
  • Developer

本主题将介绍 Adobe 通过解决方案变量收集的播放器状态数据列表。

表格数据描述：

  • 实施： ​关于实施值和要求的信息

    • 密钥 - 在应用程序中手动设置或由 Adobe Media SDK 自动设置的变量。
    • 必需 - 指示基本视频跟踪是否需要该参数。
    • 类型 - 指定要设置的变量的类型：字符串或数字。
    • 发送条件 - 指示何时发送数据：媒体开始 ​表示在媒体开始播放时发送分析调用；广告开始 ​表示在广告等开始播放时发送分析调用；关闭 ​调用表示在媒体会话或广告、章节等结束时直接从心率服务器向分析服务器发送经过汇编的分析调用。在网络数据包调用中无法使用关闭调用。
    • 最低 SDK 版本 - 指示您访问该参数所需的 SDK 版本。
    • 示例值 - 提供常用变量用法的示例。

  • 网络参数： ​显示传递到 Adobe Analytics 或心率服务器的值。此列显示网络调用中由 Adobe Media SDK 生成的参数的名称。

  • 报告： ​有关如何查看和分析视频数据的信息。

    • 可用 - 指示在默认情况下数据在报表中可用（是），还是需要自定义设置（自定义）
    • 保留的变量 - 指示数据是作为保留变量中的事件、eVar、prop 还是分类而捕获的。
    • 报表名称 - 变量的 Adobe Analytics 报表名称
    • 上下文数据 - 传递到报表服务器并用于处理规则的 Adobe Analytics 上下文数据的名称。
    • 数据源 - Clickstream 或实时流数据源中的变量的列名称
    • Audience Manager - Adobe Audience Manager 中的特征名称
IMPORTANT
请勿更改下面列出的在“报表/保留的变量”下描述为“分类”的任何变量的分类名称。
在启用报表包进行媒体跟踪后，将定义媒体分类。Adobe 会不时添加新属性，如果添加了新属性，客户必须重新启用其报表包才能访问新的媒体属性。在更新过程中，Adobe 会通过检查变量名称来确定是否启用了分类。如果任何变量名称缺失，Adobe 会再次添加缺失的变量名称。

播放器状态属性 player-state-properties

播放器状态跟踪功能可以附加到音频或视频流。标准化的播放器状态跟踪量度可存储为解决方案变量。标准状态为：fullscreen、mute、closedCaptioning、pictureInPicture 和 inFocus。

全屏属性

受全屏影响的流数量

实施
网络参数
报表
  • SDK 密钥
    ​自动设置
  • API 密钥
    ​不适用
  • 必需
    ​否
  • 类型
    ​数值
  • 发送条件
    ​媒体关闭
  • 最低 SDK 版本
    3.0
  • 示例值
    TRUE
  • 描述
    ​受全屏影响的流数量。只有在播放会话期间出现至少一次全屏状态时，此量度才设置为 1。
    重要信息
    如果设置此事件，则唯一可能的值为 TRUE。如果不设置此事件，则不会发送任何值。
  • Adobe Analytics
    a.media.states.fullscreen.set
  • 心率
    ​不适用
  • 可用
    ​是
  • 保留的变量
    event
  • 报表名称
    ​受全屏影响的流数量
  • 上下文数据
    (a.media.states.fullscreen.set
  • 数据源
    videostatefullscreen
  • Audience Manager
    c_contextdata.a.media.states.fullscreen.set
  • XDM 字段路径：
    media.mediaTimed.primaryAssetViewDetails.
    fullScreen.playerStateSet
  • 报告 XDM 字段路径：
    mediaReporting.playerStateData.isSet

全屏计数

实施
网络参数
报表
  • SDK 密钥
    ​自动设置
  • API 密钥
    ​不适用
  • 必需
    ​否
  • 类型
    ​数值
  • 发送条件
    ​媒体关闭
  • 最低 SDK 版本
    3.0
  • 示例值
    TRUE
  • 描述
    ​显示全屏的次数。只有在播放会话期间出现至少一次全屏状态时，此量度才设置为 1。
    重要信息
    ​如果设置了此事件，则计数等于视频处于“全屏”状态的次数。如果不设置此事件，则不会发送任何值。
  • Adobe Analytics
    a.media.states.fullscreen.count
  • 心率
    ​不适用
  • 可用
    ​是
  • 保留的变量
    event
  • 报表名称
    ​全屏计数
  • 上下文数据
    a.media.states.fullscreen.count
  • 数据源
    videostatefullscreencount
  • Audience Manager
    c_contextdata.media.states.fullscreen.count
  • XDM 字段路径：
    media.mediaTimed.primaryAssetViewDetails.
    fullScreen.playerStateCount
  • 报告 XDM 字段路径：
    mediaReporting.playerStateData.count

全屏总时长

实施
网络参数
报表
  • SDK 密钥
    ​自动设置
  • API 密钥
    ​不适用
  • 必需
    ​否
  • 类型
    ​数值
  • 发送条件
    ​媒体关闭
  • 最低 SDK 版本
    3.0
  • 示例值
    TRUE
  • 描述
    ​显示全屏的时长。只有在播放会话期间出现至少一次全屏状态时，此量度才设置为 1。
    重要信息
    ​如果设置了此事件，则时长等于视频处于“全屏”状态的时长。如果不设置此事件，则不会发送任何值。
  • Adobe Analytics
    a.media.states.fullscreen.time
  • 心率
    ​不适用
  • 可用
    ​是
  • 保留的变量
    event
  • 报表名称
    ​全屏持续总时长
  • 上下文数据
    a.media.states.fullscreen.time
  • 数据源
    videostatefullscreentime
  • Audience Manager
    c_contextdata.media.states.fullscreen.time
  • XDM 字段路径：
    media.mediaTimed.primaryAssetViewDetails.
    fullScreen.playerStateTime
  • 报告 XDM 字段路径：
    mediaReporting.playerStateData.time

隐藏式字幕属性

受隐藏式字幕影响的流数量

实施
网络参数
报表
  • SDK 密钥
    ​自动设置
  • API 密钥
    ​不适用
  • 必需
    ​否
  • 类型
    ​数值
  • 发送条件
    ​媒体关闭
  • 最低 SDK 版本
    3.0
  • 示例值
    TRUE
  • 描述
    ​受隐藏式字幕影响的流数量。只有在播放会话期间出现至少一次隐藏式字幕状态时，此量度才设置为 1。
    重要信息
    如果设置此事件，则唯一可能的值为 TRUE。如果不设置此事件，则不会发送任何值。
  • Adobe Analytics
    a.media.states.closedcaptioning.set
  • 心率
    ​不适用
  • 可用
    ​是
  • 保留的变量
    event
  • 报表名称
    ​受隐藏式字幕影响的流数量
  • 上下文数据
    a.media.states.closedcaptioning.set
  • 数据源
    videostateclosedcaptioning
  • Audience Manager
    c_contextdata.a.media.states.
    closedcaptioning.set
  • XDM 字段路径：
    media.mediaTimed.primaryAssetViewDetails.
    closeCaption.playerStateSet
  • 报告 XDM 字段路径：
    mediaReporting.playerStateData.isSet

隐藏式字幕计数

实施
网络参数
报表
  • SDK 密钥
    ​自动设置
  • API 密钥
    ​不适用
  • 必需
    ​否
  • 类型
    ​数值
  • 发送条件
    ​媒体关闭
  • 最低 SDK 版本
    3.0
  • 示例值
    TRUE
  • 描述
    ​隐藏式字幕显示的次数。只有在播放会话期间出现至少一次隐藏式字幕状态时，此量度才设置为 1。
    重要信息
    ​如果设置了此事件，则计数等于视频处于“隐藏式字幕”状态的次数。如果不设置此事件，则不会发送任何值。
  • Adobe Analytics
    a.media.states.closedcaptioning.count
  • 心率
    ​不适用
  • 可用
    ​是
  • 保留的变量
    event
  • 报表名称
    ​隐藏式字幕计数
  • 上下文数据
    a.media.states.closedcaptioning.count
  • 数据源
    videostateclosedcaptioningcount
  • Audience Manager
    c_contextdata.media.states.
    closedcaptioning.count
  • XDM 字段路径：
    media.mediaTimed.primaryAssetViewDetails.
    closeCaption.playerStateCount
  • 报告 XDM 字段路径：
    mediaReporting.playerStateData.count

隐藏式字幕总时长

实施
网络参数
报表
  • SDK 密钥
    ​自动设置
  • API 密钥
    ​不适用
  • 必需
    ​否
  • 类型
    ​数值
  • 发送条件
    ​媒体关闭
  • 最低 SDK 版本
    3.0
  • 示例值
    TRUE
  • 描述
    ​隐藏式字幕显示的时长。只有在播放会话期间出现至少一次全屏状态时，此量度才设置为 1。
    重要信息
    ​如果设置了此事件，则时长等于视频处于“隐藏式字幕”状态的时长。如果不设置此事件，则不会发送任何值。
  • Adobe Analytics
    a.media.states.closedcaptioning.time
  • 心率
    ​不适用
  • 可用
    ​是
  • 保留的变量
    event
  • 报表名称
    ​隐藏式字幕总持续时长
  • 上下文数据
    a.media.states.closedcaptioning.time
  • 数据源
    videostateclosedcaptioningtime
  • Audience Manager
    c_contextdata.media.states.
    closedcaptioning.time
  • XDM 字段路径：
    media.mediaTimed.primaryAssetViewDetails.
    closeCaption.playerStateTime
  • 报告 XDM 字段路径：
    mediaReporting.playerStateData.time

静音属性

受静音影响的流数量

实施
网络参数
报表
  • SDK 密钥
    ​自动设置
  • API 密钥
    ​不适用
  • 必需
    ​否
  • 类型
    ​数值
  • 发送条件
    ​媒体关闭
  • 最低 SDK 版本
    3.0
  • 示例值
    TRUE
  • 描述
    ​受静音影响的流数量。只有在播放会话期间出现至少一次静音状态时，此量度才设置为 1。
    重要信息
    如果设置此事件，则唯一可能的值为 TRUE。如果不设置此事件，则不会发送任何值。
  • Adobe Analytics
    a.media.states.mute.set
  • 心率
    ​不适用
  • 可用
    ​是
  • 保留的变量
    event
  • 报表名称
    ​受静音影响的流数量
  • 上下文数据
    a.media.states.mute.set
  • 数据源
    videostatemute
  • Audience Manager
    c_contextdata.a.media.states.mute.set
  • XDM 字段路径：
    media.mediaTimed.primaryAssetViewDetails.
    mute.playerStateSet
  • < 报告 XDM 字段路径：
    mediaReporting.playerStateData.isSet

静音计数

实施
网络参数
报表
  • SDK 密钥
    ​自动设置
  • API 密钥
    ​不适用
  • 必需
    ​否
  • 类型
    ​数值
  • 发送条件
    ​媒体关闭
  • 最低 SDK 版本
    3.0
  • 示例值
    TRUE
  • 描述
    “静音”显示的次数。只有在播放会话期间出现至少一次静音状态时，此量度才设置为 1。
    重要信息
    ​如果设置了此事件，则计数等于视频处于“静音”状态的次数。如果不设置此事件，则不会发送任何值。
  • Adobe Analytics
    a.media.states.mute.count
  • 心率
    ​不适用
  • 可用
    ​是
  • 保留的变量
    event
  • 报表名称
    ​静音计数
  • 上下文数据
    a.media.states.mute.count
  • 数据源
    videostatemutecount
  • Audience Manager
    c_contextdata.media.states.mute.count
  • XDM 字段路径：
    media.mediaTimed.primaryAssetViewDetails.mute.playerStateCount
  • 报告 XDM 字段路径：
    mediaReporting.playerStateData.count

静音总时长

实施
网络参数
报表
  • SDK 密钥
    ​自动设置
  • API 密钥
    ​不适用
  • 必需
    ​否
  • 类型
    ​数值
  • 发送条件
    ​媒体关闭
  • 最低 SDK 版本
    3.0
  • 示例值
    TRUE
  • 描述
    “静音”显示的时长。只有在播放会话期间出现至少一次静音状态时，此量度才设置为 1。
    重要信息
    ​如果设置了此事件，则时长等于视频处于“静音”状态的时长。如果不设置此事件，则不会发送任何值。
  • Adobe Analytics
    a.media.states.mute.time
  • 心率
    ​不适用
  • 可用
    ​是
  • 保留的变量
    event
  • 报表名称
    ​静音总持续时长
  • 上下文数据
    a.media.states.mute.time
  • 数据源
    videostatemutetime
  • Audience Manager
    c_contextdata.media.states.mute.time
  • XDM 字段路径：
    media.mediaTimed.primaryAssetViewDetails.
    mute.playerStateTime
  • 报告 XDM 字段路径：
    mediaReporting.playerStateData.time

画中画属性

受画中画影响的流数量

实施
网络参数
报表
  • SDK 密钥
    ​自动设置
  • API 密钥
    ​不适用
  • 必需
    ​否
  • 类型
    ​数值
  • 发送条件
    ​媒体关闭
  • 最低 SDK 版本
    3.0
  • 示例值
    TRUE
  • 描述
    ​受画中画影响的流数量。只有在播放会话期间出现至少一次画中画状态时，此量度才设置为 1。
    重要信息
    如果设置此事件，则唯一可能的值为 TRUE。如果不设置此事件，则不会发送任何值。
  • Adobe Analytics
    a.media.states.pictureinpicture.set
  • 心率
    ​不适用
  • 可用
    ​是
  • 保留的变量
    event
  • 报表名称
    ​受画中画影响的流数量
  • 上下文数据
    a.media.states.pictureinpicture.set
  • 数据源
    videostatepictureinpicture
  • Audience Manager
    c_contextdata.a.media.states.
    pictureinpicture.set
  • XDM 字段路径：
    media.mediaTimed.primaryAssetViewDetails.
    pictureInPicture.playerStateSet
  • 报告 XDM 字段路径：
    mediaReporting.playerStateData.isSet

画中画计数

实施
网络参数
报表
  • SDK 密钥
    ​自动设置
  • API 密钥
    ​不适用
  • 必需
    ​否
  • 类型
    ​数值
  • 发送条件
    ​媒体关闭
  • 最低 SDK 版本
    3.0
  • 示例值
    TRUE
  • 描述
    ​显示画中画的次数。只有在播放会话期间出现至少一次画中画状态时，此量度才设置为 1。
    重要信息
    如果设置此事件，则计数等于视频处于“画中画”状态的次数。如果不设置此事件，则不会发送任何值。
  • Adobe Analytics
    a.media.states.pictureinpicture.count
  • 心率
    ​不适用
  • 可用
    ​是
  • 保留的变量
    event
  • 报表名称
    ​画中画计数
  • 上下文数据
    a.media.states.pictureinpicture.count
  • 数据源
    videostatepictureinpicturecount
  • Audience Manager
    c_contextdata.media.states.
    pictureinpicture.count
  • XDM 字段路径：
    media.mediaTimed.primaryAssetViewDetails.
    pictureInPicture.playerStateCount
  • 报告 XDM 字段路径：
    mediaReporting.playerStateData.count

画中画总时长

实施
网络参数
报表
  • SDK 密钥
    ​自动设置
  • API 密钥
    ​不适用
  • 必需
    ​否
  • 类型
    ​数值
  • 发送条件
    ​媒体关闭
  • 最低 SDK 版本
    3.0
  • 示例值
    TRUE
  • 描述
    ​显示画中画的时长。只有在播放会话期间出现至少一次画中画状态时，此量度才设置为 1。
    重要信息
    如果设置了此事件，则时长等于视频处于“画中画”状态的时长。如果不设置此事件，则不会发送任何值。
  • Adobe Analytics
    a.media.states.pictureinpicture.time
  • 心率
    ​不适用
  • 可用
    ​是
  • 保留的变量
    event
  • 报表名称
    ​画中画总持续时长
  • 上下文数据
    a.media.states.pictureinpicture.time
  • 数据源
    videostatepictureinpicturetime
  • Audience Manager
    c_contextdata.media.states.
    pictureinpicture.time
  • XDM 字段路径：
    media.mediaTimed.primaryAssetViewDetails.
    pictureInPicture.playerStateTime
  • 报告 XDM 字段路径：
    mediaReporting.playerStateData.time

聚焦属性

受聚焦影响的流数量

实施
网络参数
报表
  • SDK 密钥
    ​自动设置
  • API 密钥
    ​不适用
  • 必需
    ​否
  • 类型
    ​数值
  • 发送条件
    ​媒体关闭
  • 最低 SDK 版本
    3.0
  • 示例值
    TRUE
  • 描述
    ​受聚焦影响的流数量。只有在播放会话期间出现至少一次聚焦状态时，此量度才设置为 1。
    重要信息
    如果设置此事件，则唯一可能的值为 TRUE。如果不设置此事件，则不会发送任何值。
  • Adobe Analytics
    a.media.states.infocus.set
  • 心率
    ​不适用
  • 可用
    ​是
  • 保留的变量
    event
  • 报表名称
    ​受聚焦影响的流数量
  • 上下文数据
    a.media.states.infocus.set
  • 数据源
    videostateinfocus
  • Audience Manager
    c_contextdata.a.media.states.infocus.set
  • XDM 字段路径：
    media.mediaTimed.primaryAssetViewDetails.inFocus.playerStateSet
  • 报告 XDM 字段路径：
    mediaReporting.playerStateData.isSet

聚焦计数

实施
网络参数
报表
  • SDK 密钥
    ​自动设置
  • API 密钥
    ​不适用
  • 必需
    ​否
  • 类型
    ​数值
  • 发送条件
    ​媒体关闭
  • 最低 SDK 版本
    3.0
  • 示例值
    TRUE
  • 描述
    ​显示聚焦的次数。只有在播放会话期间出现至少一次聚焦状态时，此量度才设置为 1。
    重要信息
    ​如果设置了此事件，则计数等于视频处于“聚焦”状态的次数。如果不设置此事件，则不会发送任何值。
  • Adobe Analytics
    a.media.states.infocus.count
  • 心率
    ​不适用
  • 可用
    ​是
  • 保留的变量
    event
  • 报表名称
    ​聚焦计数
  • 上下文数据
    a.media.states.infocus.count
  • 数据源
    videostateinfocuscount
  • Audience Manager
    c_contextdata.media.states.infocus.count
  • XDM 字段路径：
    media.mediaTimed.primaryAssetViewDetails.
    inFocus.playerStateCount
  • 报告 XDM 字段路径：
    mediaReporting.playerStateData.count

聚焦总时长

实施
网络参数
报表
  • SDK 密钥
    ​自动设置
  • API 密钥
    ​不适用
  • 必需
    ​否
  • 类型
    ​数值
  • 发送条件
    ​媒体关闭
  • 最低 SDK 版本
    3.0
  • 示例值
    TRUE
  • 描述
    ​显示聚焦的时长。只有在播放会话期间出现至少一次聚焦状态时，此量度才设置为 1。
    重要信息
    如果设置了此事件，则时长等于视频处于“聚焦”状态的时长。如果不设置此事件，则不会发送任何值。
  • Adobe Analytics
    a.media.states.infocus.time
  • 心率
    ​不适用
  • 可用
    ​是
  • 保留的变量
    event
  • 报表名称
    ​聚焦总持续时长
  • 上下文数据
    a.media.states.infocus.time
  • 数据源
    videostateinfocustime
  • Audience Manager
    c_contextdata.media.states.infocus.time
  • XDM 字段路径：
    media.mediaTimed.primaryAssetViewDetails.
    inFocus.playerStateTime
  • 报告 XDM 字段路径：
    mediaReporting.playerStateData.time

相关 API related_apis_section

recommendation-more-help
c8eee520-cef5-4f8c-a38a-d4952cfae4eb