本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
屬性
下表列出用戶端追蹤 API 中的屬性、其定義、值類型和範例。
屬性 | 定義 | 值類型 | 範例 |
---|---|---|---|
adID
|
|
字串 | 10 |
adBreakTrackingEvents
|
包含來自 VAST 回應之 VMAP 追蹤事件的陣列。如需詳細資訊,請參閱 VMAP 1.0 |
字串 |
[]
|
adMarkerDuration
|
從清單中的廣告標記觀察到的可用性持續時間。 |
字串 |
30
|
adParameters
|
一串廣告參數, 從 VAST VPADE, MediaTailor 傳遞給播放器. |
字串 | |
adProgramDateTime
|
|
字串 | |
ads
|
包含構成可用性之廣告物件的陣列。廣告會依照資訊清單中顯示的順序列出。 |
Array (陣列) |
[]
|
adSystem
|
提供廣告的系統名稱。 重要確保提供一個值。如果您不提供價值,則可能會出現問題。 |
字串 |
myADS
|
adTitle
|
廣告的標題。 |
字串 |
ad1
|
adVerifications
|
包含執行協力廠商測量程式碼以驗證廣告素材播放所需的資源和中繼資料。如需有關此屬性的詳細資訊,請參閱 VAST 4.2 規格 MediaTailor 支援 |
Array (陣列) |
[]
|
altText
|
隨附廣告圖片的替代文字。此文字可讓具有描述性音訊支援視障人士的玩家閱讀影像的描述。 |
字串 |
video sequence advertising sneakers
|
attributes
|
包含 VAST 規格中針對隨附廣告定義的金鑰 |
物件 |
{}
|
apiFramework
|
設定 |
字串 |
VPAID
|
availID
|
|
字串 |
|
avails
|
包含廣告突破對象的數組,或可用性,顯示在活動清單窗口中。可用性按照它們在清單中顯示的順序列出。 |
Array (陣列) |
[]
|
beaconUrls
|
MediaTailor 傳送廣告信標的 URL。 |
字串 | |
bitrate
|
視訊資產的位元速率。此屬性通常不包含在可執行資產中。 |
字串 |
2048
|
companionAds
|
一或多個隨附的廣告內容規格,每個規格都指定了要使用的資源檔案。隨附廣告伴隨著廣告的可用性,並提供內容 (例如廣告周圍的框架或橫幅) 以顯示在影片附近。 |
Array (陣列) |
[]
|
companionClickThrough
|
當觀眾點擊隨附廣告時,媒體播放器會開啟該廣告客戶頁面的網址。 |
字串 |
https://aws.amazon.com/
|
companionClickTracking
|
|
字串 |
https://myads.com/beaconing/event=clicktracking
|
creativeId
|
廣告 |
字串 |
creative-1
|
creativeSequence
|
根據 VAST 回應中的 |
字串 |
1
|
dashAvailabilityStartTime
|
對於實時/動態短跑,原 |
字串 |
2022-10-05T19:38:39.263Z
|
delivery
|
指出是否正在使用 |
字串 |
progressive
|
duration
|
長度,採用 ISO 8601 秒格式。儘管信標持續時間始終為零,但響應包括整個廣告可用性以及每個廣告和信標的持續時間。 |
Number |
15.015
|
eventId
|
|
字串 |
23
|
eventType
|
信標的類型。 |
字串 |
impression
|
extensions
|
廣告伺服器所使用的 VAST 自訂擴充功能。如需有關擴充功能的詳細資訊,請參閱 VAST 4.2 規格 |
Array (陣列) |
[]
|
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
|
指出縮放時是否要維持視訊的外觀比例。 |
布林值 |
true
|
mediaFilesList
|
指定播放器需要廣告可用的視頻和其他資產。 |
Array (陣列) |
[]
|
mediaFileUri
|
指向可執行資產或視訊資產的 URI。 |
字串 |
https://myad.com/ad/ad134/vpaid.js
|
mediaType
|
創意或伴隨資產的 MIME 類型。 |
字串 |
video/mp4
|
meta
|
|||
mezzanine
|
夾層 MP4 資產的網址,如果 VPADE 廣告包含一個,則會指定。 |
字串 |
https://gcdn.2mdn.net/videoplayback/id/itag/ck2/file/file.mp4
|
nextToken
|
當此值存在時,指向下一頁結果的令牌值。 |
字串 |
UFQzOS44NzNTXzIwMjMtMDctMzFUMTY6NTA6MDYuMzUwNjI2ODQ1Wl8x
|
nonLinearAds
|
Array (陣列) |
[]
|
|
nonLinearAdsList
|
Array (陣列) |
[]
|
|
nonLinearAvails
|
Array (陣列) | ||
scalable
|
指示是否將視訊縮放至其他尺寸。 |
布林值 |
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
|