REST Resource: videoAdvertisingOptions

資源：VideoAdvertisingOption

影片的廣告設定。這些設定可指出影片播放期間可放送的廣告類型，以及允許在影片中放送廣告的時間。

JSON 表示法 
{
  "kind": string,
  "adFormats": [
    string
  ],
  "breakPosition": [
    string
  ],
  "adBreaks": [
    {
      object (AdBreak)
    }
  ],
  "autoGeneratedBreaks": boolean,
  "id": string,
  "tpAdServerVideoId": string,
  "tpTargetingUrl": string,
  "tpUrlParameters": string
}
欄位
kind

string

API 資源的類型。對於這項資源，值為 youtubePartner#videoAdvertisingOption。
adFormats[]

string

影片可顯示的廣告格式清單。注意：自 2023 年 11 月起，這個資料欄只能啟用/停用 thirdParty。詳情請參閱支援文章。下列廣告格式控制項已不再提供，因此不應納入 API 要求：instream_standard、display、preroll、postroll。
breakPosition[]

string

影片播放期間出現插播點的時間點。
adBreaks[]

object (AdBreak)

列出 YouTube 可在影片播放期間放送串流內廣告的時間點。
autoGeneratedBreaks

boolean

為這部影片啟用自動產生的片中廣告插播時間點。如果在已定義廣告插播時間點的影片中，將 autoGeneratedBreaks 設為 true，系統除了手動廣告版位，也會找出適合放送廣告的位置。
id

string

YouTube 會使用這個 ID 識別與廣告設定相關聯的影片。
tpAdServerVideoId

string

這個值可用來指定影片的專屬辨識值，以供第三方廣告伺服器識別之用。
tpTargetingUrl

string

第三方廣告伺服器的基本網址，YouTube 可從中擷取影片的串流內廣告。
tpUrlParameters

string

參數字串，用於附加至第三方廣告伺服器的請求結尾。

AdBreak

adBreak 資源包含 YouTube 在影片播放期間可顯示串流內廣告的時間點資訊。

JSON 表示法 
{
  "position": string,
  "midrollSeconds": integer
}
欄位
position

string

影片播放期間出現插播點的時間點。
midrollSeconds

integer

廣告插播時間，以影片開始播放後的秒數表示。

方法

get

 擷取指定影片的廣告設定。

getEnabledAds

 擷取指定合作夥伴或使用者上傳影片的允許廣告類型詳細資料。

patch

 修補指定影片的廣告設定。

update

 更新指定影片的廣告設定。