章节参数 chapter-parameters

本主题介绍 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 会再次添加缺失的变量名称。

章节元数据 chapter-metadata

章节名称

实施
网络参数
报表
  • SDK 密钥:
    name
  • API 密钥:
    media.chapter.friendlyName
  • 必需:
    ​否
  • 类型:
    ​字符串
  • 发送条件:
    ​章节开始、章节关闭
  • 最低 SDK 版本: 1.3
  • 示例值:
    "The Big Bang Chapter 2 - Dating"
  • 描述:
    ​章节和/或区段的名称。
  • Adobe Analytics:
    (a.media.chapter.
    friendlyName)
  • 心率:
    (s:stream:chapter_name)
  • 可用:
    ​默认创建…
  • 保留的变量:
    ​分类
  • 报表名称:
    ​章节名称
  • 上下文数据:
    (a.media.chapter.
    friendlyName)
  • 数据馈送:
    ​不适用
  • Audience Manager:
    (c_contextdata.
    a.media.chapter.
    friendlyName)
  • XDM 字段路径:
    media.mediaTimed.mediaChapter.
    chapterAssetReference.dc:title
  • 收集 XDM 字段路径:
    mediaCollection.chapterDetails.friendlyName
  • 报告 XDM 字段路径:
    mediaReporting.chapterDetails.friendlyName

章节位置

实施
网络参数
报表
  • SDK 密钥:
    position
  • API 密钥:
    media.chapter.index
  • 必需:
    SDK:否;API:是。
  • 类型:
    ​数值
  • 发送条件:
    ​章节关闭
  • 最低 SDK 版本: 1.3
  • 示例值:
    2
  • 描述:
    ​章节在内容中的位置(索引、整数)。
  • Adobe Analytics:
    (a.media.chapter.
    position)
  • 心率:
    (l:stream:chapter_pos)
  • 可用:
    ​是
  • 保留的变量:
    ​分类
  • 报表名称:
    ​章节位置
  • 上下文数据:
    (a.media.chapter.
    position)
  • 数据馈送:
    ​不适用
  • Audience Manager:
    (c_contextdata.
    a.media.chapter.
    position)
  • XDM 字段路径:
    media.mediaTimed.mediaChapter.
    chapterAssetViewDetails.index
  • 收集 XDM 字段路径:
    mediaCollection.chapterDetails.index
  • 报告 XDM 字段路径:
    mediaReporting.chapterDetails.index

章节偏移

实施
网络参数
报表
  • SDK 密钥:
    startTime
  • API 密钥:
    media.chapter.offset
  • 必需:
    SDK:否;API:是。
  • 类型:
    ​数值
  • 发送条件:
    ​章节关闭
  • 最低 SDK 版本: 1.3
  • 示例值:
    58
  • 描述:
    ​章节在内容中与开始的偏移(以秒为单位)。
  • Adobe Analytics:
    (a.media.chapter.
    offset)
  • 心率:
    (l:stream:chapter_offset)
  • 可用:
    ​是
  • 保留的变量:
    ​分类
  • 报表名称:
    ​章节偏移
  • 上下文数据:
    (a.media.chapter.
    offset)
  • 数据馈送:
    ​不适用
  • Audience Manager:
    (c_contextdata.
    a.media.chapter.
    offset)
  • XDM 字段路径:
    media.mediaTimed.mediaChapter.
    chapterAssetViewDetails.offset
  • 收集 XDM 字段路径:
    mediaCollection.chapterDetails.offset
  • 报告 XDM 字段路径:
    mediaReporting.chapterDetails.offset

章节长度

实施
网络参数
报表
  • SDK 密钥:
  • API 密钥:
    media.chapter.length
  • 必需:
    SDK:否;API:是。
  • 类型:
    ​数值
  • 发送条件:
    ​章节关闭
  • 最低 SDK 版本: 1.3
  • 示例值:
    486
  • 描述:
    ​章节的长度,以秒为单位。
  • Adobe Analytics:
    (a.media.chapter.
    length)
  • 心率:
    (l:stream:chapter_length)
  • 可用:
    ​是
  • 保留的变量:
    ​分类
  • 报表名称:
    ​章节长度
  • 上下文数据:
    (a.media.chapter.
    length)
  • 数据馈送:
    ​不适用
  • Audience Manager:
    (c_contextdata.
    a.media.chapter.
    length)
  • XDM 字段路径:
    media.mediaTimed.mediaChapter.
    chapterAssetReference.xmpDM:duration
  • 收集 XDM 字段路径:
    mediaCollection.chapterDetails.length
  • 报告 XDM 字段路径:
    mediaReporting.chapterDetails.length

