文档AnalyticsMedia Analytics 指南

广告参数 ad-parameters

Last update: Fri Mar 08 2024 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 会再次添加缺失的变量名称。

广告视频数据 ad-video-data

广告 ID

实施
网络参数
报表
  • SDK 密钥：
    adId
  • API 密钥：
    media.ad.id
  • 必需：
    ​是
  • 类型：
    ​字符串
  • 发送条件：
    ​广告开始、广告关闭
  • 最低 SDK 版本： ​任何版本
  • 示例值：
    "2125"
  • 描述：
    ​广告的 ID。（任何整数和/或字母组合）
  • Adobe Analytics：
    (a.media.ad.
    name)
  • 心率：
    (s:asset:ad_id)
  • 可用：
    ​是
  • 保留的变量：
    eVar
  • 过期时间：
    ​访问时
  • 报表名称：
    ​广告
  • 上下文数据：
    (a.media.ad.
    name)
  • 数据馈送：
    videoad
  • Audience Manager：
    (c_contextdata.
    a.media.ad.name)
  • XDM 字段路径：
    advertising.adAssetReference.@id
  • 收集 XDM 字段路径：
    mediaCollection.advertisingDetails.name
  • 报告 XDM 字段路径：
    mediaReporting.advertisingDetails.name

面板中的广告位置

实施
网络参数
报表
  • SDK 密钥：
    position
  • API 密钥：
    media.ad.podPosition
  • 必需：
    ​是
  • 类型：
    ​数值
  • 发送条件：
    ​广告开始、广告关闭
  • 最低 SDK 版本： ​任何版本
  • 示例值：
    1
  • 描述：
    ​广告在父广告时间中的位置（索引）。第一个广告的索引是 0，第二个广告的索引是 1，以此类推。
  • Adobe Analytics：
    (a.media.ad.
    podPosition)
  • 心率：
    (s:asset:pod_position)
  • 可用：
    ​是
  • 保留的变量：
    eVar
  • 过期时间：
    ​点击时
  • 报表名称：
    ​面板中的广告位置
  • 上下文数据：
    (a.media.ad.
    podPosition)
  • 数据馈送：
    videoadinpod
  • Audience Manager：
    (c_contextdata.
    a.media.ad.podPosition)
  • XDM 字段路径：
    advertising.adAssetViewDetails.index
  • 收集 XDM 字段路径：
    mediaCollection.advertisingDetails.index
  • 报告 XDM 字段路径：
    mediaReporting.advertisingDetails.index

广告长度

实施
网络参数
报表
  • SDK 密钥：
    length
  • API 密钥：
    media.ad.length
  • 必需：
    ​是
  • 类型：
    ​数值
  • 发送条件：
    ​广告开始、广告关闭
  • 最低 SDK 版本： 1.5.1
  • 示例值：
    "15"
  • 描述：
    ​视频广告的长度，以秒为单位。
  • Adobe Analytics：
    (a.media.ad.
    length)
  • 心率：
    (l:asset:ad_length)
  • 可用：
    ​是
  • 保留的变量：
    eVar 和分类
  • 过期时间：
    ​点击时
  • 报表名称：
    ​广告长度和广告长度（变量）
  • 上下文数据：
    (a.media.ad.
    length)
  • 数据馈送：
    videoadlength
  • Audience Manager：
    (c_contextdata.
    a.media.ad.length)
  • XDM 字段路径：
    advertising.adAssetReference.
    xmpDM:duration
  • 收集 XDM 字段路径：
    mediaCollection.advertisingDetails.length
  • 报告 XDM 字段路径：
    mediaReporting.advertisingDetails.length

广告播放器名称

