Method: videoAdvertisingOptions.getEnabledAds

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

HTTP 要求

GET https://youtubepartner.googleapis.com/youtube/partner/v1/videoAdvertisingOptions/{videoId}/getEnabledAds

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
videoId

string

videoId 參數會指定要擷取廣告選項的影片 YouTube 影片 ID。

查詢參數

參數
onBehalfOfContentOwner

string

onBehalfOfContentOwner 參數會指出使用者所代表的內容擁有者。這個參數支援帳戶與多個內容擁有者相關聯的使用者。

要求主體

要求主體必須為空白。

回應主體

這個資源會指出已聲明版權的 YouTube 影片廣告設定。這項資訊會標示影片、影片播放期間可放送廣告的時間、可放送廣告的國家/地區，以及這些國家/地區允許的廣告類型。也能指出影片在嵌入式播放器中播放時，是否可以放送廣告。

如果成功，回應主體會含有以下結構的資料：

JSON 表示法 
{
  "kind": string,
  "countriesRestriction": [
    {
      object (CountriesRestriction)
    }
  ],
  "adBreaks": [
    {
      object (AdBreak)
    }
  ],
  "adsOnEmbeds": boolean,
  "id": string
}
欄位
kind

string

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

object (CountriesRestriction)

這份名單會列出可放送廣告的國家/地區，以及這些國家/地區允許的廣告類型。
adBreaks[]

object (AdBreak)

在已聲明擁有權的 YouTube 影片中出現的廣告插播時間點清單。
adsOnEmbeds

boolean

這個欄位會指出 YouTube 是否可以在嵌入式播放器中播放影片時放送廣告。
id

string

YouTube 用來識別聲明版權的影片的 ID。

授權範圍

需要下列 OAuth 範圍：

  • https://www.googleapis.com/auth/youtubepartner

詳情請參閱 OAuth 2.0 Overview。

CountriesRestriction

根據套用政策，在特定國家/地區啟用的格式。

JSON 表示法 
{
  "adFormats": [
    string
  ],
  "territories": [
    string
  ]
}
欄位
adFormats[]

string

可在指定國家/地區使用的廣告格式清單。
territories[]

string

ISO 3166-1 alpha-2 國家/地區代碼清單，用於識別啟用廣告的國家/地區。