本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
客户端广告跟踪架构和属性
借助 MediaTailor 客户端广告跟踪功能,您可以将详细的客户端广告跟踪数据集成到您的玩家环境中。以下各节涵盖了整个广告跟踪架构,以及构成该架构的特定属性和值。
架构
下表描述了 MediaTailor 客户端广告跟踪架构。在适用的情况下,该表将架构映射到VAST数据。
键 | 数据类型 | 儿童钥匙 | 从 VAST 2.0/3.0 开始映射 | 从 VAST 4.0 开始映射 | 描述 |
---|---|---|---|---|---|
回应 JSON | |||||
- | 对象 | avails, nonLinearAvails | |||
/avails
|
数组 |
||||
MediaTailor 在清单窗口中为每个用途(广告插播时间)创建一个对象。 | ads, adType, availID, duration, durationInSeconds, startTime, startTimeInSeconds, dateTime | ||||
/ads
|
数组 | ||||
MediaTailor 在有效期内为每个广告创建一个对象。 | 对象 | adID、adType、、adParameters、adVerifications、companionAds、、duration、 durationInSeconds、extensions、、、图标mediaFilestartTime、、startTimeInSeconds、dateTime、adBreakTrackingEvents | |||
/adId
|
String |
|
|||
/adParameters
|
String |
VAST/Ad/InLine/Creatives/Creative/Linear/AdParameters
|
MediaTailor 传递给玩家VASTVPAID的广告参数字符串 |
||
/adVerifications
|
数组 |
VAST/Ad/InLine/AdVerifications
|
包含执行第三方测量代码以验证创意播放所需的资源和元数据 |
||
MediaTailor 为每个广告验证元素创建一个对象。 | 对象 | executableResource、 javaScriptResource、供应商、verificationParameters | |||
/executableResource
|
数组 |
VAST/Ad/InLine/AdVerifications/Verification/ExecutableResource
|
|||
MediaTailor 为每个executableResource 元素创建一个对象。 |
对象 | apiFramework,adType, uri, 语言 | |||
/apiFramework
|
String |
VAST/Ad/InLine/AdVerifications/Verification/ExecutableResource/@apiFramework
|
|||
/type
|
字符串 | ||||
/uri
|
字符串 |
VAST/Ad/InLine/AdVerifications/Verification/ExecutableResource/#CDATA
|
|||
/language
|
String |
VAST/Ad/InLine/AdVerifications/Verification/ExecutableResource/@language
|
VAST/Ad/InLine/AdVerifications/Verification/ExecutableResource/@language
|
||
/javaScriptResource
|
数组 |
VAST/Ad/InLine/AdVerifications/Verification/JavaScriptResource
|
|||
MediaTailor 为每个javaScriptResource 元素创建一个对象。 |
对象 | apiFramework,browserOptional, uri | |||
/apiFramework
|
String |
VAST/Ad/InLine/AdVerifications/Verification/JavaScriptResource/@apiFramework
|
|||
/browserOptional
|
字符串 |
VAST/Ad/InLine/AdVerifications/Verification/JavaScriptResource/@browserOptional
|
|||
/uri
|
String |
VAST/Ad/InLine/AdVerifications/Verification/JavaScriptResource/#CDATA
|
|||
/trackingEvents
|
数组 |
||||
MediaTailor 为每种广告验证元素跟踪事件类型创建一个对象。 | 对象 | 事件,uri | |||
/event
|
String |
VAST/Ad/InLine/AdVerifications/Verification/TrackingEvents/Tracking/@event
|
|||
/uri
|
字符串 |
VAST/Ad/InLine/AdVerifications/Verification/TrackingEvents/Tracking/#CDATA
|
|||
/vendor
|
字符串 |
VAST/Ad/InLine/AdVerifications/Verification/@vendor
|
|||
/verificationParameters
|
String |
VAST/Ad/InLine/AdVerifications/Verification/VerificationParameters
|
|||
/companionAds
|
数组 |
广告附带的配套广告提供诸如广告周围的画框或在视频附近显示的横幅之类的内容。 |
|||
MediaTailor 为每个配套广告元素创建一个对象。 | 对象 | adParameters, altText, attributes, companionClickThrough, companionClickTracking, htmlResource, sequence, staticResource, trackingEvents |
VAST/Ad/InLine/Creatives/Creative/CompanionAds
|
||
/adParameters
|
String | ||||
/altText
|
String | ||||
/attributes
|
对象 |
adSlotId,,apiFramework,assetHeight,assetWidth,, expandedHeightexpandedWidth, idheight, pxratio, renderingMode width | |||
/adSlotId
|
String |
VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/@adSlotId
|
|||
/apiFramework
|
字符串 |
VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/@apiFramework
|
|||
/assetHeight
|
字符串 |
VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/@assetHeight
|
|||
/assetWidth
|
字符串 |
VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/@assetWidth
|
|||
/expandedHeight
|
字符串 |
VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/@expandedHeight
|
|||
/expandedWidth
|
字符串 |
VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/@expandedWidth
|
|||
/height
|
字符串 |
VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/@height
|
|||
/id
|
字符串 |
VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/@id |
|||
/pxratio
|
字符串 |
||||
/renderingMode
|
字符串 |
||||
/width
|
字符串 |
VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/@width |
|||
/companionClickThrough
|
字符串 |
VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/CompanionClickThrough |
|||
/companionClickTracking
|
字符串 |
VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/CompanionClickTracking |
|||
/htmlResource
|
字符串 |
VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/HTMLResource |
|||
/iFrameResource
|
字符串 |
VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/iFrameResource |
|||
/sequence
|
字符串 |
||||
/staticResource
|
String |
VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/StaticResource |
|||
/trackingEvents
|
数组 |
VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/TrackingEvents |
|||
MediaTailor 为每种配套广告元素跟踪事件类型创建一个对象。 |
|||||
/tracking
|
对象 |
>事件,uri | |||
/event
|
String |
VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/TrackingEvents/Tracking/@event
|
|||
/uri
|
字符串 |
VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/TrackingEvents/Tracking/#CDATA
|
|||
/duration
|
String |
长度,以 ISO 8601 秒为格式 |
|||
/durationInSeconds
|
数字 |
长度,以秒为单位 |
|||
/extensions
|
数组 |
广告服务器可以使用自定义VAST附加信息 |
|||
MediaTailor 为 |
VAST/Ad/InLine/Extensions
|
||||
/extension
|
对象 | 类型、内容 |
VAST/Ad/InLine/Extensions/Extension
|
||
/type
|
String |
VAST/Ad/InLine/Extensions/Extension/@type
|
|||
/content
|
String | ||||
/icons
|
数组 |
VAST/Ad/InLine/Creatives/Creative/Linear/Icons
|
|||
MediaTailor 为其中的每个 |
对象 | attributes, dateTime, duration, durationInSeconds, htmlResource, iconClicks, iconViewTracking, iFrameResource, staticResource, startTime, startTimeInSeconds |
VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon
|
||
/attributes
|
对象 | apiFramework、、duration、offset height、program、pxratio、、width xPosition yPosition | |||
/apiFramework
|
String |
VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/@apiFramework
|
|||
/duration
|
字符串 |
VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/@duration
|
|||
/height
|
字符串 |
VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/@height
|
|||
/offset
|
字符串 |
VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/@offset
|
|||
/program
|
字符串 |
VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/@program
|
|||
/pxratio
|
字符串 |
VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/@pxratio
|
|||
/width
|
字符串 |
VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/@width
|
|||
/xPosition
|
字符串 |
VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/@xPosition
|
|||
/yPosition
|
字符串 |
VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/@yPosition
|
|||
/dateTime
|
字符串 | ||||
/duration
|
String | ||||
/durationInSeconds
|
数字 | ||||
/htmlResource
|
String |
VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/HTMLResource
|
|||
/iconClicks
|
字符串 |
VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/IconClicks
|
|||
/iconClickThrough
|
String |
VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/IconClicks/IconClickThrough
|
|||
/iconClickTracking
|
对象 | id |
VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/IconClicks/IconClickTracking
|
||
/id
|
String | ||||
/iconClickFallbackImages
|
数组 |
VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/IconClicks/IconClickFallbackImages
|
|||
MediaTailor 为每个点击图标的后备图像节点创建一个对象。 |
|||||
/altText
|
String |
VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/IconClicks/IconClickFallbackImages/IconClickFallbackImage/AltText
|
|||
/height
|
字符串 |
VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/IconClicks/IconClickFallbackImages/IconClickFallbackImage/@height
|
|||
/width
|
String |
VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/IconClicks/IconClickFallbackImages/IconClickFallbackImage/@width
|
|||
/staticResource
|
对象 | creativeType,uri |
VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/IconClicks/IconClickFallbackImages/IconClickFallbackImage/StaticResource
|
||
/creativeType
|
String |
VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/IconClicks/IconClickFallbackImages/IconClickFallbackImage/StaticResource/@creativeType
|
|||
/uri
|
字符串 |
VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/IconClicks/IconClickFallbackImages/IconClickFallbackImage/StaticResource/#CDATA
|
|||
/iconViewTracking
|
字符串 |
VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/IconViewTracking
|
|||
/iFrameResource
|
String |
VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/iFrameResource
|
|||
/statidResource
|
对象 | creativeType,uri |
VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/StaticResource
|
||
/creativeType
|
String |
VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/StaticResource/@type
|
|||
/uri
|
字符串 |
VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/StaticResource/#CDATA
|
|||
/startTime
|
String | ||||
/startTimeInSeconds
|
数字 | ||||
/mediaFiles
|
对象 | adParameters, duration, durationInSeconds, mediaFilesList, mezzanine, startTime, startTimeInSeconds, trackingEvents |
玩家获得广告使用所需的视频和其他资产 |
||
/adParameters
|
String | ||||
/duration
|
String | ||||
/durationInSeconds
|
数字 | ||||
/mediaFilesList
|
数组 | ||||
MediaTailor 为每种配套广告元素跟踪事件类型创建一个对象 |
apiFramework, delivery, height, maintainAspectRatio, mediaFileUri, mediaType, scalable, width | ||||
/apiFramework
|
String | ||||
/delivery
|
字符串 | ||||
/height
|
字符串 | ||||
/maintainAspectRatio
|
字符串 | ||||
/mediaFileUri
|
字符串 | ||||
/mediaType
|
字符串 | ||||
/scalable
|
字符串 | ||||
/width
|
字符串 | ||||
/mezzanine
|
字符串 | ||||
/startTime
|
字符串 | ||||
/startTimeInSeconds
|
String | ||||
/trackingEvents
|
数组 | ||||
MediaTailor 为广告素材的每个跟踪事件创建一个对象 |
beaconUrls, duration, durationInSeconds, dateTime, eventId, eventType, startTime, startTimeInSeconds | ||||
/beaconUrls
|
数组 | ||||
以逗号分隔的列表,列出了此事件的所有跟踪 URLs |
|||||
/duration
|
String | ||||
/durationInSeconds
|
数字 | ||||
/dateTime
|
String | ||||
/eventId
|
字符串 | ||||
/eventType
|
字符串 | ||||
/startTime
|
String | ||||
/startTimeInSeconds
|
数字 | ||||
/startTime
|
String |
相对于播放会话开始的时间位置,以 ISO 8601 秒的格式表示 |
|||
/startTimeInSeconds
|
数字 |
相对于播放会话开始的时间位置,以秒为单位 |
|||
/dateTime
|
String |
以 ISO 8601秒的格式编程开始广告的日期时间 |
|||
/trackingEvents
|
数组 |
包含VAST响应中收到的所有跟踪事件数据以及计时信息 |
|||
/adType
|
String | ||||
/availId
|
字符串 | ||||
/dateTime
|
字符串 | ||||
/duration
|
String | ||||
/durationInSeconds
|
数字 | ||||
/startTime
|
String | ||||
/startTimeInSeconds
|
数字 |
属性
下表列出了客户端跟踪中的属性API、它们的定义、值类型和示例。
属性 | 定义 | 值类型 | 示例 |
---|---|---|---|
adID
|
|
String | 10 |
adBreakTrackingEvents
|
一个包含来自VAST响应的VMAP跟踪事件的数组。有关更多信息,请参阅 VMAP1.0 规范 |
String |
[]
|
adMarkerDuration
|
从清单中的广告标记中观察到的有效时长。 |
String |
30
|
adParameters
|
来自的一串广告参数 VASTVPAID, MediaTailor 传递给玩家。 |
String | |
adProgramDateTime
|
|
String | |
ads
|
一个包含构成广告效果的广告对象的数组。广告按其在清单中的显示顺序列出。 |
数组 |
[]
|
adSystem
|
投放广告的系统的名称。 重要请务必提供一个值。如果您不提供值,则可能会出现问题。 |
String |
myADS
|
adTitle
|
广告的标题。 |
String |
ad1
|
adVerifications
|
包含执行第三方测量代码以验证创意播放所需的资源和元数据。有关此属性的更多信息,请参阅 VAST4.2 规范 MediaTailor 支持 |
数组 |
[]
|
altText
|
配套广告图片的替代文字。此文本允许为视障人士提供描述性音频支持的玩家回读对图像的描述。 |
String |
video sequence advertising sneakers
|
attributes
|
包括随播广告VAST规范中定义的关键字 |
对象 |
{}
|
apiFramework
|
设置 |
String |
VPAID
|
availID
|
|
String |
|
avails
|
一个包含在活动清单窗口中显示的广告插播对象或可用对象的数组。这些可用按它们在清单中出现的顺序列出。 |
数组 |
[]
|
beaconUrls
|
广告信标的 MediaTailor 发送URL地点。 |
String | |
bitrate
|
视频资源的比特率。可执行资源通常不包含此属性。 |
String |
2048
|
companionAds
|
一个或多个配套广告内容规范,每个规格都指定了要使用的资源文件。配套广告附带广告可用,并提供在视频附近显示的内容,例如广告周围的画框或横幅。 |
数组 |
[]
|
companionClickThrough
|
A URL 指向广告商的页面,当观众点击配套广告时,媒体播放器会打开该页面。 |
String |
https://aws.amazon.com/
|
companionClickTracking
|
该 |
String |
https://myads.com/beaconing/event=clicktracking
|
creativeId
|
广告 |
String |
creative-1
|
creativeSequence
|
根据VAST响应中的 |
String |
1
|
dashAvailabilityStartTime
|
对于直播/动态DASH,原点 |
String |
2022-10-05T19:38:39.263Z
|
delivery
|
表示是否正在使用 |
String |
progressive
|
duration
|
长度,以 ISO 8601 秒为格式。尽管信标持续时间始终为零,但响应包括整个广告投放时间以及每个广告和信标的持续时间。 |
数字 |
15.015
|
eventId
|
|
String |
23
|
eventType
|
信标的类型。 |
String |
impression
|
extensions
|
广告服务器使用的自定义附加信息。VAST有关扩展的更多信息,请参阅 VAST4.2 规范 |
数组 |
[]
|
height
|
视频资源的高度(以像素为单位)。 |
String |
360
|
hlsAnchorMediaSequenceNumber
|
在源清单中看到的第一个/最旧的媒体序列的媒体序列号。HLS |
String |
77
|
htmlResource
|
直接插入到流媒体提供商页面中的 CDATA-enco HTML ded。HTML |
String |
<![CDATA[<!doctype html><html><head><meta
name=\"viewport\" content=\"width=1,
initial-scale=1.0, minimum-scale=1.0,...]]>
|
iFrameResource
|
URL到流媒体提供商加载到 iframe 中的HTML资源文件。 |
String | |
maintainAspectRatio
|
表示缩放时是否保持视频的纵横比。 |
布尔值 |
true
|
mediaFilesList
|
指定玩家投放广告所需的视频和其他素材。 |
数组 |
[]
|
mediaFileUri
|
URI它指向可执行资源或视频资产。 |
String |
https://myad.com/ad/ad134/vpaid.js
|
mediaType
|
广告素材或配套资源的MIME类型。 |
String |
video/mp4
|
meta
|
|||
mezzanine
|
夹层MP4资产URL的,如果VPAID广告包含夹层素材资源,则指定。 |
String |
https://gcdn.2mdn.net/videoplayback/id/itag/ck2/file/file.mp4
|
nextToken
|
指向下一页结果的标记的值(如果存在这样的值)。 |
String |
UFQzOS44NzNTXzIwMjMtMDctMzFUMTY6NTA6MDYuMzUwNjI2ODQ1Wl8x
|
nonLinearAds
|
数组 |
[]
|
|
nonLinearAdsList
|
数组 |
[]
|
|
nonLinearAvails
|
数组 | ||
scalable
|
指示是否将视频缩放到其他尺寸。 |
布尔值 |
true
|
sequence
|
VAST响应中为广告素材指定的序列值。 |
String |
1
|
skipOffset
|
时间值,用于标识玩家何时向用户提供跳过控件。 |
String |
00:00:05
|
startTime
|
相对于播放会话开始的时间位置,以 ISO 8601 秒的格式表示。该响应包含整个广告效用以及每个广告和信标的开始时间。 |
String |
PT9.943S
|
startTimeInSeconds
|
相对于播放会话开始的时间位置,以秒为单位。该响应包含整个广告效用以及每个广告和信标的开始时间。 |
数字 |
9.943
|
staticResource
|
URL转到用于广告组件的静态广告素材文件。 |
String |
https://very-interactive-ads.com/campaign1/file.json?c=1019113602
|
vastAdId
|
|
String |
ad1
|
width
|
视频资源的宽度(以像素为单位)。 |
String |
640
|