客户端广告跟踪架构和属性

借助 MediaTailor 客户端广告跟踪功能，您可以将详细的客户端广告跟踪数据集成到您的玩家环境中。以下各节涵盖了整个广告跟踪架构，以及构成该架构的特定属性和值。

架构

以下 JSON 结构显示了 MediaTailor 客户端广告跟踪架构。此表示形式说明了架构的嵌套结构，可帮助您了解不同部分之间的关系。

有关每个属性的详细信息，请参阅属性。


{
  "avails": [
    {
      "ads": [
        {
          "adID": "string",
          "adParameters": "string",
          "adSystem": "string",
          "adTitle": "string",
          "adVerifications": [
            {
              "executableResource": [
                {
                  "apiFramework": "string",
                  "type": "string",
                  "uri": "string",
                  "language": "string"
                }
              ],
              "javaScriptResource": [
                {
                  "apiFramework": "string",
                  "browserOptional": "string",
                  "uri": "string"
                }
              ],
              "trackingEvents": [
                {
                  "event": "string",
                  "uri": "string"
                }
              ],
              "vendor": "string",
              "verificationParameters": "string"
            }
          ],
          "companionAds": [
            {
              "adParameters": "string",
              "altText": "string",
              "attributes": {
                "adSlotId": "string",
                "apiFramework": "string",
                "assetHeight": "string",
                "assetWidth": "string",
                "expandedHeight": "string",
                "expandedWidth": "string",
                "height": "string",
                "id": "string",
                "pxratio": "string",
                "renderingMode": "string",
                "width": "string"
              },
              "companionClickThrough": "string",
              "companionClickTracking": "string",
              "htmlResource": "string",
              "iFrameResource": "string",
              "sequence": "string",
              "staticResource": "string",
              "trackingEvents": [
                {
                  "event": "string",
                  "uri": "string"
                }
              ]
            }
          ],
          "creativeId": "string",
          "creativeSequence": "string",
          "duration": "string",
          "durationInSeconds": number,
          "extensions": [
            {
              "type": "string",
              "content": "string"
            }
          ],
          "icons": [
            {
              "attributes": {
                "apiFramework": "string",
                "duration": "string",
                "height": "string",
                "offset": "string",
                "program": "string",
                "pxratio": "string",
                "width": "string",
                "xPosition": "string",
                "yPosition": "string"
              },
              "htmlResource": "string",
              "iconClicks": {
                "iconClickThrough": "string",
                "iconClickTracking": {
                  "id": "string"
                },
                "iconClickFallbackImages": [
                  {
                    "altText": "string",
                    "height": "string",
                    "width": "string",
                    "staticResource": {
                      "creativeType": "string",
                      "uri": "string"
                    }
                  }
                ]
              },
              "iconViewTracking": "string",
              "iFrameResource": "string",
              "staticResource": {
                "creativeType": "string",
                "uri": "string"
              }
            }
          ],
          "mediaFiles": {
            "adParameters": "string",
            "duration": "string",
            "durationInSeconds": number,
            "mediaFilesList": [
              {
                "apiFramework": "string",
                "delivery": "string",
                "height": "string",
                "maintainAspectRatio": "string",
                "mediaFileUri": "string",
                "mediaType": "string",
                "scalable": "string",
                "width": "string",
                "bitrate": "string"
              }
            ],
            "mezzanine": "string",
            "startTime": "string",
            "startTimeInSeconds": number,
            "trackingEvents": [
              {
                "beaconUrls": ["string"],
                "duration": "string",
                "durationInSeconds": number,
                "dateTime": "string",
                "eventId": "string",
                "eventType": "string",
                "startTime": "string",
                "startTimeInSeconds": number
              }
            ]
          },
          "startTime": "string",
          "startTimeInSeconds": number,
          "dateTime": "string",
          "adBreakTrackingEvents": [...],
          "vastAdId": "string"
        }
      ],
      "adType": "string",
      "availID": "string",
      "duration": "string",
      "durationInSeconds": number,
      "startTime": "string",
      "startTimeInSeconds": number,
      "dateTime": "string",
      "adMarkerDuration": "string",
      "adProgramDateTime": "string",
      "dashAvailabilityStartTime": "string",
      "hlsAnchorMediaSequenceNumber": "string"
    }
  ],
  "nonLinearAvails": [
    {
      "nonLinearAds": [...],
      "nonLinearAdsList": [...]
    }
  ],
  "nextToken": "string",
  "meta": {}
}

属性

下表列出了客户端跟踪 API 中的属性及其定义、值类型和示例。

