動態廣告插播 API

動態廣告插播 API 可讓您請求及追蹤 DAI 線性 (LIVE) 串流。

服務:dai.google.com

以下皆為與 https://dai.google.com 相對的 URI

方法:串流

方法
stream POST /linear/v1/hls/event/{assetKey}/stream

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

HTTP 要求

POST https://dai.google.com/linear/v1/hls/event/{assetKey}/stream

要求標頭

參數
api‑key string

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

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

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

路徑參數

參數
assetKey string

串流的活動 ID。
注意:串流素材資源金鑰是可在 Ad Manager UI 中找到的 ID。

要求主體

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

參數
dai-ssb 選用

設為 true 即可建立伺服器端信標串流。預設值為 false。預設串流的追蹤是用戶端啟動,並在伺服器端連線偵測。

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

回應主體

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

Open Measurement

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

方法:媒體驗證

在播放期間遇到廣告媒體 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 的先前驗證要求成功。
  • 如果目前有其他要求正在傳送連線偵測 (ping),則為 HTTP/1.1 409 Conflict

廣告媒體 ID (HLS)

廣告媒體 ID 將使用 TXXX 鍵編碼為 HLS 時間中繼資料,這個鍵保留供「使用者定義的文字資訊」頁框使用。影格內容一律會未加密,而且一律以 "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 的執行個體。

使用中繼資料

中繼資料有三個獨立部分:tagsads 和廣告 breaks。資料的進入點為 tags 區段。然後反覆查看代碼,找出第一個項目名稱是影片串流中廣告媒體 ID 前置字元的項目。舉例來說,假設您設定的廣告媒體 ID 如下:

google_1234567890

然後,您找到名為 google_12345 的標記物件。在這種情況下,它會與廣告媒體 ID 相符。找到正確的廣告媒體前置字元物件後,可以查詢廣告 ID、廣告插播 ID 和事件類型。接著,廣告 ID 會用於為 ads 物件建立索引,廣告插播 ID 則用於為 breaks 物件建立索引。

回應資料

直播

串流可用來為新建立的串流轉譯資源清單 (採用 JSON 格式)。
JSON 表示法
{
  "stream_id": string,
  "stream_manifest": string,
  "hls_master_playlist": string,
  "media_verification_url": string,
  "metadata_url": string,
  "session_update_url": string,
  "polling_frequency": number,
}
欄位
stream_id string

串流 ID
stream_manifest string

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

(已淘汰) HLS 主要播放清單網址。請改用「stream_manifest」。
media_verification_url string

媒體驗證網址。
metadata_url string

廣告媒體中繼資料網址。
session_update_url string

工作階段更新網址。
polling_frequency number

建議的中繼資料網址輪詢頻率 (以秒為單位)。

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

代碼區隔包含廣告、廣告插播和事件類型的參照。不應呼叫含有 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

廣告插播中的廣告數量。
廣告描述串流中的廣告。
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),

圖示

圖示包含 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> 節點的值