動態廣告插播 VOD API

動態廣告插播 API 可讓您請求及追蹤 DAI 隨選影片 (VOD) 串流。系統支援 HLS 和 DASH 串流。

服務：dai.google.com

stream 方法的路徑與 https://dai.google.com 相關

方法：串流

方法
stream POST /ondemand/v1/hls/content/{content-source}/vid/{video-id}/stream

為特定的內容來源和影片 ID 建立 HLS 動態廣告插播串流。

POST /ondemand/v1/dash/content/{content-source}/vid/{video-id}/stream

為特定內容來源和影片 ID 建立 DASH DAI 串流。

HTTP 要求

POST https://dai.google.com/ondemand/v1/hls/content/{content-source}/vid/{video-id}/stream

POST https://dai.google.com/ondemand/v1/dash/content/{content-source}/vid/{video-id}/stream

要求標頭

參數
api‑key string

建立串流時提供的 API 金鑰，必須對發布商的聯播網有效。

API 金鑰不需在要求主體中提供，但可以透過以下格式透過 HTTP 授權標頭傳入：

Authorization: DCLKDAI key="<api-key>"

路徑參數

參數
content-source string

串流的 CMS ID。

video-id string

串流的影片 ID。

要求主體

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

參數
dai-ssb 選用

設為 true 即可建立伺服器端信標串流。預設值為 false。預設串流的追蹤是用戶端啟動，並在伺服器端連線偵測。
DFP 指定目標參數 選用 其他指定目標參數。
覆寫串流參數 選用 覆寫串流建立參數的預設值。
HMAC 驗證 選用 使用 HMAC 權杖進行驗證。

回應主體

如果成功，回應主體會包含新的 Stream。對於伺服器端信標串流，此 Stream 僅包含 stream_id 和 stream_manifest 欄位。

Open Measurement

Verifications 欄位包含非伺服器端信標串流的 OpenMeasurement 驗證資訊。Verifications 包含一或多個 Verification 元素，會列出使用第三方評估程式碼驗證廣告素材播放時所需的資源和中繼資料。系統僅支援 JavaScriptResource。詳情請參閱 IAB Tech Lab 和 VAST 4.1 規格。

方法：媒體驗證

如果在播放期間遇到廣告媒體 ID，請立即使用 stream 端點的 media_verification_url 發出要求。media_verification_url 是絕對路徑。伺服器端信標串流不需要媒體驗證要求，因為伺服器會啟動媒體驗證。

向 media verification 端點發出的要求是冪等的。

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

通知媒體驗證事件的 API。

HTTP 要求