实施
网络参数
报表
  • SDK 密钥：
    playerName
  • API 密钥：
    media.ad.playerName
  • 必需：
    ​是
  • 类型：
    ​字符串
  • 发送条件：
    ​广告开始、广告关闭
  • 最低 SDK 版本： ​任何版本
  • 示例值：
    "Freewheel"
  • 描述：
    ​负责呈现广告的播放器的名称。
  • Adobe Analytics：
    (a.media.ad.
    playerName)
  • 心率：
    (s:sp:player_name)
  • 可用：
    ​是
  • 保留的变量：
    eVar
  • 过期时间：
    ​点击时
  • 报表名称：
    ​广告播放器名称
  • 上下文数据：
    (a.media.ad.
    playerName)
  • 数据馈送：
    videoadplayername
  • Audience Manager：
    (c_contextdata.
    a.media.ad.playerName)
  • XDM 字段路径：
    advertising.adAssetViewDetails.playerName
  • 收集 XDM 字段路径：
    mediaCollection.advertisingDetails.
    playerName
  • 报告 XDM 字段路径：
    mediaReporting.advertisingDetails.
    playerName

广告时间名称

实施
网络参数
报表
  • SDK 密钥：
    name
  • API 密钥：
    media.ad.podFriendlyName
  • 必需：
    SDK：是；API：否。
  • 类型：
    ​字符串
  • 发送条件：
    ​广告开始、广告关闭
  • 最低 SDK 版本： ​任何版本
  • 示例值：
    "pre-roll"
  • 描述：
    ​广告时间的友好名称。
  • Adobe Analytics：
    (a.media.ad.
    podFriendlyName)
  • 心率：
    (s:asset:pod_name)
  • 可用：
    ​是
  • 保留的变量：
    ​分类
  • 报表名称：
    ​面板名称
  • 上下文数据：
    (a.media.ad.
    podFriendlyName)
  • 数据馈送：
    ​不适用
  • Audience Manager：
    (c_contextdata.
    a.media.ad.podFriendlyName)
  • XDM 字段路径：
    advertising.adAssetViewDetails.
    adBreak.dc:title
  • 收集 XDM 字段路径：
    mediaCollection.advertisingPodDetails.
    friendlyName
  • 报告 XDM 字段路径：
    mediaReporting.advertisingPodDetails.
    friendlyName

广告时间索引

实施
网络参数
报表
  • SDK 密钥：
    position
  • API 密钥：
    media.ad.podPosition
  • 必需：
    ​是
  • 类型：
    ​数值
  • 发送条件：
  • 最低 SDK 版本： ​任何版本
  • 示例值：
    1
  • 描述：
    ​广告时间在内容中的索引，从 1 开始编号。此属性​ 仅 ​供 Media SDK 用于生成面板 ID。
  • Adobe Analytics:
  • 心率：
  • 可用：
    ​否
  • 保留的变量：
    ​不适用
  • 报表名称：
    ​不适用
  • 上下文数据：
  • 数据馈送：
    ​不适用
  • Audience Manager:
  • XDM 字段路径：
    advertising.adAssetViewDetails.index
  • 收集 XDM 字段路径：
    mediaCollection.advertisingPodDetails.index

广告时间位置

实施
网络参数
报表
  • SDK 密钥：
    startTime
  • API 密钥：
    media.ad.podSecond
  • 必需：
    ​是
  • 类型：
    ​数值
  • 发送条件：
    ​广告开始、广告关闭
  • 最低 SDK 版本： ​任何版本
  • 示例值：
    90
  • 描述：
    ​广告时间在内容中的偏移，以秒为单位。
  • Adobe Analytics：
    (a.media.ad.
    podSecond)
  • 心率：
    (l:asset:pod_offset)
  • 可用：
    ​是
  • 保留的变量：
    ​分类
  • 报表名称：
    ​面板位置
  • 上下文数据：
    (a.media.ad.
    podSecond)
  • 数据馈送：
    ​不适用
  • Audience Manager：
    (c_contextdata.
    a.media.ad.podSecond)
  • XDM 字段路径：
    advertising.adAssetViewDetails.adBreak.
    offset
  • 收集 XDM 字段路径：
    mediaCollection.advertisingPodDetails.
    offset
  • 报告 XDM 字段路径：
    mediaReporting.advertisingPodDetails.
    offset

广告时间 ID

