動態廣告插播廣告連播放送 Live API

您可以使用動態廣告插播 API 請求及追蹤動態廣告插播直播。

服務：dai.google.com

所有 URI 皆與 https://dai.google.com 相關。

方法：串流

方法
stream POST /ssai/pods/api/v1/network/{network_code}/custom_asset/{custom_asset_key}/stream

註冊 DAI 廣告連播放送直播工作階段。

HTTP 要求

POST https://dai.google.com/ssai/pods/api/v1/network/{network_code}/custom_asset/{custom_asset_key}/stream

路徑參數

參數
network_code string

發布商的 Google Ad Manager 聯播網代碼。

custom_asset_key string

與 Google Ad Manager 中的這個事件相關聯的自訂 ID。

要求主體

要求主體為 application/x-www-form-urlencoded 類型，並包含下列參數：

參數
DFP 指定目標參數 選用 其他指定目標參數。
覆寫串流參數 選用 覆寫串流建立參數的預設值。
HMAC 驗證 選用 使用 HMAC 型權杖進行驗證。

回應主體

如果成功，回應主體會包含新的 Stream 物件。

Open Measurement

DAI API 的 Verifications 欄位包含 Open Measurement 驗證資訊。這個欄位包含一或多個 Verification 元素，列出執行第三方評估程式碼所需的資源和中繼資料，以驗證廣告素材播放情形。僅支援 JavaScriptResource。詳情請參閱 IAB Tech Lab 和 VAST 4.1 規格。

方法：廣告連播區隔

方法
pod segment GET /linear/pods/v1/seg/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}/profile/{profile_name}/{segment_number}.{segment_format}

為指定活動 ID 建立動態廣告插播串流。

HTTP 要求

GET https://dai.google.com/linear/pods/v1/seg/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}/profile/{profile_name}/{segment_number}.{segment_format}

路徑參數

參數
network_code string

發布商的 Google Ad Manager 聯播網代碼。

custom_asset_key string

與 Google Ad Manager 中的這個事件相關聯的自訂 ID。

pod_identifier

支援的格式如下：

pod/{integer}

目前廣告插播的數字 ID。系統會為每個廣告插播事件遞增指派廣告組 ID，從 1 開始。

ad_break_id/{string}

目前廣告插播的字串 ID。發布商提供的廣告插播 ID 與廣告連播 ID 的限制不同。提供給該端點的任何不明廣告插播 ID，都會為直播活動建立新的廣告插播。
profile_name string

所要求 Google Ad Manager DAI 編碼設定檔的名稱。 編碼設定檔必須是所選活動的已設定編碼設定檔。

segment_number integer

目前廣告連播中要求的區隔索引，從零開始。
segment_format string

與所要求區段格式相關聯的副檔名。 接受的副檔名為：ts、mp4、vtt、aac、ac3 或 eac3。

查詢參數

參數
stream_id 必要 string

目前使用者工作階段的串流 ID。如果對 stream 端點的要求成功，就會傳回這個值。
sd required1 integer

要求的片段時間長度 (以毫秒為單位)。
so 選填

廣告連播中要求區隔的位移 (以毫秒為單位)。 如果省略 so 參數，系統會將區隔時間長度乘以區隔編號，計算出時間碼。
pd required2 integer

廣告連播的時間長度 (以毫秒為單位)。
auth-token 必要 string

目前廣告插播的已簽署網址編碼 HMAC 權杖。
last 選填 boolean

表示廣告插播中的最後一個區段。其他所有區隔都請省略這個參數。
scte35 選填 string

這個廣告插播的 Base64 編碼 SCTE-35 信號。
cust_params 選填 string

一組鍵/值組合，用於 Ad Manager 廣告活動指定目標。這些配對必須以網址編碼查詢字串表示。

範例：
參數
  • section = sports
  • page = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

註釋

  1. 初始化區段不需要 sd。 ↩
  2. 如果啟用無時間長度的廣告插播，則不需要 pd。↩

範例

