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

動態廣告插播 API 可讓您要求及追蹤 DAI 直播。

服務：dai.google.com

所有 URI 均為 https://dai.google.com 的相對路徑。

方法：stream

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

註冊 DAI 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。詳情請參閱 互動廣告局科技實驗室和 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。系統會從 1 開始，逐漸為每個廣告插播事件指派廣告插播 ID。

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 必要2 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;

用於擷取廣告連播的 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。系統會從 1 開始，逐漸為每個廣告插播事件指派廣告插播 ID。

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

用於擷取廣告連播的 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。系統會從 1 開始，逐漸為每個廣告插播事件指派廣告插播 ID。

查詢參數

參數
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 廣告群週期範本

方法
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 端點。

回應主體

如果成功，回應主體會包含新的 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 的建構方式與基本Pod 服務工作流程的 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 後，請立即使用上述串流端點取得的 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_url 中的中繼資料端點會傳回用於建構廣告 UI 的資訊。中繼資料端點不適用於伺服器端信標串流，因為在這種情況下，伺服器負責啟動廣告媒體驗證。

方法
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 物件建立索引。

回應資料

串流

串流用於以 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 包含廣告、廣告破口和事件類型的參照。請勿將 type="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

有效的插播類型為：前、中、後。
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 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)]

廣告 Pod 的 DASH 轉譯組清單，用於在 DASH 資訊清單中算繪。

AdRendering

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

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

Variant 物件字典 (請參閱下文)，根據從使用者介面設定的變化版本/設定檔 ID 編入索引。

SlateRendering

SlateRendering 說明如何轉譯標題卡內容。
JSON 表示法
{
  "duration_ms": number,
  "variants": map[string, object(VariantRendering)],
}
欄位
duration_ms number

字幕的時間長度 (以毫秒為單位) (int)。
variants map[string, object(VariantRendering)]

Variant 物件字典，以變化版本/設定檔 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

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

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

DASHRepresentation

DASHRepresentation 會說明要在 DASH 資訊清單中轉譯的表示層節點。
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 的值。

圖示

圖示包含 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 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。
JSON 表示法
{
  "id_value": string,
  "id_registry": string,
}
欄位
id_value string

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

用於識別註冊網站的網址，該網站收錄所選廣告素材的 Universal Ad 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> 節點值。