本文將列出可在 VAST 廣告代碼中使用的完整參數清單。如要進一步瞭解特定參數,這篇文章可能非常實用。
查看所有參數索引 (按字母排序)本頁內容
false/true
,但建議您使用 0/1
布林參數 (例如 vpmute
、wta
、ad_rule
、gdpr
等)。依導入類型分類的參數清單
如果您採用特定導入作業,可以使用自訂參數清單,概略說明該導入作業的用途和需求條件。自訂參數清單的適用情況:
所有參數
廣告放送所需的參數
一般來說,大多數導入類型的廣告放送作業都必須使用這些參數,但某些情況例外。如要精準放送,請使用特定導入類型的參數清單。
correlator
(Correlator)
說明
「Correlator」參數 (correlator
) 接受變數值,這是由同一次網頁瀏覽的多個請求共用的值。這個參數可用來執行競爭排除設定,就算環境中沒有 Cookie 也無妨。
使用範例
correlator=4345645667
description_url
(內容描述網址)
說明
「說明網址」參數 (description_url
) 接受變數值,但該值必須描述網頁上播放的影片。
內容描述網址應是網頁應用程式、行動應用程式或 TV 應用程式特定網頁上播放的影片,而非所有影片或所有廣告請求的頂層網域。舉例來說,假設 https://www.sample.com/golf.html
網頁用來顯示高爾夫影片,請將該網頁設為 description_url
的值。
使用範例
description_url
值必須針對含有影片的網頁和連網電視/OTT 裝置進行網址編碼。如果是行動應用程式,則不得針對 description_url
值進行編碼。
網址編碼:
description_url=
https%3A%2F%2Fblue-sea-697d.quartiers047.workers.dev%3A443%2Fhttps%2Fwww.sample.com%2Fgolf.html
未編碼:
description_url=
https://www.sample.com/golf.html
需求條件和建議
如要在網站和行動應用程式中導入廣告放送作業,就必須使用這個參數。如果您使用 Ad Exchange 或 AdSense 進行動態分配,也需要提供這個參數。
建議搭配程式輔助營利功能使用這個參數。
SDK 使用情形
IMA SDK 不會自動設定這個參數,您必須手動設定。
請參閱您平台的 IMA SDK 指南。
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
unviewed_position_start
(延遲曝光)
vpmute
(影片播放靜音)
說明
影片播放靜音 (vpmute
) 參數接受常數值,會指出影片播放器處於靜音狀態時是否會播放廣告。這項參數不會改變影片播放器的狀態,播放模式必須直接透過影片播放器操作。
使用範例
靜音時開始播放:
vpmute=1
非靜音時播放:
vpmute=0
必須用於程式輔助的參數
ott_placement
(OTT 刊登位置)
說明
「OTT 刊登位置」參數 (ott_placement
) 接受常數值,指出特定類型刊登位置的請求。
以下是刊登位置定義範例:
- 暫停:使用者暫停內容播放時,串流外格式會以重疊方式顯示在影片內容上方。
- 主畫面:在連網電視裝置或 OTT 應用程式的主畫面上顯示的廣告,包括主畫面上的刊頭廣告、橫幅廣告和圖塊。
- 子母畫面:在影片內容旁邊,獨立影片廣告播放器中播放的串流內影片廣告。通常需要壓縮影片內容並載入第二個影片播放器。
- L 型橫幅廣告:串流內多媒體廣告,會壓縮影片內容,並在影片周圍建立廣告。通常是 L 形廣告素材方塊,但不限於此。
- 重疊:任何串流內廣告格式,顯示在影片內容上方,但不會占滿全螢幕,可以是多媒體廣告或影片廣告。
使用範例
支援的格式及其對應值:
暫停:
ott_placement=1
主畫面:
ott_placement=2
子母畫面:
ott_placement=3
L 型橫幅廣告:
ott_placement=4
重疊廣告:
ott_placement=5
自訂/其他:
ott_placement=99
plcmt
(刊登位置)
說明
「刊登位置」參數 (plcmt
) 接受常數值,用於指出串流內廣告空間是否依據 IAB 規格的指引,宣告為「串流內廣告」或「隨播內容」。
針對非串流內廣告請求,系統會根據宣告的廣告空間格式,自動替買方填入這個欄位,並會覆寫任何串流內廣告或隨播內容宣告。
使用範例
串流內廣告請求:
plcmt=1
隨播內容請求:
plcmt=2
url
(網址)
說明
網址 (url
) 參數接受變數值,應設為傳送請求的完整網址。這個必要的值可讓買方辨識及瞭解該項請求的來源背景資訊。如果可以,這個值應動態填入廣告請求。
- 以網頁來說,這是顯示影片播放器的網頁網址。
- 非網頁環境中,這個值應設為最能準確代表營利影片或音訊廣告空間的網址。舉例來說,假設使用者是在行動應用程式觀看影片,這個值應設為可以在電腦存取該行動應用程式的對等網址*。
注意事項:url
與 description_url
不同。url
是指廣告請求的來源位置,description_url
則是說明影片內容的可檢索網頁。
這項參數的值必須經過編碼。
使用範例
url=https%3A%2F%2Fblue-sea-697d.quartiers047.workers.dev%3A443%2Fhttps%2Fwww.example.com%2Fvideo.html
* 以應用程式來說,如果無法將這項參數設為網址變數值,建議採用下列模式:url=https%3A%2F%2F<app/bundleid>.example.com
venuetype
(Venue 類型)
說明
場地類型參數 (venuetype
) 會指出戶外場地類型,可用的值為 IAB OpenOOH 場地類型 1.1 分類支援的整數列舉 ID。
使用範例
飯店客房:
venuetype=80703
計程車後座的平板電腦:
venuetype=103
vpa
(影片自動播放)
說明
影片自動播放 (vpa
) 參數接受常數值,會指出廣告中的影片內容是自動播放或點選後才開始播放。
如果頁面會等待使用者動作,可能的值為 click
;如果影片會自動播放,則為 auto
。這項參數不會改變影片播放器的狀態,播放模式必須直接透過影片播放器操作。
使用範例
自動播放:
vpa=auto
隨點即播:
vpa=click
如果值未知,請勿設定這項參數。
建議用於程式輔助的參數
aconp
(音訊連續播放)
說明
「音訊連續播放」參數 (aconp
) 接受常數值,指出播放器是否打算連續播放音訊內容。這有助於 Google Ad Manager 為使用者提供最合適的廣告體驗。
使用範例
開啟連續播放:
aconp=2
關閉連續播放:
aconp=1
如果不知道音訊是否會持續播放,請勿設定這個參數,或將其設為 aconp=0
。
an
(應用程式名稱)
說明
「應用程式 ID」參數 (msid
) 和「應用程式名稱」參數 (an
) 接受變數值;由於大部分的程式輔助採購影片廣告都需要這兩個參數,因此應將這兩個參數用於從行動應用程式和連網電視裝置發出的請求。
雖然應用程式名稱應採用使用者可理解的形式,但在 iOS 和 tvOS 中,SDK 無法存取應用程式 ID。在這些情況下,系統不會傳送 msid
參數,且 SDK 會透過 an
參數傳送應用程式套件。
使用範例
msid=com.package.publisher&an=sample%20app
應用程式 ID 的名稱和格式,會因應用程式商店而異。請參閱 IAB 應用程式識別指南,或常見專屬 ID 範例。
如果平台沒有應用程式商店,則 IAB 建議發布商使用以下商店 ID 格式:com.publisher.deviceplatform
需求條件和建議
雖然您不必使用這個參數為特定導入類型放送廣告,但建議您在行動應用程式、連網電視、音訊和數位戶外廣告中使用程式輔助營利功能。
為確保品牌安全並讓買方更清楚瞭解廣告,強烈建議您加入應用程式資訊。
SDK 使用情形
IMA SDK 會自動填入這兩個參數,但您必須在非 SDK 環境 (包括直接 VAST 呼叫),或使用程式輔助存取權資料庫 (PAL)/發布商驗證廣告空間 (PAI) 時手動指定。
注意:如果使用 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
) 接受變數值;由於大部分的程式輔助採購影片廣告都需要這兩個參數,因此應將這兩個參數用於從行動應用程式和連網電視裝置發出的請求。
雖然應用程式名稱應採用使用者可理解的形式,但在 iOS 和 tvOS 中,SDK 無法存取應用程式 ID。在這些情況下,系統不會傳送 msid
參數,且 SDK 會透過 an
參數傳送應用程式套件。
使用範例
msid=com.package.publisher&an=sample%20app
應用程式 ID 的名稱和格式,會因應用程式商店而異。請參閱 IAB 應用程式識別指南,或常見專屬 ID 範例。
如果平台沒有應用程式商店,則 IAB 建議發布商使用以下商店 ID 格式:com.publisher.deviceplatform
需求條件和建議
雖然您不必使用這個參數為特定導入類型放送廣告,但建議您在行動應用程式、連網電視、音訊和數位戶外廣告中使用程式輔助營利功能。
為確保品牌安全並讓買方更清楚瞭解廣告,強烈建議您加入應用程式資訊。
SDK 使用情形
IMA SDK 會自動填入這兩個參數,但您必須在非 SDK 環境 (包括直接 VAST 呼叫),或使用程式輔助存取權資料庫 (PAL)/發布商驗證廣告空間 (PAI) 時手動指定。
注意:如果使用 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,則請勿使用這個參數,因為系統會自動完成相關設定。
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
。
使用範例
sid=123e4567-e89b-12d3-a456-426614174000
依據 IAB 的 IFA 指南,這項參數必須採用 UUID 格式。進一步瞭解用來指定使用者的可重設裝置 ID。
vconp
(影片連續播放)
說明
影片連續播放 (vconp
) 參數接受常數值,會指出播放器是否會接續播放影片內容 (類似電視節目)。
使用範例
連續播放為「啟用」:
vconp=2
連續播放為「停用」:
vconp=1
如果值未知,請勿設定這項參數。
要求和建議
雖然針對任意實作項目放送廣告時,您不一定要提供這項參數,不過如要透過程式在網站、行動應用程式、連網電視和音訊營利,則建議使用這項參數。
美國媒體評議會 (MRC) 影片評估規範也建議使用這項參數。
vid_d
(影片長度)
說明
影片時間長度 (vid_d
) 參數接受變數值,會指出內容的時間長度 (以秒為單位)。
vid_d
和allcues
參數用於不擷取內容而放送片中廣告。- 必須使用廣告規則,才能傳回片中廣告。如果廣告規則使用以時間為基礎的提示 (例如「每 N 秒」或「在固定的時間」),就會使用所設提示,並忽略傳入
allcues
的提示。片中廣告仍須設定時間長度,因此還是要傳遞vid_d
。
使用範例
片長 90,000 秒 (25 小時) 的影片:
vid_d=90000
vpos
(影片位置)
說明
影片位置 (vpos
) 參數接受常數值,會指出廣告請求的來源為片頭、片中或片尾。
使用範例
片頭:
vpos=preroll
片中:
vpos=midroll
片尾:
vpos=postroll
wta
(為什麼會顯示這則廣告)
說明
「為什麼會顯示這則廣告?」參數 (wta
) 接受常數值,會指出影片播放器是否支援顯示廣告徽章。
使用範例
如果播放器應顯示 VAST 回應中提供的 AdChoices 圖示,請使用:
wta=1
(也可以省略wta
參數,或是傳遞未設有值的wta
)如果 VAST 回應中提供的 AdChoices 圖示會顯示於隨播廣告或提供給使用者,音訊請求則應使用
wta=1
。
如果播放器不應顯示 VAST 回應中提供的 AdChoices 圖示,請使用:
wta=0
要求和建議
雖然針對任意實作類型放送廣告時,您不一定要提供這項參數,不過如要透過程式在網站、行動應用程式、連網電視和音訊營利,則建議使用這項參數。
使用參數時:
&wta=0
流量不適用於 Google Demand 中的某些個人化類型。- 來自歐洲經濟區的
&wta=0
流量不適用於位於預訂和發布商管理的程式輔助保證委刊項,並已啟用廣告徽章的廣告素材。
廣告必須符合在歐洲經濟區 (EEA) 放送廣告的適用法律規定,包括可讓使用者檢舉非法內容的機制。發布商應使用「舉報 Google 上的內容」表單,通知 Google 遭到檢舉的所有非法內容。
使用 SDK
使用 IMA SDK 時,系統會自動支援廣告徽章功能。如果不使用 IMA SDK,影片播放器就必須導入 VASTIcon
和 IconClickFallbackImage
支援 (如 IAB VAST 標準的相關說明所述)。其他參數
一般來說,您不一定要傳送這些參數才能放送廣告,但如果要使用特定功能或採用特定導入類型,就可能需要這麼做。
ad_rule
(廣告規則)
說明
「廣告規則」參數 (ad_rule
) 接受常數值,指出應傳回 VAST 廣告素材或廣告規則回應。
廣告規則的預設設定取決於 Google Ad Manager 聯播網設定,這項設定會讓所有請求都成為廣告規則請求。如果使用聯播網設定,則不需要在廣告代碼中設定 ad_rule
。如要根據廣告請求停用廣告,可以傳遞 ad_rule=0
來覆寫聯播網設定。此外,如果您預設未啟用廣告規則,可以分別傳遞 ad_rule=1
和 ad_rule=0
來啟用/停用廣告規則。
使用範例
如果停用廣告規則設定:
- 請求 VAST 廣告素材:
ad_rule=0
或不設定
如果啟用廣告規則設定:
- 請求 VAST 廣告素材:
ad_rule=0
- 請求廣告規則 (VMAP):
ad_rule=1
或不設定
如果您選擇不使用廣告規則,可以使用廣告代碼參數,透過 pmnd
、pmxd
和 pmad
指出 VAST 代碼的廣告插播和廣告連播時間長度。
需求條件和建議
雖然您不必使用這個參數為特定導入類型放送廣告,但如果要正確使用影片廣告規則,就必須使用這個參數。
addtl_consent
(額外同意聲明)
說明
「額外同意聲明」參數 (addtl_consent
) 接受變數值;如果發布商想要整合 IAB 資訊公開和同意聲明架構第 2.0 版,並使用尚未註冊加入歐洲互動廣告局全球供應商清單,但已列入 Google 廣告技術供應商 (ATP) 名單的供應商,就會使用這個參數。
如需進一步瞭解傳遞給這個參數的值,請參閱《額外同意聲明模式技術規格》的內容。
使用範例
addtl_consent=1~1.35.41.101
adtest
(廣告測試)
說明
您應使用「廣告測試」參數 (adtest
),確保用於測試候補廣告 (無保證) 廣告空間的查詢不會被視為無效流量,且不會對收益造成影響。
測試候補廣告時,請將這個參數設為 on
,確保廣告在測試期間不會記錄任何曝光或點擊次數。在非測試環境中,將這個參數設為 off
就會正常計費。如果未設定,這個參數預設為 off
。
注意:測試直接銷售委刊項時,請改用不會影響收益的測試委刊項。
使用範例
開啟:
adtest=on
關閉:
adtest=off
ad_type
(廣告類型)
說明
「廣告類型」參數 (ad_type
) 接受常數值,指出應針對請求傳回的廣告類型。
將 ad_type
設為 audio
或 audio_video
時,vpmute 參數必須設為 0
。
使用範例
只允許音訊廣告:
ad_type=audio
允許可略過和不可略過的影片廣告:
ad_type=video
允許音訊和影片廣告:
ad_type=audio_video
這個
audio_video
值會允許這兩種格式競爭,但只會放送一種格式。這種廣告類型只能用來將影片廣告素材放送至支援影片廣告播放的音訊內容,或將音訊廣告素材放送至播放自然環境中「可聽」內容的串流內影片播放器,例如體育賽事串流、節目影片、新聞等。進一步瞭解影片內容中的音訊。
只允許可略過的影片廣告:
ad_type=skippablevideo
只允許不可略過的影片廣告:
ad_type=standardvideo
需求條件和建議
- 如果您的應用程式含有影片內容,請將這個參數設為
video
、audio_video
,或不設定。 - 如果您的應用程式只含有音訊內容 (例如廣播或語音應用程式),則必須將此參數設為
audio
。如果未設定,系統就不會傳回音訊廣告。
afvsz
(非線性廣告大小)
說明
「非線性廣告大小」參數 (afvsz
) 接受常數值,但這些值應為可以在影片廣告版位中顯示的非線性廣告大小逗號分隔清單。
廣告的大小必須是以下支援的大小之一:
200x200
250x250
300x250
336x280
450x50
468x60
480x90
729x90
使用 IMA SDK 時,這個欄位將被覆寫,並填入 nonLinearAdSlotWidth 和 nonLinearAdSlotHeight 內所有受支援的大小。
如果不支援非線性大小,這個參數可以省略或留空。
使用範例
支援所有大小:
afvsz=200x200,250x250,300x250,336x280,
450x50,468x60,480x90,728x90
寬度上限為 250:
afvsz=200x200,250x250
高度上限為 60:
afvsz=450x50,468x60
寬度上限為 100:
//empty; no values supported
需求條件和建議
雖然您不必使用這個參數為特定導入類型或交易類型放送廣告,但如果未使用 IMA SDK,就必須使用這個參數才能放送非線性影片廣告。
allcues
(所有提示)
說明
「所有提示」參數 (allcues
) 接受變數值,這是以逗號分隔的提示點清單 (以毫秒為單位)。Google Ad Manager 會針對每個值傳回一個廣告插播。
vid_d
和allcues
參數會用來在不擷取內容的情況下放送片中廣告。- 您也必須設定廣告規則,才能傳回片中廣告。如果廣告規則中使用以時間為基準的提示 (例如「每 N 秒」或「在固定的時間」),則會使用廣告規則中設定的提示、忽略傳遞至
allcues
中的提示。由於片中廣告仍需要設定時間長度,因此還是必須傳遞vid_d
。
使用範例
10 秒和 20 秒的提示點:
allcues=10000,20000
ciu_szs
(隨播廣告大小)
說明
「隨播廣告大小」參數 (ciu_szs
) 接受變數值;這些值是以逗號分隔的隨播廣告大小清單。
用直立線 (|
) 分隔的值表示廣告版位具有多個大小。
使用範例
ciu_szs=728x90,300x250
多重大小版位的廣告大小:
ciu_szs=728x90,300x200|300x250
cmsid
(內容來源 ID)
說明
「內容來源 ID」參數 (cmsid
) 和「影片 ID」參數 (vid
) 接受變數值。
如要將廣告指定到影片內容,主影片廣告代碼必須同時包含這兩個參數。
cmsid
是每個內容來源的專屬號碼。如要在 Google Ad Manager 中找出這組號碼,請依序點選「影片」>「內容來源」> 來源名稱。vid
是用來表示特定影片的字串或編號。這個 ID 是由代管內容的內容管理平台指定。如要在 Google Ad Manager 中找出這個 ID,請依序點選「影片」>「內容」> 特定影片內容。
使用範例
cmsid=[value]&vid=[value]
如果是為包含動態廣告插播的隨選影片建立廣告代碼,應使用巨集,因為此巨集會動態插入正確的內容來源和影片 ID。
例如:cmsid=%%CMS_ID%%&vid=%%VIDEO_ID%%
需求條件和建議
雖然您不必使用這個參數為特定導入類型或交易類型放送廣告,但如果要使用影片內容指定目標,就必須使用這些參數。
cust_params
(自訂參數)
excl_cat
(排除類別)
說明
「排除類別」參數 (excl_cat
) 接受變數值,用於封鎖廣告請求中包含排除標籤的任何委刊項。使用 cust_params
參數設定排除類別和排除標籤。
使用範例
如要為兩個排除標籤 (airline_excl_label
和 train_excl_label
) 設定排除類別,請使用直立線字元 (|
) 分隔標籤:
excl_cat=airline_excl_label%7Ctrain_excl_label
接著套用網址編碼,並在 cust_params
中使用已編碼字串:
&cust_params=excl_cat%3Dairline_excl_label%7Ctrain_excl_label
gdpr
(GDPR)
說明
「GDPR」參數 (gdpr
) 接受常數值;如果發布商想要整合 IAB 資訊公開和同意聲明架構第 2.0 版,就會使用這個參數。直接 VAST 請求並不會自動讀取這些值;一旦這些值加入廣告代碼中,就會獲得接受。
這個參數的有效值只有 0
和 1
,其中 0
代表不適用 GDPR,1
則代表適用 GDPR。如果適用 GDPR,您還必須使用 gdpr_consent 參數提供有效的資訊公開和同意聲明 (TC) 字串。
如需進一步瞭解傳遞給這個參數的值,請參閱導入架構的一般指南,或 IAB 資訊公開和同意聲明架構第 2.0 版規格中「TC 字串」一節的內容。
使用範例
適用 GDPR:gdpr=1
不適用 GDPR:gdpr=0
gdpr_consent
(GDPR 同意聲明)
說明
「GDPR 同意聲明」參數 (gdpr_consent
) 接受變數值;如果發布商想要整合 IAB 資訊公開和同意聲明架構第 2.0 版,就會使用這個參數。直接 VAST 請求並不會自動讀取這些值;一旦這些值加入廣告代碼中,就會獲得接受。
如需進一步瞭解傳遞給這個參數的值,請參閱導入架構的一般指南,或 IAB 資訊公開和同意聲明架構第 2.0 版規格中「TC 字串」一節的內容。
使用範例
gdpr_consent=GDPR_CONSENT_123
iabexcl
(IAB 排除網址)
說明
「IAB 排除網址」參數 (iabexcl
) 接受變數值;這些值是以逗號分隔的類別清單。
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的詳細範例。
ipd
(廣告空間合作夥伴網域)
說明
「廣告空間合作夥伴網域」參數 (ipd
) 接受變數值,但該值應設為發布商 app-ads.txt
(或 ads.txt
) 檔案中的 inventorypartnerdomain
宣告。
inventorypartnerdomain
參數是 IAB 規格,可協助發布商指定廣告空間共用合作夥伴的網域,以便進行 ads.txt/app-ads.txt
驗證。
如果廣告請求的來源廣告空間是由其他合作夥伴 (廣告空間共用合作夥伴) 所擁有,則 IPD 宣告在廣告空間共用用途中格外重要。
進一步瞭解 ads.txt/app-ads.txt 和廣告空間共用合作夥伴。
使用範例
inventorypartnerdomain
位於 app-ads.txt 檔案中,指向可利用廣告空間營利的合作夥伴 .txt 檔案。ipd
參數中的值應與 app-ads.txt 檔案內其中一個 inventorypartnerdomain
項目的值相符。需求條件和建議
如果發布商要透過非自有廣告空間營利,就必須使用這個參數。
ipe
(曝光連線偵測 (ping) 實體)
說明
「曝光連線偵測實體」參數 (ipe
) 接受常數值,用於指出來自伺服器 (而非用戶端) 的曝光連線偵測和轉換次數。
伺服器從伺服器傳送曝光連線偵測/信標時,就會使用曝光連線偵測實體。
使用範例
伺服器端信標 (SSB):ipe=ssb
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的詳細範例。
lip
(廣告連播中的最後一個位置)
說明
「廣告連播中的最後 1 個位置」參數 (lip
) 接受常數值,指出來自廣告連播中最後 1 個位置的指定目標或報表請求。
注意:這個參數不適用於最佳化廣告連播,若使用也會遭到忽略。
使用範例
lip=1
ltd
(受限制的廣告)
說明
「受限制的廣告」參數 (ltd
) 接受常數值,指出是否要在未取得 Cookie 或其他本機 ID 使用同意聲明的情況下,以受限的方式放送廣告。發布商可以手動加入這個參數,這樣無論使用者身在何處,Google 都會嘗試放送符合資格的受限制廣告。
這個參數用於指示受限制的廣告請求,與 is_lat
參數不同。除了會停用個人化功能,也會禁止系統將 ID 用於這類用途。
ltd=1
會變更 IMA SDK 的行為,將請求視為無 ID 且不允許儲存。如果廣告請求包含
ltd=1
(即受限制的廣告請求),使用 SDK 時,網域會切換為 pagead2.googlesyndication.com
。如果是無 SDK 整合,發布商必須手動將網域變更為 pagead2.googlesyndication.com
。使用範例
ltd=1
max_ad_duration
(廣告長度上限)
說明
廣告長度下限參數 (min_ad_duration
) 和廣告長度上限參數 (max_ad_duration
) 接受變數值;搭配使用時,可用來指定廣告必須符合的播放時間範圍 (單位為毫秒)。
這個參數可用於限制廣告素材的時間長度,符合單一廣告或最佳化廣告連播要求的廣告代碼要求。
使用範例
min_ad_duration=15000&max_ad_duration=30000
min_ad_duration
(廣告長度下限)
說明
廣告長度下限參數 (min_ad_duration
) 和廣告長度上限參數 (max_ad_duration
) 接受變數值;搭配使用時,可用來指定廣告必須符合的播放時間範圍 (單位為毫秒)。
這個參數可用於限制廣告素材的時間長度,符合單一廣告或最佳化廣告連播要求的廣告代碼要求。
使用範例
min_ad_duration=15000&max_ad_duration=30000
mridx
(片中廣告編號)
說明
「片中廣告編號」參數 (mridx
) 接受變數值,指出片中廣告的序數 (例如片中廣告 1、片中廣告 2 等)。
使用範例
mridx=2
需求條件和建議
雖然您不必使用這個參數為特定導入類型或交易類型放送廣告,但如果要指定特定片中廣告、製作片中廣告報表,以及預測片中廣告,就必須使用這個參數。
nofb
(無備用廣告)
說明
「不使用備用廣告」參數 (nofb
) 接受常數值,指出廣告請求不應傳回影片備用廣告的播放清單。
使用範例
停用備用廣告:nofb=1
您可以傳遞 nofb=1
,針對個別廣告請求停用單一廣告備用廣告和最佳化廣告連播廣告百匯。
npa
(非個人化廣告)
說明
「非個人化廣告」參數 npa
接受常數值,指出應將廣告請求視為非個人化。
您必須特別設定 npa=1
或包含 npa
(沒有固定值),才能將請求標為非個人化。沒有這個參數或是設為 nap=0
的廣告請求會預設為個人化廣告。
使用範例
非個人化廣告:
npa=1
需求條件和建議
只有在使用者停用個人化功能時,才需要使用這個參數。由使用者控制這項功能時,發布商應確保呈現正確的狀態。
paln
(程式輔助存取權資料庫 Nonce - 舊版)
說明
如果整合作業使用程式輔助存取權資料庫 (PAL),影片 Nonce 參數會接受變數字串值。
Nonce 是安全的網址,您不需要對其進行網址編碼。
注意:如果您先前使用舊版 paln
參數提供 Nonce,強烈建議您改用 givn
參數,並停止傳送 paln
。請勿同時加入這兩個參數。
使用範例
如要進一步瞭解傳遞給這個參數的值,請參閱 PAL 的入門指南。
pmad
(廣告連播的廣告數量上限)
說明
「廣告連播廣告上限」參數 (pmad
) 接受變數值,指出廣告連播中的廣告數量上限。
這個參數可限制最佳化廣告連播中的廣告總數,凡是擁有進階影片廣告套裝內容的發布商皆可使用。
這個參數不得用於 VMAP (當 ad_rule=1
)。
使用範例
pmad=4
pmnd
(廣告連播時間長度下限)
說明
「廣告連播時間長度下限」參數 (pmnd
) 和「廣告連播時間長度上限」參數 (pmxd
) 接受變數值;搭配使用時,可用來指定廣告連播必須符合的播放長度範圍 (以毫秒為單位)。
這些參數用於在最佳化廣告連播中請求多個廣告,凡是擁有進階影片廣告套裝內容的發布商皆可使用。使用廣告規則時,Google Ad Manager 會自動加入這項資訊。
這個參數不得用於 VMAP (當 ad_rule=1
)。
使用範例
pmnd=0&pmxd=60000
pmxd
(廣告連播時間長度上限)
說明
「廣告連播時間長度下限」參數 (pmnd
) 和「廣告連播時間長度上限」參數 (pmxd
) 接受變數值;搭配使用時,可用來指定廣告連播必須符合的播放長度範圍 (以毫秒為單位)。
這些參數用於在最佳化廣告連播中請求多個廣告,凡是擁有進階影片廣告套裝內容的發布商皆可使用。使用廣告規則時,Google Ad Manager 會自動加入這項資訊。
這個參數不得用於 VMAP (當 ad_rule=1
)。
使用範例
pmnd=0&pmxd=60000
pmxfwt
(廣告連播強制觀看時間上限)
說明
「廣告連播強制觀看時間上限」參數 (pmxfwt
) 接受變數值;這個參數指定廣告連播的不可略過長度上限 (以毫秒為單位)。
如果您支援的廣告連播可以混用不可略過和可略過的影片廣告,且想限制使用者觀看的廣告時間長度,請使用這個參數定義使用者必須觀看的不可略過廣告時間上限。
注意:廣告連播時間長度上限參數 (pmxd
) 會取代這個參數,定義廣告連播的總時間長度上限 (包括整部可略過廣告)。
使用範例
pmxfwt=30000
pod
(廣告連播編號)
pp
(廣告素材設定檔)
說明
「廣告素材設定檔」參數 (pp
) 接受變數值,會根據影片和音訊廣告素材設定檔中的設定,控管哪些廣告素材符合放送資格。
使用範例
pp=creative_profile
需求條件和建議
雖然您不必使用這個參數為特定導入類型放送廣告,但如果要使用影片和音訊廣告素材設定檔限制 Google Ad Manager 代管廣告素材的媒體檔案,就必須使用這個參數。對於重新導向或程式輔助廣告,這個參數可確保符合規定,但不會限制媒體檔案必須是廣告素材設定檔中選取的檔案。
ppt
(發布商隱私權處理方式)
說明
「發布商隱私權處理方式」參數 (ppt
) 接受常數值,用於指出是否要停用廣告請求的廣告個人化設定。
這個參數可用來強制放送非個人化廣告,可能與 npa=1
和 rdp=1
不同,並會影響預訂和程式輔助廣告需求。
進一步瞭解發布商隱私權處理方式。
使用範例
關閉廣告個人化功能:
ppt=1
ppid
(發布商提供的 ID)
說明
「發布商提供的 ID」參數 (ppid
) 接受 ID 變數值,用於設定展示頻率上限、目標對象區隔和指定目標、廣告依序輪播,以及其他以目標對象為準的跨裝置廣告放送控制設定,例如:
進一步瞭解發布商提供的 ID。
使用範例
ppid=12JD92JD8078S8J29SDOAKC0EF230337
需求條件和建議
雖然您不必使用這個參數為特定導入或交易類型放送廣告,但您必須使用一致的平台中立 ID。在沒有其他 ID 可提供給買家時,可能會使用這個 ID。
ppos
(在廣告連播中的位置)
說明
「在廣告連播中的位置」參數 (ppos
) 接受變數值,代表在廣告連播中的位置 (例如位置 1、位置 2 等)。
這個參數僅適用於標準廣告連播,而且是自動供應隨播廣告的必要項目。 使用廣告規則時,Google Ad Manager 會自動加入這項資訊。
使用範例
ppos=2
ppsj
(發布商提供的信號 JSON)
說明
「發布商提供的信號 JSON」參數 (ppsj
) 接受變數值,這是以 Base64 編碼的 JSON 物件,其中包含發布商提供的目標對象和比對內容資料,可提高程式輔助營利成效。
這個參數可用於向買方/出價方傳送特定信號。
使用範例
JSON 物件:
{
"PublisherProvidedTaxonomySignals": [{
"taxonomy": "IAB_AUDIENCE_1_1",
"values": ["6", "284"]
}]
}
套用 Base64 編碼值:
eyJQdWJsaXNoZXJQcm92aWRlZFRheG9ub215U2l
nbmFscyI6W3sidGF4b25vbXkiOiJJQUJfQVVESUVOQ0V
fMV8xIiwidmFsdWVzIjpbIjEiLCIyODQiXX1dfQ
如要深入瞭解有效的 JSON 鍵/值組合,請參閱
HTML5 IMA SDK 範例。
ptpl
(廣告插播範本 ID)
說明
「廣告插播範本 ID」參數 (ptpl
) 和名稱參數 (ptpln
) 接受變數值,用來表示哪一個廣告插播範本應套用至最佳化廣告連播請求。
透過廣告時段範本,您可以設定哪些廣告位置或自訂廣告位置應包含在廣告插播中,以及應按哪種順序放送。
要求廣告插播範本時,只需使用其中一個參數即可。
使用範例
進一步瞭解如何設定及要求廣告插播範本。
需求條件和建議
只有在直接要求廣告插播範本時,才需要使用這些參數。
ptpln
(廣告插播範本名稱)
說明
「廣告插播範本 ID」參數 (ptpl
) 和名稱參數 (ptpln
) 接受變數值,用來表示哪一個廣告插播範本應套用至最佳化廣告連播請求。
透過廣告時段範本,您可以設定哪些廣告位置或自訂廣告位置應包含在廣告插播中,以及應按哪種順序放送。
要求廣告插播範本時,只需使用其中一個參數即可。
使用範例
進一步瞭解如何設定及要求廣告插播範本。
需求條件和建議
只有在直接要求廣告插播範本時,才需要使用這些參數。
pubf
(Ad Exchange 廣告代碼的公開底價)
說明
「Ad Exchange 的公開底價」參數 (pubf
) 和「Ad Exchange 的私人底價」參數 (pvtf
) 可接受變數值,用於在 Ad Exchange 廣告代碼中新增底價。
這些參數等同於 google_ad_public_floor
和 google_ad_private_floor
。
使用範例
公開底價:
pubf=123
私人底價:
pvtf=123
pvid
(應用程式組 ID)
說明
「應用程式組 ID」參數 (pvid
) 接受設為 Android 應用程式組 ID 的變數值,而「應用程式組範圍」參數 (pvid_s
) 則接受代表應用程式組 ID 範圍 (scope_app
或 scope_developer
) 的常數值。
請參閱 Android 說明文件,瞭解如何擷取應用程式組 ID。
使用範例
pvid=[AppSetID_value]
pvid_s=scope_app
需求條件和建議
雖然不使用這個參數也能為特定導入類型放送廣告,但建議您在 Android 裝置的行動應用程式中使用程式輔助營利功能,包括以應用程式為主的連網電視 (Android TV)。
SDK 使用情形
IMA/PAL SDK 會自動傳遞這個欄位,但未導入 SDK 的發布商必須呼叫應用程式設定的 SDK,並根據廣告請求手動傳遞這些參數。
pvid_s
(應用程式組範圍)
說明
「應用程式組 ID」參數 (pvid
) 接受設為 Android 應用程式組 ID 的變數值,而「應用程式組範圍」參數 (pvid_s
) 則接受代表應用程式組 ID 範圍 (scope_app
或 scope_developer
) 的常數值。
請參閱 Android 說明文件,瞭解如何擷取應用程式組 ID。
使用範例
pvid=[AppSetID_value]
pvid_s=scope_app
需求條件和建議
雖然不使用這個參數也能為特定導入類型放送廣告,但建議您在 Android 裝置的行動應用程式中使用程式輔助營利功能,包括以應用程式為主的連網電視 (Android TV)。
SDK 使用情形
IMA/PAL SDK 會自動傳遞這個欄位,但未導入 SDK 的發布商必須呼叫應用程式設定的 SDK,並根據廣告請求手動傳遞這些參數。
pvtf
(Ad Exchange 廣告代碼的私人底價)
說明
「Ad Exchange 的公開底價」參數 (pubf
) 和「Ad Exchange 的私人底價」參數 (pvtf
) 可接受變數值,用於在 Ad Exchange 廣告代碼中新增底價。
這些參數等同於 google_ad_public_floor
和 google_ad_private_floor
。
使用範例
公開底價:
pubf=123
私人底價:
pvtf=123
rdp
(限制資料處理)
說明
受限的資料處理 (rdp
) 參數接受常數值,會指出廣告請求是否限制資料處理作業。
您可以啟用「受限的資料處理」聯播網設定,在聯播網層級對資料處理作業設下限制。
使用範例
限制資料處理作業:
rdp=1
或 rdp
(未設有值)
不限制資料處理作業:
rdp=0
scor
(串流 correlator)
說明
影片串流 Correlator (scor
) 參數接受變數值,應為針對個別影片串流產生的整數。
scor
與 correlator
參數的整數值不必相同。不過,在個別影片串流播放期間,兩者的值不應改變,以便識別不重複的觀看階段。
使用範例
scor=17
sdk_apis
(SDK API 框架)
說明
SDK API 框架 (sdk_apis
) 參數接受以半形逗號分隔的常數整數值清單,會指出播放器支援的所有 API 框架。
要求和建議
使用 SDK
如果發布商使用程式輔助存取權資料庫 (PAL),就會使用這項參數。使用 IMA SDK 時,您為這項參數設定的值會以 IMA SDK 支援的值覆寫。
sdmax
(可略過的廣告長度上限)
說明
可略過的廣告長度上限 (sdmax
) 參數接受變數值,可讓發布商為可略過的廣告指定所需的廣告時間長度上限。
時間長度以毫秒為單位,代表了該項廣告請求中,可略過影片/音訊廣告素材的時間長度上限。
sdmax
可以單獨用於可略過的廣告,也可以與現有的 max_ad_duration
參數搭配使用,為可略過和不可略過的廣告提供不同的時間長度上限。
使用範例
使用下列設定:
max_ad_duration
= 15000 (15 秒)sdmax
= 45000 (45 秒)
並套用至下列廣告素材:
- 廣告素材 A:不可略過;30 秒
- 廣告素材 B:可略過;30 秒
會產生下列結果:
- 廣告素材 A 不可略過,而且時間長度超過 (不可略過的廣告) 上限,因此會篩除。
- 廣告素材 B 的時間長度超過
max_ad_duration
,不過可略過,而且時間長度未超過可略過廣告的上限,因此不會篩除。
ssss
(伺服器端拼接來源)
說明
伺服器端拼接來源 (ssss
) 參數接受常數值,應設為經過認可並由 Google 提供的影片拼接技術供應商值。
如果影片拼接技術供應商使用 Google 的伺服器對伺服器整合服務,這個值會由 Google 提供,並由供應商提供給您。如果對這項參數的設定值有疑問,可以洽詢 Google 客戶經理。
使用範例
ssss=mystitcher
要求和建議
雖然針對任意實作或交易類型放送廣告時,您不一定要提供這項參數,不過如要使用伺服器端實作項目,就必須使用這項參數。
tfcd
(兒童導向內容標記)
trt
(流量類型)
說明
流量類型 (trt
) 參數接受常數值,會請求購買的流量或是自然流量。
使用範例
請求購買的流量:
trt=1
請求自然流量:
trt=2
要求和建議
使用 SDK
如果請求中缺少流量類型參數,IMA SDK 就不會填入預設值。此時,伺服器會提供 0
(未定義的流量) 做為預設值。
us_privacy
(IAB 美國隱私權)
說明
IAB 已淘汰us_national
字串,並鼓勵改用 GPP。不過,如果為了回溯相容性而傳送字串,Ad Manager 仍會繼續讀取並遵循該字串。建議發布商查看 GPP 或其他隱私權控制選項,並停止使用 us_national
。
vad_type
(影片廣告類型)
說明
影片廣告類型 (vad_type
) 參數接受常數值,會指出要傳回線性或非線性廣告。
使用範例
傳回線性廣告:
vad_type=linear
傳回非線性廣告:
vad_type=nonlinear
vid
(影片 ID)
說明
「內容來源 ID」參數 (cmsid
) 和「影片 ID」參數 (vid
) 接受變數值。
如要將廣告指定到影片內容,主影片廣告代碼必須同時包含這兩個參數。
cmsid
是每個內容來源的專屬號碼。如要在 Google Ad Manager 中找出這組號碼,請依序點選「影片」>「內容來源」> 來源名稱。vid
是用來表示特定影片的字串或編號。這個 ID 是由代管內容的內容管理平台指定。如要在 Google Ad Manager 中找出這個 ID,請依序點選「影片」>「內容」> 特定影片內容。
使用範例
cmsid=[value]&vid=[value]
如果是為包含動態廣告插播的隨選影片建立廣告代碼,應使用巨集,因為此巨集會動態插入正確的內容來源和影片 ID。
例如:cmsid=%%CMS_ID%%&vid=%%VIDEO_ID%%
需求條件和建議
雖然您不必使用這個參數為特定導入類型或交易類型放送廣告,但如果要使用影片內容指定目標,就必須使用這些參數。
vpi
(影片播放清單內嵌)