GET https://dai.google.com/linear/pods/v1/seg/network/sandbox_dev/custom_asset/podserving-segredirect-custom-key/ad_break_id/adbreak-2/profile/8b8888cf79ad43f0800482ffc035a1ac_ts_a/1.ts?so=0&sd=10000&pd=30000&stream_id=8e19cbc6-850b-404c-99d7-860aa4a674cb:TEST

GET https://dai.google.com/linear/pods/v1/seg/network/sandbox_dev/custom_asset/podserving-segredirect-custom-key/pod/2/profile/8b8888cf79ad43f0800482ffc035a1ac_ts_a/1.ts?so=0&sd=10000&pd=30000&stream_id=8e19cbc6-850b-404c-99d7-860aa4a674cb:TEST

回應主體

如果成功，回應主體會是可播放的串流片段，符合要求中指定的格式和參數。

方法：HLS 廣告連播資訊清單

擷取直播的 HLS 廣告連播資訊清單，供用戶端影片播放器載入及播放。

方法
GET GET /linear/pods/v1/hls/network/{network_code}/custom_asset/{custom_asset}/{pod_identifier}.m3u8;

API：擷取廣告連播的 HTTP 即時串流多變化版本播放清單。

HTTP 要求

GET https://dai.google.com/linear/pods/v1/hls/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}.m3u8?stream_id={stream_id}&pd={pod_duration}

路徑參數

參數
network_code string

發布商的 Google Ad Manager 聯播網代碼。
custom_asset_key string

Google Ad Manager 中與這個事件相關聯的自訂 ID
pod_identifier

支援的格式如下：

pod/{integer}

目前廣告插播的數字 ID。系統會為每個廣告插播事件遞增指派廣告組 ID，從 1 開始。

ad_break_id/{string}

目前廣告插播的字串 ID。發布商提供的廣告插播 ID 與廣告連播 ID 的限制不同。提供給該端點的任何不明廣告插播 ID，都會為直播活動建立新的廣告插播。

查詢參數

參數
stream_id 必要 string

目前使用者工作階段的串流 ID。如果對 stream 端點的要求成功，就會傳回這個值。
pd 必要 integer

廣告連播的時間長度 (以毫秒為單位)。
scte35 選填 string

這個廣告插播的 Base64 編碼 SCTE-35 信號。
cust_params 選填 string

一組鍵/值組合，用於 Ad Manager 廣告活動指定目標。這些配對必須以網址編碼查詢字串表示。

範例：
參數
  • section = sports
  • page = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

回應主體

如果成功，回應主體會是 HTTP 即時串流多變化版本播放清單。

方法：DASH 廣告連播資訊清單

擷取直播的 MPEG-DASH 廣告連播資訊清單，供用戶端影片播放器載入及播放。

方法
GET GET /linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset}/stream/{stream_id}/pod/{pod_id}/manifest.mpd

API：用於擷取廣告連播的 MPEG-DASH mpd 播放清單。

HTTP 要求

GET https://dai.google.com/linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/stream/{stream_id}/pod/{pod_id}/manifest.mpd?pd={pod_duration}

路徑參數

參數
network_code string

發布商的 Google Ad Manager 聯播網代碼。
custom_asset_key string

Google Ad Manager 中與這個事件相關聯的自訂 ID
stream_id string

目前使用者工作階段的串流 ID。如果對 stream 端點的要求成功，就會傳回這個值。
pod_id integer

目前廣告插播的數字 ID。系統會為每個廣告插播事件遞增指派廣告組 ID，從 1 開始。

在目前事件中觀看同一廣告插播的所有使用者，

查詢參數

參數
pd 必要 integer

廣告連播的時間長度 (以毫秒為單位)。
scte35 選填 string

這個廣告插播的 Base64 編碼 SCTE-35 信號。
cust_params 選填 string

一組鍵/值組合，用於 Ad Manager 廣告活動指定目標。這些配對必須以網址編碼查詢字串表示。

範例：
參數
  • section = sports
  • page = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

回應主體

如果成功，回應主體會是 MPEG-DASH mpd 播放清單。

