動態廣告插播 API 可讓您要求及追蹤 DAI 隨選串流。
服務:dai.google.com
所有 URI 皆與 https://dai.google.com 相關。
方法:建立串流
這個方法會直接從裝置建立串流,並傳回用戶端應用程式播放及追蹤廣告,以及顯示 UI 元素所需的所有資源。
| 方法 | |
|---|---|
create stream |
POST: /ondemand/pods/api/v1/network/{network_code}/stream
建立 DAI 插播 VOD 工作階段。 |
HTTP 要求
POST https://dai.google.com/ondemand/pods/api/v1/network/{network_code}/stream
路徑參數
| 參數 | |
|---|---|
network_code |
string
發布商的 Google Ad Manager 聯播網代碼。 |
要求主體
要求主體為 application/json 類型,且必須包含 CreateStreamRequest 物件。
回應主體
如果成功,回應主體會包含新的 CreateStreamResponse 物件。
方法:註冊串流
這個方法會在裝置的 Google DAI 後端註冊串流,並傳回用戶端應用程式追蹤廣告和顯示 UI 元素所需的所有資源。與 create stream 方法不同,這個方法不會傳回可播放的廣告資訊清單。而是透過另一個伺服器呼叫 decision ad pods 達成。
| 方法 | |
|---|---|
register stream |
POST: /ondemand/pods/api/v1/network/{network_code}/stream_registration
註冊動態廣告插播廣告插播隨選影片工作階段。 |
HTTP 要求
POST https://dai.google.com/ondemand/pods/api/v1/network/{network_code}/stream_registration
路徑參數
| 參數 | |
|---|---|
network_code |
string
發布商的 Google Ad Manager 聯播網代碼。 |
要求主體
要求主體為 application/json 類型,且必須包含 StreamRegistrationRequest 物件。
回應主體
如果成功,回應主體會包含新的 StreamRegistrationResponse 物件。
方法:擷取廣告連播
這個方法會追蹤裝置的 register stream 呼叫,並擷取可試玩廣告資訊清單,以便在內容資訊清單中縫合。
| 方法 | |
|---|---|
decision ad pods |
POST: /ondemand/pods/api/v1/network/{network_code}/streams/{stream_id}/adpods
為 DAI 廣告連播放送 VOD 工作階段決定廣告連播。 |
HTTP 要求
POST https://dai.google.com/ondemand/pods/api/v1/network/{network_code}/streams/{stream_id}/adpods
路徑參數
| 參數 | |
|---|---|
network_code |
string
發布商的 Google Ad Manager 聯播網代碼。 |
stream_id |
string
從 stream_registration 呼叫收到的 stream_id。 |
要求主體
要求主體為 application/json 類型,且必須包含 AdPodDecisionRequest 物件。
回應主體
如果成功,回應主體會包含新的 AdPodDecisionResponse 物件。
方法:廣告 Pod 中繼資料
這個方法會傳回用戶端應用程式追蹤廣告所需的所有資訊,並準確顯示適當的 UI 元素。
| 方法 | |
|---|---|
ad pods metadata |
GET: /ondemand/pods/api/v1/network/.../metadata
擷取特定工作階段的廣告連播中繼資料。這個網址會以 |
HTTP 要求
GET: /ondemand/pods/api/v1/network/.../metadata
回應主體
如果成功,回應主體會包含 Ad pods metadata 物件。
API 物件
PodMetadata
PodMetadata 包含廣告、廣告插播和媒體 ID 標記的中繼資料資訊。| JSON 表示法 |
|---|
{
"tags": map[string, object(TagSegment)],
"ads": map[string, object(Ad)],
"ad_breaks": map[string, object(AdBreak)],
"polling_frequency": number,
} |
| 欄位 | |
|---|---|
tags |
map[string, object(TagSegment)]依標記前置字元建立索引的標記區隔對應。 |
ads |
map[string, object(Ad)]依廣告 ID 編列索引的廣告地圖。 |
ad_breaks |
map[string, object(AdBreak)]廣告插播 ID 索引的廣告插播對應。 |
polling_frequency |
number建議的中繼資料網址輪詢頻率 (以秒為單位)。 使用隨選決策的 VOD 串流會填入這個值。 |
TagSegment
TagSegment 包含廣告、廣告插播和事件類型的參照。 類型為「progress」的 TagSegment 不應傳送至廣告媒體驗證端點。| JSON 表示法 |
|---|
{ "ad": string, "ad_break_id": string, "type": string, } |
| 欄位 | |
|---|---|
ad |
string這個代碼廣告的 ID。 |
ad_break_id |
string這個代碼廣告插播的 ID。 |
type |
string這個代碼的事件類型。 |
AdBreak
AdBreak 說明串流中的單一廣告插播。其中包含時間長度、類型 (片中/前/後) 和廣告數量。| JSON 表示法 |
|---|
{ "type": string, "duration": number, "expected_duration": number, "ads": number, } |
| 欄位 | |
|---|---|
type |
string有效的中斷類型為:pre、mid 和 post。 |
duration |
number這個廣告插播的廣告總長度 (以秒為單位)。 |
expected_duration |
number廣告插播的預計時間長度 (以秒為單位),包括所有廣告和任何字卡。 |
ads |
number廣告插播中的廣告數量。 |
廣告
Ad 會說明串流中的廣告。| JSON 表示法 |
|---|
{
"ad_break_id": string,
"position": number,
"duration": number,
"title": string,
"description": string,
"advertiser": string,
"ad_system": string,
"ad_id": string,
"creative_id": string,
"creative_ad_id": string,
"deal_id": string,
"clickthrough_url": string,
"click_tracking_urls": [],
"verifications": [object(Verification)],
"slate": boolean,
"icons": [object(Icon)],
"wrappers": [object(Wrapper)],
"universal_ad_id": object(UniversalAdID),
"extensions": [],
"companions": [object(Companion)],
"interactive_file": object(InteractiveFile),
} |
| 欄位 | |
|---|---|
ad_break_id |
string這個廣告的廣告插播 ID。 |
position |
number廣告在廣告插播中的位置,從 1 開始。 |
duration |
number廣告時間長度 (秒)。 |
title |
string廣告的選用標題。 |
description |
string廣告說明 (選填)。 |
advertiser |
string選填的廣告主 ID。 |
ad_system |
string選用廣告系統。 |
ad_id |
string廣告 ID (選用)。 |
creative_id |
string選填廣告素材 ID。 |
creative_ad_id |
string選填的廣告素材廣告 ID。 |
deal_id |
string選填交易 ID。 |
clickthrough_url |
string選用的到達網址。 |
click_tracking_urls |
string選用點擊追蹤網址。 |
verifications |
[object(Verification)]選用的開放式評估驗證項目,列出執行第三方評估程式碼所需的資源和中繼資料,以驗證廣告素材播放情形。 |
slate |
booleanOptional bool indicating the current entry is slate. |
icons |
[object(Icon)]圖示清單,如果為空白則省略。 |
wrappers |
[object(Wrapper)]Wrapper 清單,如果為空白則省略。 |
universal_ad_id |
object(UniversalAdID)選用通用廣告 ID。 |
extensions |
stringVAST 中所有 <Extension> 節點的選用清單。 |
companions |
[object(Companion)]可與此廣告一併顯示的選用隨播廣告。 |
interactive_file |
object(InteractiveFile)選用的互動式廣告素材 (SIMID),應在廣告播放期間顯示。 |
MatchOpts
MatchOpts 會為串流指定嚴格的媒體比對需求。| JSON 表示法 |
|---|
{
"audio_channels": boolean,
"audio_sample_rate": boolean,
} |
| 欄位 | |
|---|---|
audio_channels |
boolean比對內容和廣告的音訊頻道。 |
audio_sample_rate |
boolean確保內容和廣告的音訊取樣率一致。 |
CreateStreamRequest
CreateStreamRequest 會說明 HTTP 要求中的資訊,這些要求會傳送至 VOD Pod 服務 API。VTP (影片技術合作夥伴) 會代表 SDK 和發布商,為每位使用者啟動串流建立程序。系統會根據建立的串流,為 VTP 縫合已裁決的廣告連播。這與 StreamRegistrationRequest+AdPodDecisionRequest 流程不同,後者會註冊串流,並在多個要求中決定廣告插播。| JSON 表示法 |
|---|
{ "encoding_profiles": [object(EncodingProfile)], "ad_tag": string, "cuepoints": [], "manifest_type": string, "targeting_parameters": map[string, string], "content_duration_seconds": number, "dai_options": object(CreateStreamOptions), } |
| 欄位 | |
|---|---|
encoding_profiles |
[object(EncodingProfile)]編碼設定檔清單。必要。 |
ad_tag |
string用於決策的基本廣告代碼。必要。 |
cuepoints |
number以秒為單位設定的提示點清單。 如果廣告代碼的回應使用位置時間偏移,則為必填。 |
manifest_type |
string有效的資訊清單類型包括:hls 和 dash。預設值為 hls。選填。 |
targeting_parameters |
string其他 Ad Manager 指定目標參數。選用。 |
content_duration_seconds |
numberContentDurationSeconds 是內容長度 (以秒為單位)。 如果廣告代碼的回應使用百分比時間偏移,則必須提供這項資訊。 |
dai_options |
object(CreateStreamOptions)用於建立串流的 DAIOptions。 |
CreateStreamOptions
CreateStreamOptions 代表單一步驟串流建立工作流程中可用的選項。| JSON 表示法 |
|---|
{
"dash_profile": string,
"match_options": object(MatchOpts),
"data_sharing_policy_code": string,
"sam_id": string,
"session_title": string,
"dash_inband_event_stream": boolean,
"distinct_ad_profiles": boolean,
"tracking_mode": string,
"emsg_version": uint32,
} |
| 欄位 | |
|---|---|
dash_profile |
string要使用的 MPEG-DASH 設定檔,可以是「live」或「on-demand」。 |
match_options |
object(MatchOpts) |
data_sharing_policy_code |
string允許發布商覆寫聯播網預設的資料共用政策。 |
sam_id |
stringsam_id 是工作階段的 SAM 偵錯鍵,為選填。 |
session_title |
stringsession_title 是串流的 SAM 工作階段標題,為選填。 |
dash_inband_event_stream |
booleandash_inband_event_stream 表示 DAI 會使用 InbandEventStream 元素,將 ID3 訊息插入為帶內事件 (媒體內),而不是 EventStream 元素 (資訊清單內)。 |
distinct_ad_profiles |
boolean如果設為 true,表示伺服器在比對要求的編碼設定檔時,最多會使用一次任何可用的廣告設定檔。 |
tracking_mode |
stringtracking_mode 是要用於串流的廣告追蹤類型,為選用屬性。 有效值為:'ad_media'、'server'、'client'。 |
emsg_version |
uint32emsg_version 會強制在媒體內 ID3 中使用特定 emsg 版本。 只有在 dash_inband_event_stream 為 true 時才支援。 |
StreamRegistrationRequest
StreamRegistrationRequest 會從裝置註冊串流,以供日後做出廣告插播決策。這與 CreateStreamRequest 不同,後者會在單一要求中建立串流並決定廣告插播。| JSON 表示法 |
|---|
{
"targeting_parameters": map[string, string],
"dai_options": object(StreamRegistrationOptions),
} |
| 欄位 | |
|---|---|
targeting_parameters |
string其他 Ad Manager 指定目標參數。選填。 |
dai_options |
object(StreamRegistrationOptions)串流註冊的 DAIOptions。 |
StreamRegistrationOptions
StreamRegistrationOptions 會列出可用於建立串流的選項| JSON 表示法 |
|---|
{
"sam_id": string,
"tracking_mode": string,
"emsg_version": uint32,
"skippable_ads_supported": boolean,
} |
| 欄位 | |
|---|---|
sam_id |
stringsam_id 是工作階段的 SAM 偵錯鍵,為選填。 |
tracking_mode |
stringtracking_mode 是要用於串流的廣告追蹤類型,為選用屬性。 有效值為:'ad_media'、'server'、'client'。 |
emsg_version |
uint32emsg_version 會強制使用特定 emsg 版本,用於媒體內 ID3。只有在 dash_inband_event_stream 為 true 時才支援。 |
skippable_ads_supported |
boolean指出是否支援可略過的廣告。 |
StreamRegistrationResponse
StreamRegistrationResponse 代表傳回給用戶端的 JSON 回應,用來回應 StreamRegistrationRequest。包括串流 ID 和裝置所需的所有網址。後續的廣告插播決策要求可以參照這個串流 ID。這與 CreateStreamResponse 不同,後者代表建立串流和同時決定廣告插播位置的回應。| JSON 表示法 |
|---|
{
"stream_id": string,
"media_verification_url": string,
"valid_for": string,
"valid_until": string,
"metadata_url": string,
} |
| 欄位 | |
|---|---|
stream_id |
stringStreamID 是指該觀眾目前觀看串流的專屬 ID。 |
media_verification_url |
stringMediaVerificationURL 是廣告媒體驗證要求中使用的網址前置字元,不適用於用戶端信標串流。 |
valid_for |
stringValidFor 是這個串流的有效時間長度,格式為「00h00m00s」。 |
valid_until |
stringValidUntil 是指這個串流的有效日期和時間。 |
metadata_url |
stringMetadataURL 是用於要求廣告插播中繼資料的中繼資料網址。 |
DecisionTimingOptions
DecisionTimingOptions 說明串流廣告插播的決策時間選項。| JSON 表示法 |
|---|
{ "type": string, } |
| 欄位 | |
|---|---|
type |
string「類型」說明系統何時會為串流決定廣告插播。有效類型為:on_create (預設)、on_demand。 如果類型為 on_demand,系統會在要求特定插斷的資訊清單時,延遲決定廣告。如果類型為「on_create」,系統會在建立串流時決定所有廣告。 |
EncodingProfile
EncodingProfile 會說明單一內容變體的編碼。 當中可能只包含影片設定、只包含音訊設定 (如果是媒體類型)、同時包含影片和音訊設定,或是不包含任何設定 (如果是字幕)。| JSON 表示法 |
|---|
{ "profile_name": string, "type": string, "container_type": string, "video_settings": object(VideoSettings), "audio_settings": object(AudioSettings), "subtitle_settings": object(SubtitleSettings), } |
| 欄位 | |
|---|---|
profile_name |
string發布商為設定檔提供的名稱。每個串流都必須是唯一的。必要。 |
type |
string有效類型包括:媒體、iframe、字幕。必要。 |
container_type |
string有效類型包括:mpeg2ts、fmp4cmaf 和 hls_packed_audio。 「類型」為「媒體」和「iframe」時,這是必填欄位。 |
video_settings |
object(VideoSettings)如果容器類型為 iframe,則必須設定影片設定。 否則,只有在個人資料包含影片時才會顯示。 |
audio_settings |
object(AudioSettings)如果設定檔包含音訊,就會顯示音訊設定。 只有在容器類型為媒體時,才能使用音訊設定。 |
subtitle_settings |
object(SubtitleSettings)如要使用「輸入字幕」功能,必須先設定字幕。 |
VideoSettings
VideoSettings 會說明編碼設定檔的影片。 如果存在一個影片設定,則所有設定都必須存在。| JSON 表示法 |
|---|
{
"codec": string,
"bitrate": int32,
"frames_per_second": number,
"resolution": object(Resolution),
} |
| 欄位 | |
|---|---|
codec |
string影片的 RFC6381 轉碼器字串。 |
bitrate |
int32編碼設定檔的最高影片位元率。 |
frames_per_second |
number影片的每秒畫格數。 |
resolution |
object(Resolution)影片的寬度 x 高度解析度。 |
AudioSettings
AudioSettings 說明編碼設定檔的音訊。 如果存在一項音訊設定,就必須存在所有音訊設定。| JSON 表示法 |
|---|
{
"codec": string,
"bitrate": int32,
"channels": int32,
"sample_rate": int64,
} |
| 欄位 | |
|---|---|
codec |
string音訊的 RFC6381 轉碼器字串。 |
bitrate |
int32編碼設定檔的音訊位元率上限。 |
channels |
int32音訊聲道數 (包括低頻聲道)。 |
sample_rate |
int64音訊的取樣率,單位為赫茲。 |
SubtitleSettings
SubtitleSettings 說明編碼設定檔的字幕。| JSON 表示法 |
|---|
{
"format": string,
"language": string,
} |
| 欄位 | |
|---|---|
format |
string字幕格式: HLS 適用 webvtt,DASH 適用 webvtt 或 ttml。 |
language |
string要插入資訊清單的語言。 |
解析度
解析度是指影片的寬度 x 高度。| JSON 表示法 |
|---|
{
"width": int32,
"height": int32,
} |
| 欄位 | |
|---|---|
width |
int32影片寬度 (以像素為單位)。必要。 |
height |
int32影片的高度,以像素為單位。必要。 |
AdPodDecisionRequest
AdPodDecisionRequest 代表對先前註冊的串流做出廣告連播決策的要求。| JSON 表示法 |
|---|
{ "encoding_profiles": [object(EncodingProfile)], "ad_tag": string, "cuepoints": [], "manifest_type": string, "targeting_parameters": map[string, string], "content_duration_seconds": number, "dai_options": object(AdPodDecisionOptions), } |
| 欄位 | |
|---|---|
encoding_profiles |
[object(EncodingProfile)]編碼設定檔清單。必要。 |
ad_tag |
string用於決策的基本廣告代碼。必要。 |
cuepoints |
number以秒為單位設定的提示點清單。 如果廣告代碼的回應使用位置時間偏移,則為必填。 |
manifest_type |
string有效的資訊清單類型包括:hls 和 dash。預設值為 hls。選填。 |
targeting_parameters |
string其他 Ad Manager 指定目標參數。選用。 |
content_duration_seconds |
numberContentDurationSeconds 是內容長度 (以秒為單位)。 如果廣告代碼的回應使用百分比時間位移,則必須提供這項參數。 |
dai_options |
object(AdPodDecisionOptions)廣告連播決策的 DAIOptions。 |
AdPodDecisionResponse
AdPodDecisionResponse 代表先前註冊串流的決策廣告連播回應。當中列出該串流的廣告連播決策。| JSON 表示法 |
|---|
{
"valid_for": string,
"valid_until": string,
"ad_pods": [object(AdPod)],
} |
| 欄位 | |
|---|---|
valid_for |
stringValidFor 是這個串流的有效時間長度,格式為「00h00m00s」。 |
valid_until |
stringValidUntil 是指這個串流的有效日期和時間。 |
ad_pods |
[object(AdPod)]廣告連播清單,依插入順序排序。 |
CreateStreamResponse
CreateStreamResponse 代表傳回給用戶端的 JSON 回應,用來回應 CreateStreamRequest。| JSON 表示法 |
|---|
{
"valid_for": string,
"valid_until": string,
"ad_pods": [object(AdPod)],
"stream_id": string,
"media_verification_url": string,
"pod_metadata": object(PodMetadata),
"metadata_url": string,
} |
| 欄位 | |
|---|---|
valid_for |
stringValidFor 是這個串流的有效時間長度,格式為「00h00m00s」。 |
valid_until |
stringValidUntil 是指這個串流的有效日期和時間。 |
ad_pods |
[object(AdPod)]廣告連播清單,依插入順序排序。 |
stream_id |
stringStreamID 是指這個觀眾目前觀看串流的專屬 ID。 |
media_verification_url |
stringMediaVerificationURL 是廣告媒體驗證要求中使用的網址前置字元,透過用戶端信標建立的串流不會顯示這項資訊。 |
pod_metadata |
object(PodMetadata)PodMetadata 包含在裝置上算繪 Pod 和觸發驗證所需的額外資訊。 如動態廣告插播線性 API 說明文件所述。 僅適用於用戶端信標串流。 |
metadata_url |
stringMetadataURL 是用於要求廣告插播中繼資料的中繼資料網址。 |
AdPod
AdPod 代表已決定的廣告插播,可供播放。| JSON 表示法 |
|---|
{ "manifest_uris": map[string, string], "mpd_uri": string, "start": number, "duration": number, "type": string, "midroll_index": number, } |
| 欄位 | |
|---|---|
manifest_uris |
stringManifestURIs 是編碼設定檔名稱對應至 HTTP 即時串流變體 manifest_uris 的對應,適用於 HTTP 即時串流內容。 |
mpd_uri |
stringMPDURI 是 DASH 內容的 MPD URI。 |
start |
number素材資源時間軸中廣告連播的開始時間 (不含先前的廣告連播),以浮點秒數表示。 |
duration |
number廣告連播時間長度 (以浮點秒數表示)。 |
type |
string廣告插播類型。 |
midroll_index |
number串流中插播廣告的 1 索引,以 VMAP 廣告插播 ID 為準。 片頭和片尾廣告會省略這項資訊。 |
AdPodDecisionOptions
AdPodDecisionOptions 代表串流的其他選項。| JSON 表示法 |
|---|
{
"dash_profile": string,
"match_options": object(MatchOpts),
"data_sharing_policy_code": string,
"sam_id": string,
"session_title": string,
"dash_inband_event_stream": boolean,
"distinct_ad_profiles": boolean,
} |
| 欄位 | |
|---|---|
dash_profile |
string要使用的 MPEG-DASH 設定檔,可以是「live」或「on-demand」。 |
match_options |
object(MatchOpts) |
data_sharing_policy_code |
string允許發布商覆寫聯播網預設的資料共用政策。 |
sam_id |
stringsam_id 是工作階段的 SAM 偵錯鍵,為選填。 |
session_title |
stringsession_title 是串流的 SAM 工作階段標題,為選填。 |
dash_inband_event_stream |
booleandash_inband_event_stream 表示 DAI 會使用 InbandEventStream 元素,將 ID3 訊息插入為帶內事件 (媒體內),而不是 EventStream 元素 (資訊清單內)。 |
distinct_ad_profiles |
boolean如果設為 true,表示伺服器在比對要求的編碼設定檔時,最多會使用一次任何可用的廣告設定檔。 |
串流
Stream 用於以 JSON 格式,為新建立的串流算繪所有資源的清單。| JSON 表示法 |
|---|
{
"stream_id": string,
"valid_for": string,
"valid_until": string,
"media_verification_url": string,
} |
| 欄位 | |
|---|---|
stream_id |
string串流 ID。 |
valid_for |
string串流的有效時間長度,格式為「00h00m00s」。 |
valid_until |
string串流的有效日期,採用 RFC 3339 格式。 |
media_verification_url |
string媒體驗證網址。 |
圖示
Icon 包含 VAST 圖示的相關資訊。| JSON 表示法 |
|---|
{ "click_data": object(ClickData), "creative_type": string, "click_fallback_images": [object(FallbackImage)], "height": int32, "width": int32, "resource": string, "type": string, "x_position": string, "y_position": string, "program": string, "alt_text": string, } |
| 欄位 | |
|---|---|
click_data |
object(ClickData) |
creative_type |
string |
click_fallback_images |
[object(FallbackImage)] |
height |
int32 |
width |
int32 |
resource |
string |
type |
string |
x_position |
string |
y_position |
string |
program |
string |
alt_text |
string |
ClickData
ClickData 包含圖示點擊的相關資訊。| JSON 表示法 |
|---|
{
"url": string,
} |
| 欄位 | |
|---|---|
url |
string |
FallbackImage
FallbackImage 包含 VAST 備用圖片的相關資訊。| JSON 表示法 |
|---|
{ "creative_type": string, "height": int32, "width": int32, "resource": string, "alt_text": string, } |
| 欄位 | |
|---|---|
creative_type |
string |
height |
int32 |
width |
int32 |
resource |
string |
alt_text |
string |
Wrapper
Wrapper 包含包裝廣告的相關資訊。如果沒有交易 ID,就不會顯示。| JSON 表示法 |
|---|
{
"system": string,
"ad_id": string,
"creative_id": string,
"creative_ad_id": string,
"deal_id": string,
} |
| 欄位 | |
|---|---|
system |
string廣告系統 ID。 |
ad_id |
string用於包裝廣告的廣告 ID。 |
creative_id |
string用於包裝函式廣告的廣告素材 ID。 |
creative_ad_id |
string用於包裝函式廣告的廣告素材廣告 ID。 |
deal_id |
string包裝函式廣告的選填交易 ID。 |
驗證
驗證包含 Open Measurement 的資訊,可協助進行第三方可視度和驗證評估。目前僅支援 JavaScript 資源。 請參閱 https://iabtechlab.com/standards/open-measurement-sdk/| JSON 表示法 |
|---|
{
"vendor": string,
"java_script_resources": [object(JavaScriptResource)],
"tracking_events": [object(TrackingEvent)],
"parameters": string,
} |
| 欄位 | |
|---|---|
vendor |
string驗證服務供應商。 |
java_script_resources |
[object(JavaScriptResource)]驗證用的 JavaScript 資源清單。 |
tracking_events |
[object(TrackingEvent)]驗證的追蹤事件清單。 |
parameters |
string傳遞至啟動程序驗證碼的不透明字串。 |
JavaScriptResource
JavaScriptResource 包含透過 JavaScript 驗證的資訊。| JSON 表示法 |
|---|
{
"script_url": string,
"api_framework": string,
"browser_optional": boolean,
} |
| 欄位 | |
|---|---|
script_url |
stringURI to javascript payload. |
api_framework |
stringAPIFramework 是執行驗證碼的影片架構名稱。 |
browser_optional |
boolean這個指令碼是否能在瀏覽器外執行。 |
TrackingEvent
TrackingEvent 包含用戶端在特定情況下應 Ping 的網址。| JSON 表示法 |
|---|
{
"event": string,
"uri": string,
} |
| 欄位 | |
|---|---|
event |
string追蹤事件的類型。 |
uri |
string要 Ping 的追蹤事件。 |
UniversalAdID
UniversalAdID 可提供廣告素材專屬 ID,並在各個廣告系統中維持不變。| JSON 表示法 |
|---|
{ "id_value": string, "id_registry": string, } |
| 欄位 | |
|---|---|
id_value |
string所選廣告素材的通用廣告 ID。 |
id_registry |
string用來識別註冊資料庫網站網址的字串,所選廣告素材的通用廣告 ID 會編目於該網站。 |
Companion
隨播廣告包含可能與廣告一起顯示的隨播廣告資訊。| JSON 表示法 |
|---|
{ "click_data": object(ClickData), "creative_type": string, "height": int32, "width": int32, "resource": string, "type": string, "ad_slot_id": string, "api_framework": string, "tracking_events": [object(TrackingEvent)], } |
| 欄位 | |
|---|---|
click_data |
object(ClickData)這個隨播廣告的點擊資料。 |
creative_type |
string如果這是靜態類型的隨播廣告,VAST 中 <StaticResource> 節點的 CreativeType 屬性。 |
height |
int32這個隨播廣告的高度 (以像素為單位)。 |
width |
int32這個隨播廣告的寬度 (以像素為單位)。 |
resource |
string如果是靜態和 iframe 隨播廣告,這就是要載入及顯示的網址。如果是 HTML 隨播廣告,這會是應顯示為隨播廣告的 HTML 程式碼片段。 |
type |
string這個配對裝置的類型。可以是靜態、iframe 或 HTML。 |
ad_slot_id |
string這個配對裝置的版位 ID。 |
api_framework |
string這個輔助裝置的 API 架構。 |
tracking_events |
[object(TrackingEvent)]這個同伴的追蹤事件清單。 |
InteractiveFile
InteractiveFile 包含互動式廣告素材 (即 SIMID) 的資訊,應在廣告播放期間顯示。| JSON 表示法 |
|---|
{ "resource": string, "type": string, "variable_duration": boolean, "ad_parameters": string, } |
| 欄位 | |
|---|---|
resource |
string互動式廣告素材的網址。 |
type |
string做為資源提供的檔案 MIME 類型。 |
variable_duration |
boolean這個廣告素材是否可以要求延長時間。 |
ad_parameters |
stringVAST 中 <AdParameters> 節點的值。 |