VOD 串流可略過廣告

本指南說明如何使用 DAI API 來請求包含可略過廣告的 VOD 串流、根據 Google Ads 規定顯示略過按鈕,以及傳送相關的追蹤事件。

先備知識

請求可略過的廣告

如要請求內含可略過廣告的 VOD 串流,必須在串流請求中傳遞 dai-sas 參數。

API 端點

POST: /ondemand/v1/hls/content/{CMS_ID}/vid/{VIDEO_ID}/stream
Host: dai.google.com
Content-Type: application/x-www-form-urlencoded

路徑參數

{CMS_ID} 串流的 CMS ID。
{VIDEO_ID} 串流的影片 ID。

內文參數

dai-sas 設定 dai-sas=1 即可啟用可略過的廣告。

要求範例 (cURL)

針對 HTTP 即時串流要求:

curl -X POST \
     -d 'dai-sas=1' \
     -H 'Content-Type: application/x-www-form-urlencoded' \
https://dai.google.com/ondemand/v1/hls/content/{CMS_ID}/vid/{VIDEO_ID}/stream

將 DASH 串流的網址替換成 'dash'

https://dai.google.com/ondemand/v1/dash/content/{CMS_ID}/vid/{VIDEO_ID}/stream

請使用以下格式,在要求主體中加入多個串流參數:

-d 'dai-sas=1&cust_params=key1%3dvalue1%26key2%3dvalue2' \

處理略過廣告

如要處理略過廣告,請根據您要略過目前廣告或整個廣告插播時間點,使用 Ad 結構或 AdBreak 結構中的資訊。擷取 start 值並新增 duration 值,然後前往串流中的該點。SkipMetadata 子訊息也包含 offset 值,這是使用者略過廣告前的幾秒鐘值。只有可略過的廣告包含 SkipMetadata 子訊息。

ad_breaks 廣告插播時間點清單。
start (number) 廣告插播在串流中的位置 (以秒為單位)。
duration (number) 廣告插播的時間長度,以秒為單位。
ads (object(Ad)) 串流中的廣告清單。
start (number) 廣告開始在串流中的位置 (以秒為單位)。
duration (number) 廣告的時間長度,以秒為單位。
skip_metadata (object(SkipMetadata)) 可略過廣告的選用中繼資料。設定後,表示廣告可略過,並包含處理略過 UI 和追蹤事件的操作說明。
offset (number) 偏移值表示播放器顯示略過按鈕之前,廣告應等待的秒數。如果 VAST 中未提供此值則省略。
tracking_url (字串) 應在略過事件上連線偵測的網址。

回應範例

{
  ...
  "ad_breaks":[
    {
      ...
      "start":0,
      "duration":10,
      "ads":[
        {
          ...
          "start":0,
          "duration":10,
          "skip_metadata":{
            "offset": 5,
            "tracking_url": "https://example_skip_url.com"
          }
        }
    }
}

廣告略過後,系統會對串流回應中包含的略過事件網址進行連線偵測 (ping)。 包含在 SkipMetadata 子訊息中。

略過按鈕需求

如果是可略過的廣告,請使用下列設計規定轉譯略過按鈕。如未遵守這些規定,可能會導致您網站或應用程式放送的 Google 廣告受到限制。

倒數計時器

在 VAST 中指定的 skipoffset 時間之前,廣告不得可略過。在不可略過的期間內,您必須向使用者顯示通知,告知使用者可以在 X 秒內略過廣告。通知必須翻譯成使用者的語言。

略過按鈕位置

如果是由左至右的語言,請將略過按鈕放在影片播放器的右下方。如果是由右至左的語言,請將略過按鈕放在影片播放器左下方。

略過按鈕大小

按鈕和文字的大小必須夠大,才能在提供輕鬆的使用者體驗中清楚顯示。

文字和圖示

略過按鈕必須同時包含文字和圖像。您可以使用略過下一個質感設計圖示做為圖像圖像。

無障礙功能

使用者應可以使用鍵盤或遙控器前往略過按鈕。倒數計時完畢後,應用程式應將焦點移至略過按鈕。

國際化

建議您將略過文字翻譯成使用者的語言。

廣告連播

略過按鈕可用來略過廣告連播中的目前廣告,或是略過整個廣告連播。

「略過廣告」翻譯

請使用 skipAdTranslations.json 檔案,根據使用者的語言代碼翻譯「略過廣告」文字。