GET {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 的先前驗證要求成功。
  • 如果目前有其他要求正在傳送連線偵測 (ping)，則為 HTTP/1.1 409 Conflict。

廣告媒體 ID (HLS)

廣告媒體 ID 將使用 TXXX 鍵 (針對「使用者定義的文字資訊」頁框保留) 以 HLS 時間中繼資料編碼。頁框內容不會加密，且一律會以 "google_" 文字開頭。

針對每個廣告驗證要求，頁框的完整文字內容應附加到 media_verification_url 中。

廣告媒體 ID (DASH)

系統會使用 DASH 的 EventStream 元素，在資訊清單中插入廣告媒體 ID。

每個 EventStream 都有 urn:google:dai:2018 的配置 ID URI。且包含 messageData 屬性且包含開頭為 “google_” 的廣告媒體 ID 的事件。針對每個廣告驗證要求，請將 messageData 屬性的完整內容附加至 media_verification_url。

回應資料

直播

串流可用來算繪新建串流 (JSON 格式) 的所有資源清單。
JSON 表示法
{
  "stream_id": string,
  "total_duration": number,
  "content_duration": number,
  "valid_for": string,
  "valid_until": string,
  "subtitles": [object(Subtitle)],
  "hls_master_playlist": string,
  "stream_manifest": string,
  "media_verification_url": string,
  "apple_tv": object(AppleTV),
  "ad_breaks": [object(AdBreak)],
}
欄位
stream_id string

串流 ID。
total_duration number

串流持續時間，單位為秒。
content_duration number

內容長度，以秒為單位。
valid_for string

時間長度串流有效，格式為「00h00m00s」。
valid_until string

串流有效期限，採用 RFC 3339 格式。
subtitles [object(Subtitle)]

字幕清單。如果留空，則會省略。僅限 HTTP 即時串流。
hls_master_playlist string

(已淘汰) HLS 主要播放清單網址。使用 Stream_manifest。僅限 HTTP 即時串流。
stream_manifest string

串流的資訊清單。對應於 HLS 中的主要播放清單和 DASH 中的 MPD。建立伺服器端信標串流時，回應中是「stream_id」之外的唯一欄位。
media_verification_url string

媒體驗證網址。
apple_tv object(AppleTV)

AppleTV 裝置專屬選用資訊。僅限 HTTP 即時串流。
ad_breaks [object(AdBreak)]

廣告插播清單。如果留空，則會省略。

AppleTV

AppleTV 內含 Apple TV 裝置的專屬資訊。
JSON 表示法
{
  "interstitials_url": string,
}
欄位
interstitials_url string

插頁式廣告網址。

AdBreak

AdBreak 描述串流中的單一廣告插播。其中包含位置、時間長度、類型 (中間/前後) 和廣告清單。
JSON 表示法
{
  "type": string,
  "start": number,
  "duration": number,
  "ads": [object(Ad)],
}
欄位
type string

有效的廣告插播類型包括：中、前和後。
start number

在串流中開始分行的位置 (以秒為單位)。
duration number

廣告插播的時間長度，以秒為單位。
ads [object(Ad)]

廣告清單。如果留空，則會省略。
廣告描述串流中的廣告。當中包含廣告插播的位置、廣告時間長度和一些選用的中繼資料。
JSON 表示法
{
  "seq": number,
  "start": 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,
  "icons": [object(Icon)],
  "wrappers": [object(Wrapper)],
  "events": [object(Event)],
  "verifications": [object(Verification)],
  "universal_ad_id": object(UniversalAdID),
  "companions": [object(Companion)],
  "interactive_file": object(InteractiveFile),
}
欄位
seq number

廣告在廣告插播中的位置。
start number

廣告開始在串流中的位置，以秒為單位。
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

選填的到達網址。
icons [object(Icon)]

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

包裝函式清單。如果留空，則會省略。
events [object(Event)]

廣告中的事件清單。
verifications [object(Verification)]

選用的 Open Measurement 驗證項目，會列出執行第三方評估程式碼以驗證廣告素材播放所需的資源和中繼資料。
universal_ad_id object(UniversalAdID)

選填的通用廣告 ID。
companions [object(Companion)]

可與這則廣告一併顯示的選用隨播廣告素材。
interactive_file object(InteractiveFile)

廣告播放期間應顯示的互動式廣告素材 (SIMID)，

活動

活動包含活動類型和活動顯示時間。
JSON 表示法
{
  "time": number,
  "type": string,
}
欄位
time number

這個活動的簡報時間。
type string

這個事件的類型。

副標題

字幕說明影片串流的補充資訊字幕軌。它會儲存兩種字幕格式：TTML 和 WebVTT。TTMLPath 屬性包含 TTML 補充資訊檔案的網址，而 WebVTTPath 屬性同樣包含 WebVTT 補充資訊檔案的網址。
JSON 表示法
{
  "language": string,
  "language_name": string,
  "ttml": string,
  "webvtt": string,
}
欄位
language string

語言代碼，例如「en」或「de」。
language_name string

語言的描述性名稱。如果同一個語言有多個組合，它可識別特定的字幕組合。
ttml string

TTML 補充資訊檔案的選用網址。
webvtt string

WebVTT 補充資訊檔案的選用網址。

圖示

圖示包含 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

傳送至 Bootstrap 驗證碼的不透明字串。

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 包含在特定情況下，應由用戶端呼叫的網址。
JSON 表示法
{
  "event": string,
  "uri": string,
}
欄位
event string

追蹤事件的類型，目前唯一隻能採用 VAST 4.1 規格中的「verificationNotExecuted」選項。
uri string

要連線偵測的追蹤事件。

UniversalAdID

UniversalAdID 是用來提供在廣告系統中維護的專屬廣告素材 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,
}
欄位
click_data object(ClickData)

這個隨播廣告的點擊資料。
creative_type string

如果這是靜態類型的隨播廣告，則 VAST 中 <StaticResource> 節點上的 CreativeType 屬性。
height int32

這個隨播廣告的高度 (以像素為單位)。
width int32

這個隨播廣告的寬度 (以像素為單位)。
resource string

如果是靜態和 iframe 隨播廣告，這會是要載入及顯示的網址。如果是 HTML 隨播廣告，這個 HTML 程式碼片段應以隨播廣告的形式顯示。
type string

這個隨播廣告素材的類型。可以是靜態值、iframe 或 HTML。

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> 節點的值。