本文列出 VAST 廣告代碼的必要和建議參數清單,可用於在數位戶外廣告導入作業中放送廣告。
本頁內容
您可以查看其他導入類型清單,或參閱 VAST 廣告代碼的網址規定。
必須用於和建議用於數位戶外廣告的參數
廣告放送所需的參數
correlator (Correlator)
說明
「Correlator」參數 (correlator) 接受變數值,這是由同一次網頁瀏覽的多個請求共用的值。這個參數可用來執行競爭排除設定,就算環境中沒有 Cookie 也無妨。
使用範例
correlator=4345645667
env (環境)
說明
「環境」參數 (env) 接受常數值,表示串流內廣告請求,或請求特別源自某個影片播放器。
可能的值包括 instream (可用於影片和音訊廣告) 或 vp (只能用於影片廣告)。
使用範例
影片和/或音訊廣告:
env=instream
僅限影片廣告:
env=vp
gdfp_req (架構指標)
iu (廣告單元)
output (輸出內容)
說明
「輸出格式」參數 (output) 接受常數值,該值應設為廣告的輸出格式。
使用範例
output=vast
使用 VAST 4 (可以為特定代碼設定特定版本):
output=xml_vast4
使用聯播網的預設 VMAP 設定:
output=vmap
使用 VMAP 1:
output=xml_vmap1
使用 VMAP 1,傳回 VAST 4 (如果在 VMAP 中傳回 VAST):
output=xml_vmap1_vast4
sz (大小)
說明
大小 (sz) 參數接受變數值,應設為主要影片廣告版位的大小。
如有多個大小,請使用直立線 (|) 做為分隔字元。
請勿在大小後面加上「v」。
使用範例
單一大小:
sz=400x300
多個大小:
sz=300x250|400x300
url (網址)
說明
網址 (url) 參數接受變數值,應設為傳送請求的完整網址。這個必要的值可讓買方辨識及瞭解該項請求的來源背景資訊。如果可以,這個值應動態填入廣告請求。
- 以網頁來說,這是顯示影片播放器的網頁網址。
- 非網頁環境中,這個值應設為最能準確代表營利影片或音訊廣告空間的網址。舉例來說,假設使用者是在行動應用程式觀看影片,這個值應設為可以在電腦存取該行動應用程式的對等網址*。
注意事項:url 與 description_url 不同。url 是指廣告請求的來源位置,description_url 則是說明影片內容的可檢索網頁。
這項參數的值必須經過編碼。
使用範例
url=https%3A%2F%2Fwww.example.com%2Fvideo.html
* 以應用程式來說,如果無法將這項參數設為網址變數值,建議採用下列模式:url=https%3A%2F%2F<app/bundleid>.example.com
必須用於程式輔助的參數
idtype (裝置類型)
說明
可重設裝置 ID (rdid、idtype、is_lat) 參數接受變數值,也稱為廣告的 ID (IFA)。
如果行動應用程式使用 Android 或 iOS 版 IMA SDK,IMA SDK 會將用於指定使用者的可重設裝置 ID 傳入您的串流請求,並使用 rdid、idtype 和 is_lat 的參數。
如未使用 IMA SDK,或是使用伺服器端信標 (SSB),則須傳遞值來做為明確參數。進一步瞭解裝置 ID。
近乎所有程式輔助影片廣告都需要這些值。
|
自 iOS 14.5 起,Apple 已淘汰 |
使用範例
請參閱可重設裝置 ID的詳細範例。
is_lat (限制廣告追蹤)
說明
可重設裝置 ID (rdid、idtype、is_lat) 參數接受變數值,也稱為廣告的 ID (IFA)。
如果行動應用程式使用 Android 或 iOS 版 IMA SDK,IMA SDK 會將用於指定使用者的可重設裝置 ID 傳入您的串流請求,並使用 rdid、idtype 和 is_lat 的參數。
如未使用 IMA SDK,或是使用伺服器端信標 (SSB),則須傳遞值來做為明確參數。進一步瞭解裝置 ID。
近乎所有程式輔助影片廣告都需要這些值。
|
自 iOS 14.5 起,Apple 已淘汰 |
使用範例
請參閱可重設裝置 ID的詳細範例。
plcmt (刊登位置)
說明
「刊登位置」參數 (plcmt) 接受常數值,用於指出串流內廣告空間是否依據 IAB 規格的指引,宣告為「串流內廣告」或「隨播內容」。
針對非串流內廣告請求,系統會根據宣告的廣告空間格式,自動替買方填入這個欄位,並會覆寫任何串流內廣告或隨播內容宣告。
使用範例
串流內廣告請求:
plcmt=1
隨播內容請求:
plcmt=2
rdid (可重設裝置 ID)
說明
可重設裝置 ID (rdid、idtype、is_lat) 參數接受變數值,也稱為廣告的 ID (IFA)。
如果行動應用程式使用 Android 或 iOS 版 IMA SDK,IMA SDK 會將用於指定使用者的可重設裝置 ID 傳入您的串流請求,並使用 rdid、idtype 和 is_lat 的參數。
如未使用 IMA SDK,或是使用伺服器端信標 (SSB),則須傳遞值來做為明確參數。進一步瞭解裝置 ID。
近乎所有程式輔助影片廣告都需要這些值。
|
自 iOS 14.5 起,Apple 已淘汰 |
使用範例
請參閱可重設裝置 ID的詳細範例。
sid (工作階段 ID)
說明
工作階段 ID (sid) 參數接受變數值,這項廣告 ID 可以保障隱私權,只能用於設定展示頻率上限。
來自連網電視的串流內影片請求,以及來自行動應用程式裝置的串流內影片廣告空間都支援工作階段 ID,不過網站目前不支援這項參數。
如要停止傳遞工作階段 ID,可以設定 sid=0。
venuetype (Venue 類型)
說明
場地類型參數 (venuetype) 會指出戶外場地類型,可用的值為 IAB OpenOOH 場地類型 1.1 分類支援的整數列舉 ID。
使用範例
飯店客房:
venuetype=80703
計程車後座的平板電腦:
venuetype=103
vpmute (影片播放靜音)
說明
影片播放靜音 (vpmute) 參數接受常數值,會指出影片播放器處於靜音狀態時是否會播放廣告。這項參數不會改變影片播放器的狀態,播放模式必須直接透過影片播放器操作。
使用範例
靜音時開始播放:
vpmute=1
非靜音時播放:
vpmute=0
建議用於程式輔助的參數
aconp (音訊連續播放)
說明
「音訊連續播放」參數 (aconp) 接受常數值,指出播放器是否打算連續播放音訊內容。這有助於 Google Ad Manager 為使用者提供最合適的廣告體驗。
使用範例
開啟連續播放:
aconp=2
關閉連續播放:
aconp=1
如果不知道音訊是否會持續播放,請勿設定這個參數,或將其設為 aconp=0。
an (應用程式名稱)
說明
「應用程式 ID」參數 (msid) 和「應用程式名稱」參數 (an) 接受變數值;由於大部分的程式輔助採購影片廣告都需要這兩個參數,因此應將這兩個參數用於從行動應用程式和連網電視裝置發出的請求。
應用程式名稱應為人類可讀的名稱。
使用範例
msid=com.package.publisher&an=sample%20app
應用程式 ID 的名稱和格式,會因應用程式商店而異。請參閱 IAB 應用程式識別指南,或常見專屬 ID 範例。
如果平台沒有應用程式商店,則 IAB 建議發布商使用以下商店 ID 格式:com.publisher.deviceplatform
需求條件和建議
雖然您不必使用這個參數為特定導入類型放送廣告,但建議您在行動應用程式、連網電視、音訊和數位戶外廣告中使用程式輔助營利功能。
為確保品牌安全,並向買家保持資訊公開,強烈建議您提供應用程式資訊。
SDK 使用情形
除了 iOS 和 tvOS,IMA SDK 會自動填入這兩個參數,但在非 SDK 環境 (包括直接 VAST 呼叫),或使用程式輔助存取權資料庫 (PAL)/發布商驗證廣告空間 (PAI) 時,您必須手動指定。
在 iOS 和 tvOS 中,IMA SDK 或 PAl 無法存取應用程式 ID。在這些情況下,系統不會傳送 msid 參數,且 SDK 會透過 an 參數傳送應用程式套件。
注意:如果使用 HTML5 IMA SDK,系統不會使用應用程式資訊。
dth (裝置類型提示)
說明
「裝置類型提示」參數 (dth) 接受常數值,有助減少裝置分類錯誤的情況,特別是在連網電視和機上盒環境。
裝置分類錯誤可能是發布商或連網電視原始設備製造商 (OEM) 無意間造成的錯誤。這個參數會與其他信號搭配使用,讓 Google 自動標示可能需要重新分類連網電視廣告空間的情況。
使用範例
請求來自:
- 功能型手機:
dth=1 - 智慧型手機:
dth=2 - 桌上型電腦:
dth=3 - 平板電腦:
dth=4 - 連網電視:
dth=5 - 遊戲主機:
dth=6 - 機上盒:
dth=7
givn (影片 Nonce)
說明
如果整合作業使用程式輔助存取權資料庫 (PAL),影片 Nonce 參數會接受變數字串值。
Nonce 是安全的網址,您不需要對其進行網址編碼。
注意:如果您先前使用舊版 paln 參數提供 Nonce,強烈建議您改用 givn 參數,並停止傳送 paln。請勿同時加入這兩個參數。
使用範例
如要進一步瞭解傳遞給這個參數的值,請參閱 PAL 的入門指南。
hl (語言)
說明
「語言」參數接受 (hl) 常數值,用於請求該語言的廣告;在 Ad Exchange 或 AdSense 影片廣告中,這個參數能夠為動態分配的廣告選擇作業和影片廣告顯示作業設定語言。
使用範例
請求義大利文廣告:
hl=it
參數值可以是任何 ISO 639-1 (雙字母) 或 ISO 639-2 (三字母) 代碼。請查看有效代碼清單。
如果省略,該值則會預設使用在 Ad Exchange 中依據語言指定廣告目標的任何語言。
msid (應用程式 ID)
說明
「應用程式 ID」參數 (msid) 和「應用程式名稱」參數 (an) 接受變數值;由於大部分的程式輔助採購影片廣告都需要這兩個參數,因此應將這兩個參數用於從行動應用程式和連網電視裝置發出的請求。
應用程式名稱應為人類可讀的名稱。
使用範例
msid=com.package.publisher&an=sample%20app
應用程式 ID 的名稱和格式,會因應用程式商店而異。請參閱 IAB 應用程式識別指南,或常見專屬 ID 範例。
如果平台沒有應用程式商店,則 IAB 建議發布商使用以下商店 ID 格式:com.publisher.deviceplatform
需求條件和建議
雖然您不必使用這個參數為特定導入類型放送廣告,但建議您在行動應用程式、連網電視、音訊和數位戶外廣告中使用程式輔助營利功能。
為確保品牌安全,並向買家保持資訊公開,強烈建議您提供應用程式資訊。
SDK 使用情形
除了 iOS 和 tvOS,IMA SDK 會自動填入這兩個參數,但在非 SDK 環境 (包括直接 VAST 呼叫),或使用程式輔助存取權資料庫 (PAL)/發布商驗證廣告空間 (PAI) 時,您必須手動指定。
在 iOS 和 tvOS 中,IMA SDK 或 PAl 無法存取應用程式 ID。在這些情況下,系統不會傳送 msid 參數,且 SDK 會透過 an 參數傳送應用程式套件。
注意:如果使用 HTML5 IMA SDK,系統不會使用應用程式資訊。
omid_p (OMID 合作夥伴名稱)
說明
「OMID 合作夥伴名稱」參數 (omid_p) 接受使用變數值,指出整合 OMID 評估功能的合作夥伴名稱和合作夥伴版本。
「支援的 SDK API」參數 (sdk_apis) 接受變數值,可使用單一或以逗號分隔的支援 API 清單。
這些參數是一組參數的一部分,用於可見度和廣告驗證。
使用範例
未使用 PAL 時:
omid_p=examplepartnername/1.0.0.0&sdk_apis=7
請參閱可能的 API 架構值清單。
使用 PAL 時:
request.omidPartnerName = 'examplepartnername'
request.omidPartnerVersion = '1.0.0.0'
需求條件和建議
雖然您不必使用這個參數為特定導入類型放送廣告,但建議您在網頁、行動應用程式、連網電視、音訊和數位戶外廣告中使用程式輔助營利功能。
SDK 使用情形
- 請注意,這個參數僅適用於使用 Open Measurement SDK (OM SDK),且想透過 Active View 評估的發布商。
- 如要在使用程式輔助存取權資料庫 (PAL) 時指明 OMID 支援,請務必透過
omidPartnerName和omidPartnerVersion設定合作夥伴名稱和版本。如果您不是使用 PAL 或 IMA SDK,則須設定omid_p和sdk_apis參數。 - 假如您是使用 IMA SDK,則請勿使用這個參數,因為系統會自動完成相關設定。