属性	定义	值类型	示例
`adID`	HLS-与广告开头关联的序列号 DASH-广告的时段 ID 路径：`/avails/ads/adId` VAST 映射：无	字符串	`10`
`adBreakTrackingEvents`	一个数组，它承载来自 VAST 响应的 VMAP 跟踪事件。有关更多信息，请参阅 VMAP 1.0 规范的第 2.3.3 节。路径：`/avails/ads/adBreakTrackingEvents`	数组	`[]`
`adMarkerDuration`	从清单中的广告标记中观察到的有效时长。	字符串	`30`
`adParameters`	一串来自 VAST VPAID 的广告参数， MediaTailor 传递给玩家。路径：`/avails/ads/adParameters` 广阔的映射：`VAST/Ad/InLine/Creatives/Creative/Linear/AdParameters`	字符串
`adProgramDateTime`	HLS——以 ISO/IEC 8601:2004 格式表示广告的第一个媒体序列的日期。 DASH-[未指定]	字符串
`ads`	一个包含构成广告效果的广告对象的数组。广告按其在清单中的显示顺序列出。路径：`/avails/ads`	数组	`[]`
`adSystem`	投放广告的系统的名称。重要请务必提供一个值。如果您不提供值，则可能会出现问题。	字符串	`myADS`
`adTitle`	广告的标题。	字符串	`ad1`
`adVerifications`	包含执行第三方测量代码以验证创意播放所需的资源和元数据。有关此属性的更多信息，请参阅 V AST 4.2 规范的第 3.16 节。 MediaTailor 支持`adVerifications`作为 VAST 3 扩展节点。路径：`/avails/ads/adVerifications` 广阔的映射：`VAST/Ad/InLine/AdVerifications`	数组	`[]`
`altText`	配套广告图片的替代文字。此文本允许为视障人士提供描述性音频支持的玩家回读对图像的描述。路径：`/avails/ads/companionAds/altText`	字符串	`video sequence advertising sneakers`
`apiFramework`	设置为`VPAID`，告诉玩家此广告是 VPAID 广告。可以出现在架构中的多个位置。	字符串	`VPAID`
`availID`	HLS-与广告开头相关的序列号。 DASH-广告广告的时段 ID，通常是要用广告替换的内容的时段 ID。路径：`/avails/availID`	字符串	`34` `PT34S_1`
`avails`	一个包含在活动清单窗口中显示的广告插播对象或可用对象的数组。这些可用按它们在清单中出现的顺序列出。路径：`/avails`	数组	`[]`
`adType`	广告的类型。路径：`/avails/adType`和 `/avails/ads/adType`	字符串
`dateTime`	以 ISO 8601 秒格式编程广告或广告的开始日期时间。路径：`/avails/dateTime`和 `/avails/ads/dateTime`	字符串
`duration`	长度，采用 ISO 8601 秒格式。尽管信标持续时间始终为零，但响应包括整个广告投放时间以及每个广告和信标的持续时间。路径：`/avails/duration`和 `/avails/ads/duration`	字符串	`15.015`
`durationInSeconds`	长度，以秒为单位。路径：`/avails/durationInSeconds`和 `/avails/ads/durationInSeconds`	数字
`extensions`	广告服务器使用的 VAST 的自定义扩展程序。有关扩展的更多信息，请参阅 V AST 4.2 规范的第 3.18 节。路径：`/avails/ads/extensions` 广阔的映射：`VAST/Ad/InLine/Extensions`	数组	`[]`
`icons`	广告的图标元素。路径：`/avails/ads/icons` 广阔的映射：`VAST/Ad/InLine/Creatives/Creative/Linear/Icons`	数组
`mediaFiles`	玩家获取广告所需的视频和其他资产。路径：`/avails/ads/mediaFiles`	对象
`nonLinearAvails`	非线性广告可用对象数组。路径：`/nonLinearAvails`	数组
`executableResource`	用于验证的可执行资源。路径：`/avails/ads/adVerifications/executableResource` 广阔的映射：`VAST/Ad/InLine/AdVerifications/Verification/ExecutableResource`	数组
`javaScriptResource`	JavaScript 用于核查的资源。路径：`/avails/ads/adVerifications/javaScriptResource` 广阔的映射：`VAST/Ad/InLine/AdVerifications/Verification/JavaScriptResource`	数组
`trackingEvents`	跟踪验证广告或配套广告的事件。路径：`/avails/ads/adVerifications/trackingEvents`或 `/avails/ads/companionAds/trackingEvents`	数组
`vendor`	验证供应商。路径：`/avails/ads/adVerifications/vendor` 广阔的映射：`VAST/Ad/InLine/AdVerifications/Verification/@vendor`	字符串
`uri`	指向可执行资产、视频资产或跟踪端点的 URI。路径：架构中的不同位置 VAST 映射：VAST 中的各种 CDATA 元素	字符串	`https://tracking.example.com/impression`
`verificationParameters`	验证参数。路径：`/avails/ads/adVerifications/verificationParameters` 广阔的映射：`VAST/Ad/InLine/AdVerifications/Verification/VerificationParameters`	字符串
`attributes`	配套广告属性，例如尺寸和渲染模式。路径：`/avails/ads/companionAds/attributes`	对象
`companionClickThrough`	广告商页面的网址，当观众点击配套广告时，媒体播放器会打开该网址。路径：`/avails/ads/companionAds/companionClickThrough` 广阔的映射：`VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/CompanionClickThrough`	字符串	`https://aws.amazon.com/`
`companionClickTracking`	该`companionClickThrough`属性的追踪网址。路径：`/avails/ads/companionAds/companionClickTracking` 广阔的映射：`VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/CompanionClickTracking`	字符串	`https://myads.com/beaconing/event=clicktracking`
`htmlResource`	直接插入到直播提供商的 HTML 页面中的 CDATA 编码的 HTML。路径：`/avails/ads/companionAds/htmlResource` 广阔的映射：`VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/HTMLResource`	字符串	`<![CDATA[<!doctype html><html><head><meta name=\"viewport\" content=\"width=1, initial-scale=1.0, minimum-scale=1.0,...]]>`
`iFrameResource`	直播提供商加载到 iframe 中的 HTML 资源文件的网址。路径：`/avails/ads/companionAds/iFrameResource` 广阔的映射：`VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/iFrameResource`	字符串
`sequence`	在 VAST 响应中为广告素材指定的序列值。路径：`/avails/ads/companionAds/sequence`	字符串	`1`
`startTime`	时间位置，采用 ISO 8601 秒格式。对于 HLS 来说，这与播放会话的开始时间有关。对于 DASH，这与清单的 AST（可用性开始时间）有关。该响应包含整个广告效用以及每个广告和信标的开始时间。路径：`/avails/startTime`和 `/avails/ads/startTime`	字符串	`PT18.581355S`
`startTimeInSeconds`	时间位置，以秒为单位。对于 HLS 来说，这与播放会话的开始时间有关。对于 DASH，这与清单的 AST（可用性开始时间）有关。该响应包含整个广告效用以及每个广告和信标的开始时间。路径：`/avails/startTimeInSeconds`和 `/avails/ads/startTimeInSeconds`	数字	`18.581`
`eventId`	HLS-与信标关联的序列号。 DASH-广告`ptsTime`的开头。	字符串
`event`	跟踪事件的名称。路径：`/avails/ads/adVerifications/trackingEvents/event`或 `/avails/ads/companionAds/trackingEvents/event`	字符串	`impression`, `start`, `firstQuartile`, `midpoint`, `thirdQuartile`, `complete`
`beaconUrls`	MediaTailor 发送广告信标的网址。路径：`/avails/ads/mediaFiles/trackingEvents/beaconUrls`	数组
`bitrate`	视频资源的比特率。可执行资源通常不包含此属性。	字符串	`2048`
`companionAds`	一个或多个配套广告内容规范，每个规格都指定要使用的资源文件。配套广告附带广告可用，并提供在视频附近显示的内容，例如广告周围的画框或横幅。路径：`/avails/ads/companionAds`	数组	`[]`
`creativeId`	广告`Creative`标签的`Id`属性值。	字符串	`creative-1`
`creativeSequence`	根据 VAST 响应中的`Ad@id`值，广告的播放顺序。	字符串	`1`
`dashAvailabilityStartTime`	对于 live/dynamic DASH 来说，`MPD@availabilityStartTime`原产地是显而易见的。	字符串	`2022-10-05T19:38:39.263Z`
`delivery`	表示是否正在使用`progressive`或`streaming`协议。	字符串	`progressive`
`eventType`	信标的类型。路径：`/avails/ads/mediaFiles/trackingEvents/eventType`	字符串	`impression`
`height`	视频资源的高度（以像素为单位）。	字符串	`360`
`hlsAnchorMediaSequenceNumber`	在 HLS 源清单中看到的 first/oldest 媒体序列的媒体序列号。	字符串	`77`
`maintainAspectRatio`	表示缩放时是否保持视频的纵横比。	布尔值	`true`
`mediaFilesList`	指定玩家投放广告所需的视频和其他素材。路径：`/avails/ads/mediaFiles/mediaFilesList`	数组	`[]`
`mediaFileUri`	指向可执行资源或视频资源的 URI。	字符串	`https://myad.com/ad/ad134/vpaid.js`
`mediaType`	广告素材或配套资源的 MIME 类型。	字符串	`video/mp4`
`meta`	广告的其他元数据。	对象
`mezzanine`	夹层资产的网址，如果 VPAID 广告 MP4 包含夹层资产的网址，则指定。路径：`/avails/ads/mediaFiles/mezzanine`	字符串	`https://gcdn.2mdn.net/videoplayback/id/itag/ck2/file/file.mp4`
`nextToken`	指向下一页结果的标记的值（如果存在这样的值）。	字符串	`UFQzOS44NzNTXzIwMjMtMDctMzFUMTY6NTA6MDYuMzUwNjI2ODQ1Wl8x`
`nonLinearAds`	出现在视频内容旁边的非线性广告。	数组	`[]`
`nonLinearAdsList`	非线性广告清单。	数组	`[]`
`scalable`	指示是否将视频缩放到其他尺寸。	布尔值	`true`
`skipOffset`	时间值，用于标识玩家何时向用户提供跳过控件。	字符串	`00:00:05`
`staticResource`	用于广告组件的静态素材文件的网址。路径：`/avails/ads/companionAds/staticResource`	字符串	`https://very-interactive-ads.com/campaign1/file.json?c=1019113602`
`vastAdId`	`Ad`标签的`Id`属性值。	字符串	`ad1`
`width`	视频资源的宽度（以像素为单位）。	字符串	`640`
`xPosition`	图标在视频播放器中的水平位置。可以是特定的像素值，也可以是 “左” 或 “右” 之类的位置。路径：`/avails/ads/icons/attributes/xPosition`	字符串	`left` 或 `10`
`yPosition`	图标在视频播放器中的垂直位置。可以是特定的像素值，也可以是 “顶部” 或 “底部” 之类的位置。路径：`/avails/ads/icons/attributes/yPosition`	字符串	`top` 或 `10`
`iconClicks`	包含图标的点击和跟踪信息。路径：`/avails/ads/icons/iconClicks`	对象
`iconClickThrough`	广告商页面的网址，当观众点击该图标时，媒体播放器会打开该网址。路径：`/avails/ads/icons/iconClicks/iconClickThrough`	字符串	`https://advertiser.com/landing-page`
`iconClickTracking`	该`iconClickThrough`属性的追踪网址。路径：`/avails/ads/icons/iconClicks/iconClickTracking`	对象
`iconClickFallbackImages`	无法显示图标时要显示的备用图像数组。路径：`/avails/ads/icons/iconClicks/iconClickFallbackImages`	数组
`iconViewTracking`	查看图标时用于跟踪的网址。路径：`/avails/ads/icons/iconViewTracking`	字符串	`https://tracking.example.com/icon-view`
`offset`	广告播放期间图标何时应出现的时间偏移。路径：`/avails/ads/icons/attributes/offset`	字符串	`00:00:05`
`program`	与图标关联的计划或计划，例如 “AdChoices”。路径：`/avails/ads/icons/attributes/program`	字符串	`AdChoices`
`pxratio`	图标或配套广告的像素比例，用于高 DPI 显示屏。路径：`/avails/ads/icons/attributes/pxratio`或 `/avails/ads/companionAds/attributes/pxratio`	字符串	`1` 或 `2`
`type`	资源或扩展的类型。路径：`/avails/ads/extensions/type`或 `/avails/ads/adVerifications/executableResource/type`	字符串	`text/javascript`
`content`	扩展程序的内容。路径：`/avails/ads/extensions/content`	字符串
`language`	可执行资源的编程语言。路径：`/avails/ads/adVerifications/executableResource/language`	字符串	`javascript`
`browserOptional`	表示 JavaScript 资源是否需要浏览器支持。路径：`/avails/ads/adVerifications/javaScriptResource/browserOptional`	字符串	`true` 或 `false`
`id`	架构中各种元素的标识符。路径：`/avails/ads/companionAds/attributes/id`或 `/avails/ads/icons/iconClicks/iconClickTracking/id`	字符串	`companion-1`
`assetHeight`	配套广告素材资源的高度。路径：`/avails/ads/companionAds/attributes/assetHeight`	字符串	`250`
`assetWidth`	配套广告素材资源的宽度。路径：`/avails/ads/companionAds/attributes/assetWidth`	字符串	`300`
`expandedHeight`	展开后配套广告的高度。路径：`/avails/ads/companionAds/attributes/expandedHeight`	字符串	`600`
`expandedWidth`	随播广告展开后的宽度。路径：`/avails/ads/companionAds/attributes/expandedWidth`	字符串	`600`
`renderingMode`	配套广告的渲染模式。路径：`/avails/ads/companionAds/attributes/renderingMode`	字符串	`default` 或 `transparent`
`adSlotId`	应在其中展示配套广告的广告位的 ID。路径：`/avails/ads/companionAds/attributes/adSlotId`	字符串	`banner-1`
`creativeType`	创意资源的 MIME 类型。路径：`/avails/ads/icons/staticResource/creativeType`	字符串	`image/png`

Javascript 在您的浏览器中被禁用或不可用。

要使用 Amazon Web Services 文档，必须启用 Javascript。请参阅浏览器的帮助页面以了解相关说明。

文档惯例

客户端跟踪

活动时机

客户端广告跟踪架构和属性

架构

属性

重要