方法：DASH Pod 週期範本

方法
pods GET /linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/pods.json

向 Google Ad Manager 要求 DASH 週期範本。這個範本含有巨集，您必須填入串流參數。填入這些巨集後，範本就會成為廣告插播時間，並可併入 DASH 資訊清單。

HTTP 要求

GET https://dai.google.com/linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/pods.json

路徑參數

參數
network_code string

發布商的 Google Ad Manager 聯播網代碼。

custom_asset_key string

與 Google Ad Manager 中的這個事件相關聯的自訂 ID。

查詢參數

參數
stream_id 必要 string

目前使用者工作階段的串流 ID。如果對 stream 端點的要求成功，就會傳回這個值。
tv 選填 integer

範本版本。預設為 0。指定要傳回的 Pod 範本版本。

  • 0：要求使用廣告連播序列 ID 的範本。
  • 1：要求同時支援廣告連播序列和廣告插播 ID 的範本。

回應主體

如果成功，回應主體會包含新的 PodTemplateResponse 物件。

方法：廣告連播時間中繼資料

方法
ad pod timing metadata GET /linear/pods/v1/adv/network/{network_code}/custom_asset/{custom_asset_key}/pod.json

擷取廣告連播時間中繼資料。

HTTP 要求

GET https://dai.google.com/linear/pods/v1/adv/network/{network_code}/custom_asset/{custom_asset_key}/pod.json

路徑參數

參數
network_code string

發布商的 Google Ad Manager 聯播網代碼。

custom_asset_key string

與 Google Ad Manager 中這部直播影片相關聯的自訂 ID。

查詢參數

參數
stream_id 必要 string

用戶端影片播放器應用程式的 Ad Manager 串流 ID。
ad_break_id 必要 string

下一個即將出現的廣告插播 ID。

廣告插播 ID 由 Stitching 伺服器或 VTP 提供，且必須與相同廣告插播的「即將到來的廣告插播通知」、廣告連播時間中繼資料請求和區隔重新導向請求一致。

自訂中插廣告 ID 須遵守下列限制：

  • 長度必須介於 1 至 63 個字元之間
  • 只能使用小寫英文字母、數字和連字號。
  • 廣告插播 ID preroll 保留用於擷取片頭廣告連播。無法用於識別任何其他廣告插播。
auth-token 必要 string

auth-token 包含 HMAC 權杖，以及下列參數：

  • ad_break_id
  • custom_asset_key
  • exp
  • network_code
  • custom_params
  • pd
  • scte35
timeout 選填 integer

DAI 可封鎖這項要求，等待廣告決策的毫秒數。如果請求必須在第一次請求時傳回已填入的廣告，例如前置廣告插播，請使用這個參數。

如果超過逾時時間，要求會傳回待處理狀態。

如果包含逾時值，則該值必須介於 1000 至 15000 毫秒之間。如果省略這項設定，系統不會延遲回應，等待廣告決策。
final 選填 boolean

設為 true，向 DAI 指出這是 VTP 願意為這個廣告連播提出的最後一個請求。如果廣告決策尚未出爐 (在選用逾時時間內)，DAI 會針對這項要求永久傳回廣告插播片。

預設值為 false。

廣告決策參數
pd 選用 integer

廣告插播時間長度 (以毫秒為單位)。也稱為廣告插播時間長度。

如果使用 EABN，pd 值必須與廣告插播通知中提供的時間長度相符。如果時間長度不符，系統會優先採用 EABN 值。
cust_params 選填 string

廣告插播指定目標的自訂參數，如Ad Manager 說明中心所述。
scte35 選用 string

Base64 編碼的 SCTE-35 信號。

如果信號無效，系統會在回應的 X-Ad-Manager-Dai-Warning HTTP 標頭中傳送訊息，並在傳送要求時移除無效的 scte35 值。

回應主體

如果成功，回應主體會包含新的 AdPodTimingMetadataResponse 物件。

方法：媒體驗證

