在 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)

針對 HLS 串流要求:

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 (數字) 廣告插播開始的串流位置 (以秒為單位)。
duration (數字) 廣告插播長度 (以秒為單位)。
ads (object(Ad)) 串流中的廣告清單。
start (數字) 廣告開始播放的串流位置 (以秒為單位)。
duration (數字) 廣告的時間長度,以秒為單位。
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 秒後略過廣告。通知必須翻譯成使用者的語言。

略過按鈕位置

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

略過按鈕大小

按鈕和文字必須夠大,才能在輕鬆躺臥體驗中清楚辨識。

文字和圖示

跳過按鈕必須同時顯示文字和圖示。您可以使用略過下一個 Material Design 圖示做為圖示。

無障礙設定

使用者應能使用鍵盤或遙控器前往跳過按鈕。倒數計時結束後,應用程式應將焦點放在略過按鈕上。

國際化

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

廣告連播

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

「略過廣告」的翻譯

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