動態廣告插播 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，建立 HTTP 即時串流動態廣告插播串流。

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 授權標頭中傳遞 API 金鑰：

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

路徑參數

參數
content-source string

串流的 CMS ID。

video-id string

串流的影片 ID。

要求主體

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

參數
dai-ssb 選用

設為 true 即可建立伺服器端信標串流。預設值為 false。預設串流的追蹤是由用戶端啟動，並在伺服器端進行連線偵測 (ping)。
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 會傳回下列回應：

  • 如果媒體驗證成功且所有連線偵測 (ping) 也已送出，則為 HTTP/1.1 204 No Content。
  • 如果要求因網址格式或過期而無法驗證媒體，請HTTP/1.1 404 Not Found。
  • HTTP/1.1 404 Not Found。
  • HTTP/1.1 409 Conflict：如果其他要求目前正在傳送連線偵測 (ping)。

廣告媒體 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

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

串流的資訊清單。對應至 HTTP 即時串流中的主要播放清單和 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

用於啟動驗證碼的不透明字串。

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

追蹤事件類型。
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,
  "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> 節點的值。