在播放期間遇到廣告媒體 ID 後，請立即使用從上述 stream 端點取得的 media_verification_url 發出要求。如果是伺服器端信號傳送串流，伺服器會啟動媒體驗證，因此不需要這些要求。

對 media verification 端點的要求是等冪。

方法
media verification GET /{media_verification_url}/{ad_media_id}

向 API 通知媒體驗證事件。

HTTP 要求

GET https://{media-verification-url}/{ad-media-id}

回應主體

media verification 會傳回下列回應：

  • HTTP/1.1 204 No Content (如果媒體驗證成功，且所有 Ping 都已傳送)。
  • HTTP/1.1 404 Not Found 如果要求因網址格式不正確或過期而無法驗證媒體。
  • HTTP/1.1 404 Not Found 如果先前對這個 ID 提出的驗證要求成功。
  • HTTP/1.1 409 Conflict如果其他要求已在此時間傳送 Ping。

廣告媒體 ID

廣告媒體 ID 會編碼至個別的中繼資料軌中，也就是 HLS 傳輸串流的計時中繼資料，或是 mp4 檔案的 emsg。廣告媒體 ID 一律以字串 google_ 開頭。

在提出每項廣告驗證要求前，應將中繼資料項目的所有文字內容附加至廣告驗證網址。

方法：metadata

metadata_url 的中繼資料端點會傳回用於建構廣告使用者介面的資訊。中繼資料端點不適用於伺服器端信號傳送串流，因為伺服器負責啟動廣告媒體驗證。

方法
metadata GET /{metadata_url}/{ad-media-id}

GET /{metadata_url}

擷取廣告中繼資料資訊。

HTTP 要求

GET https://{metadata_url}/{ad-media-id}

GET https://{metadata_url}

回應主體

如果成功，回應會傳回 PodMetadata 的例項。

剖析中繼資料

中繼資料有三個獨立部分：tags、ads 和廣告 breaks。資料的進入點是 tags 區段。然後逐一檢查標記，找出名稱是影片串流中廣告媒體 ID 前置字元的第一個項目。舉例來說，您的廣告媒體 ID 可能如下所示：

google_1234567890

然後找到名為 google_12345 的標記物件。在本例中，這與廣告媒體 ID 相符。找到正確的廣告媒體前置字串物件後，即可查詢廣告 ID、廣告插播 ID 和事件類型。然後，廣告 ID 會用於為 ads 物件建立索引，廣告插播 ID 則用於為 breaks 物件建立索引。

API 物件

串流

Stream 用於以 JSON 格式，為新建立的串流算繪資源清單。
JSON 表示法
{
  "stream_id": string,
  "media_verification_url": string,
  "metadata_url": string,
  "session_update_url": string,
  "heartbeat_url": string,
  "polling_frequency": number,
  "pod_manifest_url": string,
  "manifest_format": string,
}
欄位
stream_id string

GAM 串流 ID。
media_verification_url string

媒體驗證網址，用來做為追蹤播放事件的基本端點。
metadata_url string

用來輪詢即將推出的串流廣告事件相關定期資訊的中繼資料網址。
session_update_url string

用於更新這個串流指定目標參數的會期更新網址。 系統會在初始串流建立要求期間擷取指定目標參數的原始值。
heartbeat_url string

心跳網址，用於維持伺服器端信標串流的運作，每 {PollingFrequency} 秒必須 ping 一次。 適用於伺服器端信標串流。
polling_frequency number

要求 metadata_url 或 heartbeat_url 時的輪詢頻率 (以秒為單位)。
pod_manifest_url string

Pod 資訊清單網址範本用於產生網址，以擷取串流的 Pod 資訊清單， 對應於 HLS 中的多變體播放清單網址或 DASH 中的 MPD。 系統會為動態廣告插播類型為 POD_SERVING_MANIFEST 的直播活動填入這個值。 https://developers.google.com/ad-manager/api/reference/v202305/LiveStreamEventService.DynamicAdInsertionType
manifest_format string

資訊清單格式是從 pod_manifest_url 擷取的資訊清單格式，可以是 dash 或 hls。