实施
网络参数
报表
  • SDK 密钥：
    ​自动设置
  • API 密钥：
    ​不适用
  • 必需：
    ​是
  • 类型：
    ​字符串
  • 发送条件：
    ​广告开始、广告关闭
  • 最低 SDK 版本： ​任何版本
  • 示例值：
    c4a577424c84067899b807c76722d495_1
  • Adobe Analytics：
    (a.media.ad.
    pod)
  • 心率：
    (s:asset:pod_id)
  • 可用：
    ​是
  • 保留的变量：
    eVar
  • 过期时间：
    ​点击时
  • 报表名称：
    ​广告面板
  • 上下文数据：
    (a.media.ad.
    pod)
  • 数据馈送：
    videoadpod
  • Audience Manager:
  • XDM 字段路径：
    advertising.adAssetViewDetails.adBreak.@id
  • 报告 XDM 字段路径：
    mediaReporting.advertisingPodDetails.
    ID

广告名称

实施
网络参数
报表
  • SDK 密钥：
    name
  • API 密钥：
    media.ad.name
  • 必需：
    ​否
  • 类型：
    ​字符串
  • 发送条件：
    ​广告开始、广告关闭
  • 最低 SDK 版本： 1.5.1
  • 示例值：
    "Ford F-150"
  • 描述：
    ​广告的友好名称。在报表中，“广告名称”是分类，“广告名称（变量）”是 eVar。
  • Adobe Analytics：
    (a.media.ad.
    friendlyName)
  • 心率：
    (s:asset:ad_name)
  • 可用：
    ​是
  • 保留的变量：
    eVar 和分类
  • 过期时间：
    ​点击时
  • 报表名称：
    ​广告名称和广告名称（变量）
  • 上下文数据：
    (a.media.ad.
    friendlyName)
  • 数据馈送：
    ​不适用
  • Audience Manager：
    (c_contextdata.
    a.media.ad.friendlyName)
  • XDM 字段路径：
    advertising.adAssetReference.dc:title
  • 收集 XDM 字段路径：
    mediaCollection.advertisingDetails.friendlyName
  • 报告 XDM 字段路径：
    mediaReporting.advertisingDetails.friendlyName

标准广告元数据 standard-ad-metadata

广告商

实施
网络参数
报表
  • SDK 密钥：
    ADVERTISER
  • API 密钥：
    media.ad.advertiser
  • 必需：
    ​否
  • 类型：
    ​字符串
  • 发送条件：
    ​广告开始、广告关闭
  • 最低 SDK 版本： 1.5.7
  • 示例值：
  • 描述：
    ​广告中展现的产品所属的公司/品牌。
  • Adobe Analytics：
    (a.media.ad.
    advertiser)
  • 心率：
    (s:meta:
    a.media.ad.advertiser)
  • 可用：
    ​是
  • 保留的变量：
    eVar
  • 过期时间：
    ​点击时
  • 报表名称：
    广告商
  • 上下文数据：
    (a.media.ad.
    advertiser)
  • 数据馈送：
    videoadvertiser
  • Audience Manager：
    (c_contextdata.
    a.media.ad.advertiser)
  • XDM 字段路径：
    advertising.adAssetReference.advertiser
  • 收集 XDM 字段路径：
    mediaCollection.advertisingDetails.advertiser
  • 报告 XDM 字段路径：
    mediaReporting.advertisingDetails.advertiser

促销活动 ID

实施
网络参数
报表
  • SDK 密钥：
    CAMPAIGN_ID
  • API 密钥：
    media.ad.campaignId
  • 必需：
    ​否
  • 类型：
    ​字符串
  • 发送条件：
    ​广告开始、广告关闭
  • 最低 SDK 版本： 1.5.7
  • 示例值：
    ​整数或名称（字符串）。
  • 描述：
    ​广告营销活动的 ID。
  • Adobe Analytics：
    (a.media.ad.
    campaign)
  • 心率：
    (s:meta:
    a.media.ad.campaign)
  • 可用：
    ​是
  • 保留的变量：
    eVar
  • 过期时间：
    ​点击时
  • 报表名称：
    营销活动 ID
  • 上下文数据：
    (a.media.ad.
    campaign)
  • 数据馈送：
    videocampaign
  • Audience Manager：
    (c_contextdata.
    a.media.ad.campaign)
  • XDM 字段路径：
    advertising.adAssetReference.campaign
  • 收集 XDM 字段路径：
    mediaCollection.advertisingDetails.
    campaignID
  • 报告 XDM 字段路径：
    mediaReporting.advertisingDetails.
    campaignID