章节

实施
网络参数
报表
  • SDK 密钥:
    ​自动设置
  • API 密钥:
    ​不适用
  • 必需:
    ​否
  • 类型:
    ​字符串
  • 发送条件:
    ​章节关闭
  • 最低 SDK 版本: 1.3
  • 示例值:
  • 描述:
    ​自动生成的章节 ID。
  • Adobe Analytics:
    (a.media.chapter.
    name)
  • 心率:
    (s:stream:chapter_id)
  • 可用:
    ​是
  • 保留的变量:
    eVar
  • 过期时间:
    ​点击时
  • 报表名称:
    ​章节
  • 上下文数据:
    (a.media.chapter.
    name)
  • 数据馈送:
    videochapter
  • Audience Manager:
    (c_contextdata.
    a.media.chapter.
    name)
  • XDM 字段路径:
    media.mediaTimed.mediaChapter.
    chapterAssetReference.@id
  • 报告 XDM 字段路径:
    mediaReporting.chapterDetails.ID

章节量度 chapter-Metrics

章节开始

实施
网络参数
报表
  • SDK 密钥:
    ​自动设置
  • API 密钥:
    ​不适用
  • 必需:
    ​是
  • 类型:
    ​字符串
  • 发送条件:
    ​章节开始
  • 最低 SDK 版本: 1.3
  • 示例值:
    TRUE
  • 描述:
    ​章节开始的次数。重要信息: ​如果设置此事件,则唯一可能的值为 TRUE。如果不设置此事件,则不会发送任何值。
  • Adobe Analytics:
    (a.media.chapter.
    view)
  • 心率:
    (s:event:
    type=chapter_start)
  • 可用:
    ​是
  • 保留的变量:
    event
  • 报表名称:
    ​章节开始
  • 上下文数据:
    (a.media.chapter.
    view)
  • 数据馈送:
    ​不适用
  • Audience Manager:
    (c_contextdata.
    a.media.chapter.
    view)
  • XDM 字段路径:
    media.mediaTimed.chapterCount.
    value > 0 => "TRUE"
  • 报告 XDM 字段路径:
    mediaReporting.chapterDetails.isStarted

章节结束

实施
网络参数
报表
  • SDK 密钥:
    ​自动设置
  • API 密钥:
    ​不适用
  • 必需:
    ​是
  • 类型:
    ​字符串
  • 发送条件:
    ​章节关闭
  • 最低 SDK 版本: 1.3
  • 示例值:
    TRUE
  • 描述:
    ​章节结束的次数。重要信息: ​如果设置此事件,则唯一可能的值为 TRUE。如果不设置此事件,则不会发送任何值。
  • Adobe Analytics:
    (a.media.chapter.
    complete)
  • 心率:
    (s:event:
    type=chapter_complete)
  • 可用:
    ​是
  • 保留的变量:
    event
  • 报表名称:
    ​章节结束
  • 上下文数据:
    (a.media.chapter.
    complete)
  • 数据馈送:
    ​不适用
  • Audience Manager:
    (c_contextdata.
    a.media.chapter.
    complete)
  • XDM 字段路径:
    media.mediaTimed.mediaChapter.
    completes.value
  • 报告 XDM 字段路径:
    mediaReporting.chapterDetails.isCompleted

章节逗留时间

实施
网络参数
报表
  • SDK 密钥:
    ​自动设置
  • API 密钥:
    ​不适用
  • 必需:
    ​是
  • 类型:
    ​数值
  • 发送条件:
    ​章节关闭
  • 最低 SDK 版本: 1.3
  • 示例值:
  • 描述:
    ​章节花费的时间。该值将以时间格式(HH:MM:SSAnalysis Workspace )以及Reports & Analytics中的“禁止页面加载闪烁”。 而在数据馈送、Data Warehouse 和报表 API 中,该值将以秒数显示。
    发行日期:2018 年 9 月 13 日
  • Adobe Analytics:
    (a.media.chapter.
    timePlayed)
  • 心率:
  • 可用:
    ​是
  • 保留的变量:
    event
  • 报表名称:
    ​章节逗留时间
  • 上下文数据:
    (a.media.chapter.
    timePlayed)
  • 数据馈送:
    ​不适用
  • Audience Manager:
    (c_contextdata.
    a.media.chapter.
    timePlayed)
  • XDM 字段路径:
    media.mediaTimed.mediaChapter.
    timePlayed.value
  • 报告 XDM 字段路径:
    mediaReporting.chapterDetails.timePlayed

相关 API related_apis_section

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