PodMetadata

PodMetadata 包含廣告、廣告插播和媒體 ID 標記的中繼資料資訊。
JSON 表示法
{
  "tags": map[string, object(TagSegment)],
  "ads": map[string, object(Ad)],
  "ad_breaks": map[string, object(AdBreak)],
}
欄位
tags map[string, object(TagSegment)]

依標記前置字元編列索引的標記區隔對應。
ads map[string, object(Ad)]

依廣告 ID 編列索引的廣告地圖。
ad_breaks map[string, object(AdBreak)]

廣告插播 ID 索引的廣告插播對應。

TagSegment

TagSegment 包含廣告、廣告插播和事件類型的參照。 類型為「progress」的 TagSegment 不應 Ping 至廣告媒體驗證端點。
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

有效的中斷類型包括：前、中和後。
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)]

選用的 Open Measurement 驗證項目，列出執行第三方評估程式碼所需的資源和中繼資料，以驗證廣告素材播放情形。
slate boolean

選用布林值，指出目前項目是否為推薦內容。
icons [object(Icon)]

圖示清單，如果為空白則省略。
wrappers [object(Wrapper)]

包裝函式清單，如果為空白則省略。
universal_ad_id object(UniversalAdID)

選填的通用廣告 ID。
extensions string

VAST 中所有 <Extension> 節點的選用清單。
companions [object(Companion)]

可與此廣告一併顯示的選用隨播廣告。
interactive_file object(InteractiveFile)

廣告播放期間顯示的選用互動式廣告素材 (SIMID)。

PodTemplateResponse

PodTemplateResponse 代表傳回 VTP 的 JSON 酬載，用於 Pod 縫合。
JSON 表示法
{
  "dash_period_template": string,
  "segment_duration_ms": int64,
}
欄位
dash_period_template string

DashPeriodTemplate 是期間的 XML 範本，會在縫合前填入適當資料。
segment_duration_ms int64

SegmentDurationMS 是以毫秒為單位的時間區段長度。

AdpodTimingMetadataResponse

AdpodTimingMetadataResponse 包含廣告插播的相關資訊，以及如何為廣告插播建構區隔網址。
JSON 表示法
{
  "status": string,
  "ads": [object(AdRendering)],
  "slate": object(SlateRendering),
  "dash_representations": map[string, object(DASHRepresentation)],
  "dash_adaptation_sets": map[string, object(DASHAdaptationSet)],
}
欄位
status string

廣告連播的決策狀態。
ads [object(AdRendering)]

廣告物件陣列，說明如何顯示廣告區隔網址，索引從 0 開始。
slate object(SlateRendering)

Slate，說明如何算繪 Slate 片段網址。
dash_representations map[string, object(DASHRepresentation)]

要在 DASH 資訊清單中算繪的廣告連播 DASH 呈現方式清單。
dash_adaptation_sets map[string, object(DASHAdaptationSet)]

要在 DASH 資訊清單中算繪的廣告插播 DASH 調適集清單。

AdRendering

AdRendering 說明如何顯示已做出決策的廣告。
JSON 表示法
{
  "duration_ms": number,
  "variants": map[string, object(VariantRendering)],
}
欄位
duration_ms number

廣告時間長度 (以毫秒為單位，整數)。
variants map[string, object(VariantRendering)]

變化版本物件的字典 (請參閱下文)，以從 UI 設定的變化版本/設定檔 ID 為索引。

SlateRendering

SlateRendering 說明如何算繪 Slate 內容。
JSON 表示法
{
  "duration_ms": number,
  "variants": map[string, object(VariantRendering)],
}
欄位
duration_ms number

片頭時間長度 (以毫秒為單位，整數)。
variants map[string, object(VariantRendering)]

變化版本物件的字典，以變化版本/設定檔 ID 做為索引。 必須重複播放片頭，直到達到所需長度為止，並在疊代之間插入 HLS 不連續點，或重複播放 MPEG-DASH 的新週期。

VariantRendering