创作 ID

实施
网络参数
报表
  • SDK 密钥：
    CREATIVE_ID
  • API 密钥：
    media.ad.creativeId
  • 必需：
    ​否
  • 类型：
    ​字符串
  • 发送条件：
    ​广告开始、广告关闭
  • 最低 SDK 版本： 1.5.7
  • 示例值：
    ​整数或名称（字符串）。
  • 描述：
    ​广告创作的 ID。
  • Adobe Analytics：
    (a.media.ad.
    creative)
  • 心率：
    (s:meta:
    a.media.ad.creative)
  • 可用：
    ​是
  • 保留的变量：
    eVar
  • 过期时间：
    ​点击时
  • 报表名称：
    创作 ID
  • 上下文数据：
    (a.media.ad.
    creative)
  • 数据馈送：
    adclassificationcreative
  • Audience Manager：
    (c_contextdata.
    a.media.ad.creative)
  • XDM 字段路径：
    advertising.adAssetReference.creativeID
  • 收集 XDM 字段路径：
    mediaCollection.advertisingDetails.creativeID
  • 报告 XDM 字段路径：
    mediaReporting.advertisingDetails.creativeID

网站 ID

实施
网络参数
报表
  • SDK 密钥：
    SITE_ID
  • API 密钥：
    media.ad.siteId
  • 必需：
    ​否
  • 类型：
    ​字符串
  • 发送条件：
    ​广告开始、广告关闭
  • 最低 SDK 版本： 1.5.7
  • 示例值：
  • 描述：
    ​广告网站的 ID。
  • Adobe Analytics：
    (a.media.ad.
    site)
  • 心率：
    (s:meta:
    a.media.ad.site)
  • 可用：
    使用自定义处理规则
  • 保留的变量：
    eVar
  • 过期时间：
    ​点击时
  • 报表名称：
    ​自定义
  • 上下文数据：
    (a.media.ad.
    site)
  • 数据馈送：
    ​不适用
  • Audience Manager：
    (c_contextdata.
    a.media.ad.site)
  • XDM 字段路径：
    advertising.adAssetReference.siteID
  • 收集 XDM 字段路径：
    mediaCollection.advertisingDetails.siteID
  • 报告 XDM 字段路径：
    mediaReporting.advertisingDetails.siteID

创作 URL

实施
网络参数
报表
  • SDK 密钥：
    CREATIVE_URL
  • API 密钥：
    media.ad.creativeURL
  • 必需：
    ​否
  • 类型：
    ​字符串
  • 发送条件：
    ​广告开始、广告关闭
  • 最低 SDK 版本： 1.5.7
  • 示例值：
  • 描述：
    ​广告创作的 URL。
  • Adobe Analytics：
    (a.media.ad.
    creativeURL)
  • 心率：
    (s:meta:<c ode=""> a.media.ad.creativeUrl) ``
  • 可用：
    使用自定义处理规则
  • 保留的变量：
    eVar
  • 过期时间：
    ​点击时
  • 报表名称：
    ​自定义
  • 上下文数据：
    (a.media.ad.
    creativeURL)
  • 数据馈送：
    ​不适用
  • Audience Manager：
    (c_contextdata.
    a.media.ad.creativeURL)
  • XDM 字段路径：
    advertising.adAssetReference.creativeURL
  • 收集 XDM 字段路径：
    mediaCollection.advertisingDetails.
    creativeURL
  • 报告 XDM 字段路径：
    mediaReporting.advertisingDetails.
    creativeURL

版面 ID

