本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
用戶端廣告追蹤結構描述和屬性
使用 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 元素建立物件。 |
物件 | apiFramework、adType、uri、語言 | |||
/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、uri | |||
/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 會為每個廣告驗證元素追蹤事件類型建立物件。 | 物件 | 事件,uri | |||
/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、htmlResourcesequence、、staticResource、、trackingEvents |
VAST/Ad/InLine/Creatives/Creative/CompanionAds
|
||
/adParameters
|
字串 | ||||
/altText
|
字串 | ||||
/attributes
|
物件 |
adSlotId、apiFramework、assetHeight、assetWidth、expandedHeight、expandedWidth、height、id、pxratio、 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
|
物件 |
>事件,uri | |||
/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、duration、height、偏移、程式、pxratio、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、startTimestartTimeInSeconds、、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 追蹤事件的陣列。如需詳細資訊,請參閱 VMAP 1.0 規格的第 |
字串 |
[]
|
adMarkerDuration
|
從資訊清單中的廣告標記觀察到的可用持續時間。 |
字串 |
30
|
adParameters
|
MediaTailor 從 VAST VPAID 傳遞給玩家的廣告參數字串。 |
字串 | |
adProgramDateTime
|
|
字串 | |
ads
|
包含組成時段之廣告物件的陣列。廣告會依其在資訊清單中顯示的順序列出。 |
陣列 |
[]
|
adSystem
|
提供廣告的系統名稱。 重要請務必提供 值。如果您不提供值,則可能會出現問題。 |
字串 |
myADS
|
adTitle
|
廣告的標題。 |
字串 |
ad1
|
adVerifications
|
包含執行第三方測量程式碼所需的資源和中繼資料,以驗證創意播放。如需此屬性的詳細資訊,請參閱 VAST 4.2 規格的第 MediaTailor 支援 |
陣列 |
[]
|
altText
|
配套廣告影像的替代文字。此文字可讓具有描述性音訊支援的玩家,讓視覺障礙者重新閱讀影像的描述。 |
字串 |
video sequence advertising sneakers
|
attributes
|
包括 VAST 規格中為配套廣告定義的金鑰,例如 |
物件 |
{}
|
apiFramework
|
設定為 |
字串 |
VPAID
|
availID
|
|
字串 |
|
avails
|
包含在作用中資訊清單視窗中顯示的廣告休息物件或時段的陣列。時段會依清單清單中顯示的順序列出。 |
陣列 |
[]
|
beaconUrls
|
MediaTailor 傳送廣告信標的 URL。 |
字串 | |
bitrate
|
影片資產的位元速率。此屬性通常不包含在可執行資產中。 |
字串 |
2048
|
companionAds
|
一或多個配套廣告內容規格,每個規格都會指定要使用的資源檔案。相配廣告會伴隨廣告時段,並提供內容,例如廣告或橫幅周圍的影格,以在影片附近顯示。 |
陣列 |
[]
|
companionClickThrough
|
媒體播放器在瀏覽者按一下配套廣告時開啟的廣告商頁面 URL。 |
字串 |
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 延伸。如需擴充功能的詳細資訊,請參閱 VAST 4.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
|
串流提供者載入 iframe 的 HTML 資源檔案 URL。 |
字串 | |
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
|