VariantRendering 說明廣告/影視內容中的一個變體/設定檔。
JSON 表示法
{
  "segment_extension": string,
  "segment_durations": object(SegmentDurations),
}
欄位
segment_extension string

字串，可以是 ts、mp4、aac、ac3、ec3、m4a、m4v。 區隔網址的副檔名部分。
segment_durations object(SegmentDurations)

SegmentDurations 物件。每個區段的持續時間都可以轉換為區段網址。

SegmentDurations

SegmentDurations 會以指定的時間單位，說明一系列區隔的時間長度。
JSON 表示法
{
  "timescale": number,
  "values": [],
}
欄位
timescale number

時間刻度是每秒的單位數 (int) 預期值： HLS 為 1000 (毫秒) DASH 影片為 90000 (PTS) DASH 音訊的音訊取樣率。
values number

以時間碼單位表示的整數區段時間長度陣列。

DASHRepresentation

DASHRepresentation 說明要在 DASH 資訊清單中轉譯的 Representation 節點。
JSON 表示法
{
  "codecs": string,
  "bandwidth": number,
  "width": number,
  "height": number,
  "frame_rate": string,
  "audio_sampling_rate": number,
  "audio_channel_config": object(SchemeIDURIAndValue),
}
欄位
codecs string

代表的轉碼器。
bandwidth number

表示法的頻寬。
width number

表示法的寬度。
height number

代表的高度。
frame_rate string

表示的影格速率。
audio_sampling_rate number

表示法的音訊取樣率。
audio_channel_config object(SchemeIDURIAndValue)

代表的音軌設定。

DASHAdaptationSet

DASHAdaptationSet 會說明要在 DASH 資訊清單中算繪的 AdaptationSet 節點。
JSON 表示法
{
  "content_type": string,
  "mime_type": string,
  "role": object(SchemeIDURIAndValue),
  "inband_event_stream": object(SchemeIDURIAndValue),
  "min_frame_rate": string,
  "max_frame_rate": string,
  "scan_type": string,
  "start_with_sap": string,
  "segment_alignment": boolean,
  "representations": [],
}
欄位
content_type string

改編集的內容類型。
mime_type string

調整集 MIME 類型。
role object(SchemeIDURIAndValue)

調整組的角色。
inband_event_stream object(SchemeIDURIAndValue)

適應集帶內事件串流。
min_frame_rate string

調整集最低影格速率。
max_frame_rate string

調整集的最大影格速率。
scan_type string

調整項集的掃描類型。
start_with_sap string

從改編套裝組合的 SAP 開始。
segment_alignment boolean

調整組的區隔對齊方式。
representations string

調整組的呈現方式。

SchemeIDURIAndValue

SchemeIDURIAndValue 是架構 ID 及其值的配對。
JSON 表示法
{
  "scheme_id_uri": string,
  "value": string,
}
欄位
scheme_id_uri string

值的配置 ID URI。
value string

架構 ID URI 的值。

圖示

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

包裝容器包含包裝容器廣告的相關資訊。如果沒有交易 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 string

JavaScript 酬載的 URI。
api_framework string

APIFramework 是執行驗證碼的影片架構名稱。
browser_optional boolean

這個指令碼是否可在瀏覽器外執行。

TrackingEvent

TrackingEvent 包含用戶端在特定情況下應 Ping 的網址。
JSON 表示法
{
  "event": string,
  "uri": string,
}
欄位
event string

追蹤事件的類型。
uri string

要 Ping 的追蹤事件。

UniversalAdID

UniversalAdID 可提供廣告素材的專屬 ID，且該 ID 會在各個廣告系統中維持不變。
JSON 表示法
{
  "id_value": string,
  "id_registry": string,
}
欄位
id_value string

所選廣告素材的通用廣告 ID。
id_registry string

這個字串用於識別登錄網站的網址，所選廣告素材的通用廣告 ID 會編目於該網站。

夥伴

隨播廣告包含隨播廣告的資訊，這些廣告可能會與廣告一起顯示。
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 string

VAST 中 <AdParameters> 節點的值。