实施
网络参数
报表
  • SDK 密钥：
    PLACEMENT_ID
  • API 密钥：
    media.ad.placementId
  • 必需：
    ​否
  • 类型：
    ​字符串
  • 发送条件：
    ​广告开始、广告关闭
  • 最低 SDK 版本： 1.5.7
  • 示例值：
  • 描述：
    ​广告的版面 ID。
  • Adobe Analytics：
    (a.media.ad.
    placement)
  • 心率：
    (s:meta:
    a.media.ad.placement)
  • 可用：
    使用自定义处理规则
  • 保留的变量：
    eVar
  • 过期时间：
    ​点击时
  • 报表名称：
    ​自定义
  • 上下文数据：
    (a.media.ad.
    placement)
  • 数据馈送：
    ​不适用
  • Audience Manager：
    (c_contextdata.
    a.media.ad.placement)
  • XDM 字段路径：
    advertising.adAssetReference.placementID
  • 收集 XDM 字段路径：
    mediaCollection.advertisingDetails.
    placementID
  • 报告 XDM 字段路径：
    mediaReporting.advertisingDetails.
    placementID

广告量度 ad-metrics

广告开始

实施
网络参数
报表
  • SDK 密钥：
    ​自动设置
  • API 密钥：
    ​不适用
  • 必需：
    ​是
  • 类型：
    ​字符串
  • 发送条件：
    ​广告开始
  • 最低 SDK 版本： ​任何版本
  • 示例值：
    TRUE
  • 描述：
    ​视频广告开始的次数。
  • Adobe Analytics：
    (a.media.ad.
    view)
  • 心率：
    (s:event:type=start)
    (s:asset:type=ad) ``
  • 可用：
    ​是
  • 保留的变量：
    event
  • 报表名称：
    ​广告开始
  • 数据馈送：
    ​不适用
  • 上下文数据：
    (a.media.ad.
    view)
  • Audience Manager：
    (c_contextdata.
    a.media.ad.view)
  • XDM 字段路径：
    advertising.starts.value > 0 => "TRUE"
  • 报告 XDM 字段路径：
    mediaReporting.advertisingDetails.isStarted

广告结束

实施
网络参数
报表
  • SDK 密钥：
    ​自动设置
  • API 密钥：
    ​不适用
  • 必需：
    ​是
  • 类型：
    ​字符串
  • 发送条件：
    ​广告关闭
  • 最低 SDK 版本： ​任何版本
  • 示例值：
    TRUE
  • 描述：
    ​视频广告完成的次数。
  • Adobe Analytics：
    (a.media.ad.
    complete)
  • 心率：
    (s:event:type=complete)
    (s:asset:type=ad)
  • 可用：
    ​是
  • 保留的变量：
    event
  • 报表名称：
    ​广告结束
  • 数据馈送：
    ​不适用
  • 上下文数据：
    (a.media.ad.
    complete)
  • Audience Manager：
    (c_contextdata.
    a.media.ad.complete)
  • XDM 字段路径：
    advertising.completes.value > 0 => "TRUE"
  • 报告 XDM 字段路径：
    mediaReporting.advertisingDetails.
    isCompleted

平均逗留时间

实施
网络参数
报表
  • SDK 密钥：
    ​自动设置
  • API 密钥：
    ​不适用
  • 必需：
    ​是
  • 类型：
    ​字符串
  • 发送条件：
    ​广告关闭
  • 最低 SDK 版本： ​任何版本
  • 示例值：
    15
  • 描述：
    ​观看广告所花费的总时间，以秒为单位（即播放广告所用的秒数）。该值将以时间格式(HH:MM:SSAnalysis Workspace )以及Reports & Analytics中的“禁止页面加载闪烁”。 而在数据馈送、Data Warehouse 和报表 API 中，该值将以秒数显示。
    发行日期：2018 年 9 月 13 日
  • Adobe Analytics：
    (a.media.ad.
    timePlayed)
  • 心率：
  • 可用：
    ​是
  • 保留的变量：
    event
  • 报表名称：
    ​广告逗留时间
  • 数据馈送：
    ​不适用
  • 上下文数据：
    (a.media.ad.
    timePlayed)
  • Audience Manager：
    (c_contextdata.
    a.media.ad.timePlayed)
  • XDM 字段路径：
    advertising.timePlayed.value
  • 报告 XDM 字段路径：
    mediaReporting.advertisingDetails.
    timePlayed

createAdObject API：

createAdBreakObject API：

MediaHeartbeatConfig API：

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