本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
用戶端廣告追蹤架構和屬性
透過 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, 圖示,mediaFile,startTime,startTimeInSeconds,dateTime, adBreakTrackingEvents | |||
/adId
|
字串 |
|
|||
/adParameters
|
字串 |
VAST/Ad/InLine/Creatives/Creative/Linear/AdParameters
|
從 MediaTailor 傳遞給播放器的廣告參數字符串 VAST VPAID |
||
/adVerifications
|
陣列 |
VAST/Ad/InLine/AdVerifications
|
包含執行第三方測量程式碼所需的資源和中繼資料，以驗證廣告素材播放 |
||
| MediaTailor 為每個廣告驗證元素創建一個對象。 | 物件 | executableResource, javaScriptResource, 廠商, verificationParameters | |||
/executableResource
|
陣列 |
VAST/Ad/InLine/AdVerifications/Verification/ExecutableResource
|
|||
MediaTailor 為每個executableResource元素創建一個對象。 |
物件 | apiFrameworkadType, 語言, 語言 | |||
/apiFramework
|
字串 |
VAST/Ad/InLine/AdVerifications/Verification/ExecutableResource/@apiFramework
|
|||
/type
|
字串 | ||||
/uri
|
字串 |
VAST/Ad/InLine/AdVerifications/Verification/ExecutableResource/#CDATA
|
|||
/language
|
字串 |
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, 類型 | |||
/apiFramework
|
字串 |
VAST/Ad/InLine/AdVerifications/Verification/JavaScriptResource/@apiFramework
|
|||
/browserOptional
|
字串 |
VAST/Ad/InLine/AdVerifications/Verification/JavaScriptResource/@browserOptional
|
|||
/uri
|
字串 |
VAST/Ad/InLine/AdVerifications/Verification/JavaScriptResource/#CDATA
|
|||
/trackingEvents
|
陣列 |
||||
| MediaTailor 創建每個廣告驗證元素跟踪事件類型的對象。 | 物件 | 事件, 類型 | |||
/event
|
字串 |
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
|
字串 |
VAST/Ad/InLine/AdVerifications/Verification/VerificationParameters
|
|||
/companionAds
|
陣列 |
隨附廣告的配套廣告會提供廣告周圍的框架或在影片附近顯示的橫幅等內容。 |
|||
| MediaTailor 為每個公司廣告元素創建一個對象。 | 物件 | adParameters, altText, attributes, companionClickThrough, companionClickTracking, htmlResource, sequence, staticResource, trackingEvents |
VAST/Ad/InLine/Creatives/Creative/CompanionAds
|
||
/adParameters
|
字串 | ||||
/altText
|
字串 | ||||
/attributes
|
物件 |
adSlotId,apiFramework,assetHeight,assetWidth,expandedHeight,expandedWidth, idheight, 比例,,, renderingMode width | |||
/adSlotId
|
字串 |
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
|
字串 |
VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/StaticResource |
|||
/trackingEvents
|
陣列 |
VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/TrackingEvents |
|||
|
MediaTailor 會為每個公司廣告元素追蹤事件類型建立物件。 |
|||||
/tracking
|
物件 |
> 事件, 類型 | |||
/event
|
字串 |
VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/TrackingEvents/Tracking/@event
|
|||
/uri
|
字串 |
VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/TrackingEvents/Tracking/#CDATA
|
|||
/duration
|
字串 |
長度，以 ISO 8601 秒格式顯示 |
|||
/durationInSeconds
|
Number |
長度，以秒數格式表示 |
|||
/extensions
|
陣列 |
廣告伺服器可以使用自訂VAST擴充 |
|||
|
MediaTailor 為 |
VAST/Ad/InLine/Extensions
|
||||
/extension
|
物件 | 類型，內容 |
VAST/Ad/InLine/Extensions/Extension
|
||
/type
|
字串 |
VAST/Ad/InLine/Extensions/Extension/@type
|
|||
/content
|
字串 | ||||
/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,, durationheight, 偏移, 程式, Px 比例,,, width xPosition yPosition | |||
/apiFramework
|
字串 |
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
|
字串 | ||||
/durationInSeconds
|
Number | ||||
/htmlResource
|
字串 |
VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/HTMLResource
|
|||
/iconClicks
|
字串 |
VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/IconClicks
|
|||
/iconClickThrough
|
字串 |
VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/IconClicks/IconClickThrough
|
|||
/iconClickTracking
|
物件 | id |
VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/IconClicks/IconClickTracking
|
||
/id
|
字串 | ||||
/iconClickFallbackImages
|
陣列 |
VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/IconClicks/IconClickFallbackImages
|
|||
|
MediaTailor 會為每個圖示按一下後援影像節點建立物件。 |
|||||
/altText
|
字串 |
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
|
字串 |
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
|
字串 |
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
|
字串 |
VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/iFrameResource
|
|||
/statidResource
|
物件 | creativeType, URI |
VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/StaticResource
|
||
/creativeType
|
字串 |
VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/StaticResource/@type
|
|||
/uri
|
字串 |
VAST/Ad/InLine/Creatives/Creative/Linear/Icons/Icon/StaticResource/#CDATA
|
|||
/startTime
|
字串 | ||||
/startTimeInSeconds
|
Number | ||||
/mediaFiles
|
物件 | adParameters, duration, durationInSeconds, mediaFilesList, mezzanine, startTime, startTimeInSeconds, trackingEvents |
播放器需要用於廣告的視頻和其他資產 |
||
/adParameters
|
字串 | ||||
/duration
|
字串 | ||||
/durationInSeconds
|
Number | ||||
/mediaFilesList
|
陣列 | ||||
|
MediaTailor 為每個公司廣告元素追蹤事件類型建立物件 |
apiFramework, delivery, height, maintainAspectRatio, mediaFileUri, mediaType, scalable, width | ||||
/apiFramework
|
字串 | ||||
/delivery
|
字串 | ||||
/height
|
字串 | ||||
/maintainAspectRatio
|
字串 | ||||
/mediaFileUri
|
字串 | ||||
/mediaType
|
字串 | ||||
/scalable
|
字串 | ||||
/width
|
字串 | ||||
/mezzanine
|
字串 | ||||
/startTime
|
字串 | ||||
/startTimeInSeconds
|
字串 | ||||
/trackingEvents
|
陣列 | ||||
|
MediaTailor 為廣告素材的每個追蹤事件建立物件 |
beaconUrls, duration, durationInSeconds, dateTime, eventId, eventType, startTime, startTimeInSeconds | ||||
/beaconUrls
|
陣列 | ||||
|
以逗號分隔的清單，列出此事件的所有追蹤 URLs |
|||||
/duration
|
字串 | ||||
/durationInSeconds
|
Number | ||||
/dateTime
|
字串 | ||||
/eventId
|
字串 | ||||
/eventType
|
字串 | ||||
/startTime
|
字串 | ||||
/startTimeInSeconds
|
Number | ||||
/startTime
|
字串 |
相對於播放工作階段開始的時間位置，以 ISO 8601 秒格式顯示 |
|||
/startTimeInSeconds
|
Number |
相對於播放工作階段開始的時間位置 (以秒為單位) |
|||
/dateTime
|
字串 |
程序日期時間，以 ISO 8601 秒格式顯示，用於廣告可用的開始 |
|||
/trackingEvents
|
陣列 |
包含VAST回應中收到的所有追蹤事件資料，以及時間資訊 |
|||
/adType
|
字串 | ||||
/availId
|
字串 | ||||
/dateTime
|
字串 | ||||
/duration
|
字串 | ||||
/durationInSeconds
|
Number | ||||
/startTime
|
字串 | ||||
/startTimeInSeconds
|
Number | ||||
屬性
下表列出用戶端追蹤中的屬性API、其定義、值類型和範例。
| 屬性 | 定義 | 值類型 | 範例 |
|---|---|---|---|
adID
|
|
字串 | 10 |
adBreakTrackingEvents
|
從VAST響應進行VMAP跟踪事件的數組。如需詳細資訊，請參閱 VMAP1.0 規格 |
字串 |
[]
|
adMarkerDuration
|
從清單中的廣告標記觀察到的可用性持續時間。 |
字串 |
30
|
adParameters
|
MediaTailor 傳遞給播放器的廣告參數字串。VAST VPAID |
字串 | |
adProgramDateTime
|
|
字串 | |
ads
|
包含構成可用性之廣告物件的陣列。廣告會依照資訊清單中顯示的順序列出。 |
陣列 |
[]
|
adSystem
|
提供廣告的系統名稱。 重要確保提供一個值。如果您不提供價值，則可能會出現問題。 |
字串 |
myADS
|
adTitle
|
廣告的標題。 |
字串 |
ad1
|
adVerifications
|
包含執行協力廠商測量程式碼以驗證廣告素材播放所需的資源和中繼資料。如需有關此屬性的詳細資訊，請參閱 VAST4.2 規格 MediaTailor 支持 |
陣列 |
[]
|
altText
|
隨附廣告圖片的替代文字。此文字可讓具有描述性音訊支援視障人士的玩家閱讀影像的描述。 |
字串 |
video sequence advertising sneakers
|
attributes
|
包含隨附廣告VAST規格中定義的金鑰 |
物件 |
{}
|
apiFramework
|
設定 |
字串 |
VPAID
|
availID
|
|
字串 |
|
avails
|
包含廣告突破對象的數組，或可用性，顯示在活動清單窗口中。可用性按照它們在清單中顯示的順序列出。 |
陣列 |
[]
|
beaconUrls
|
在URL哪裡 MediaTailor 發送廣告信標。 |
字串 | |
bitrate
|
視訊資產的位元速率。此屬性通常不包含在可執行資產中。 |
字串 |
2048
|
companionAds
|
一或多個隨附的廣告內容規格，每個規格都指定了要使用的資源檔案。隨附廣告伴隨著廣告的可用性，並提供內容 (例如廣告周圍的框架或橫幅) 以顯示在影片附近。 |
陣列 |
[]
|
companionClickThrough
|
AURL：當觀眾點擊隨附廣告時，媒體播放器開啟的廣告客戶頁面。 |
字串 |
https://aws.amazon.com/
|
companionClickTracking
|
|
字串 |
https://myads.com/beaconing/event=clicktracking
|
creativeId
|
廣告 |
字串 |
creative-1
|
creativeSequence
|
根據VAST回應中的 |
字串 |
1
|
dashAvailabilityStartTime
|
對於實時/動態DASH，原 |
字串 |
2022-10-05T19:38:39.263Z
|
delivery
|
指出是否正在使用 |
字串 |
progressive
|
duration
|
長度，以 ISO 8601 秒格式表示。儘管信標持續時間始終為零，但響應包括整個廣告可用性以及每個廣告和信標的持續時間。 |
Number |
15.015
|
eventId
|
|
字串 |
23
|
eventType
|
信標的類型。 |
字串 |
impression
|
extensions
|
VAST該廣告伺服器使用的自訂額外資訊。如需有關延伸功能的詳細資訊，請參閱 VAST4.2 規格 |
陣列 |
[]
|
height
|
視訊資產的高度 (以像素為單位)。 |
字串 |
360
|
hlsAnchorMediaSequenceNumber
|
在來源清單中看到的第一個/最舊的媒體序列的媒體序列號。HLS |
字串 |
77
|
htmlResource
|
直接插入串流提供者HTML頁面中的CDATA編HTML碼。 |
字串 |
<![CDATA[<!doctype html><html><head><meta
name=\"viewport\" content=\"width=1,
initial-scale=1.0, minimum-scale=1.0,...]]>
|
iFrameResource
|
串流提供者載入URL至 iframe 的HTML資源檔案。 |
字串 | |
maintainAspectRatio
|
指出縮放時是否要維持視訊的外觀比例。 |
Boolean |
true
|
mediaFilesList
|
指定播放器需要廣告可用的視頻和其他資產。 |
陣列 |
[]
|
mediaFileUri
|
URI指向可執行資產或視訊資產。 |
字串 |
https://myad.com/ad/ad134/vpaid.js
|
mediaType
|
創意或隨附資產的MIME類型。 |
字串 |
video/mp4
|
meta
|
|||
mezzanine
|
夾層MP4資產URL的，指定VPAID廣告是否包含一個。 |
字串 |
https://gcdn.2mdn.net/videoplayback/id/itag/ck2/file/file.mp4
|
nextToken
|
當此值存在時，指向下一頁結果的令牌值。 |
字串 |
UFQzOS44NzNTXzIwMjMtMDctMzFUMTY6NTA6MDYuMzUwNjI2ODQ1Wl8x
|
nonLinearAds
|
陣列 |
[]
|
|
nonLinearAdsList
|
陣列 |
[]
|
|
nonLinearAvails
|
陣列 | ||
scalable
|
指示是否將視訊縮放至其他尺寸。 |
Boolean |
true
|
sequence
|
為VAST回應中的廣告素材指定的順序值。 |
字串 |
1
|
skipOffset
|
用來識別播放程式何時讓使用者可以使用略過控制項的時間值。 |
字串 |
00:00:05
|
startTime
|
相對於播放工作階段開始的時間位置，以 ISO 8601 秒格式表示。回應中包含整段廣告時段、每則廣告與信標所要使用的開始時間。 |
字串 |
PT9.943S
|
startTimeInSeconds
|
相對於播放工作階段開始的時間位置 (以秒為單位)。回應中包含整段廣告時段、每則廣告與信標所要使用的開始時間。 |
Number |
9.943
|
staticResource
|
用URL於廣告組件的靜態廣告素材檔案。 |
字串 |
https://very-interactive-ads.com/campaign1/file.json?c=1019113602
|
vastAdId
|
|
字串 |
ad1
|
width
|
視訊資產的寬度 (以像素為單位)。 |
字串 |
640
|
