YouTube API 服務 - 基本必要功能

注意: 遵守 YouTube 開發人員政策提供了指引和範例,協助您確保 API 用戶端遵守 YouTube API 服務條款政策 (API 服務條款) 的特定部分。這份指南旨在說明 YouTube 如何強制執行 API TOS 的特定部分,但不會取代任何現有文件。

本文件針對實作或提供 YouTube API 服務特定功能 (以下簡稱「API 用戶端」) 的 API 用戶端,制定了基本功能要求。

這些規定和規範可確保 API 用戶端提供一致的使用者體驗,保護 YouTube 使用者、內容擁有者和廣告主的利益。這些規則是《YouTube API 服務條款》中不可或缺的一環,在開發和執行任何 API 用戶端時都必須遵守。

建議您熟悉本文所述的規定,以便我們透過現有的 YouTube 功能提供更優質的使用者體驗。也會隨著 YouTube 新功能和更新而改變。有時您可能需要更新 API 用戶端以符合新的要求。《服務條款》修訂記錄會記錄所有異動內容,因此請經常查看文件或訂閱其 RSS 動態消息,確保您能快速瞭解可能會影響 API 用戶端的變更。

除了本文所述的規定之外,我們也強烈建議您遵循《YouTube API 服務政策》中所述的最佳做法,並在 YouTube API 服務說明文件中的其他段落間討論。即使 API 用戶端並非強制要求,但這些做法仍能協助 API 用戶端更快從錯誤中復原,並在使用會分配配額的 YouTube API 服務時,盡可能提高配額用量。同時,這些做法有助於確保 YouTube 生態系統健康,而整體來說,為您的 API 用戶端和 YouTube 應用程式使用者提供最佳體驗。

YouTube 嵌入式播放器與影片播放

本節規定僅適用於嵌入式 YouTube 播放器。「YouTube API 服務政策」還包含多項與播放 YouTube 影音內容的 API 用戶端相關的政策。

嵌入式 YouTube 播放器大小

內嵌播放器的可視區域必須至少為 200 x 200 像素。如果播放器顯示控制項,必須夠大到足以完整顯示控制項,且不會將可視區域縮小到低於下限。我們建議 16:9 的播放器寬度至少為 480 像素,高度至少 270 像素。

自動播放和有指令碼的播放

本節說明自動播放的內容。這項政策適用於使用 autoplay 播放器參數,或透過 YouTube IFrame Player API 服務、YouTube Android Player API 服務或其他 YouTube API 服務,以程式輔助方式啟動自動播放的 YouTube 嵌入式播放器。

  • 會在網頁載入時或嵌入播放器完全完整顯示後,自動播放影片的內嵌播放器應立即開始播放。不過,如果播放器可以顯示播放器,且播放器有超過半數顯示在網頁或畫面上,API 用戶端都不得啟動自動播放。

  • 網頁或畫面最多只能有一個 YouTube 播放器可同時自動播放內容。

  • 任何可播放的 YouTube 縮圖都必須寬度至少為 120 像素,高度至少 70 像素。

YouTube 播放器屬性

YouTube API 文件和規格 (https://developers.google.com/youtube) 列有 YouTube 播放器的屬性和參數,包括播放器在播放器中呈現的樣貌。您不得變更 API 說明文件未明確描述的 YouTube 播放器。

重疊與頁框

在 YouTube 嵌入式播放器中的任何位置 (包括播放器控制項),不得在前方顯示重疊廣告、頁框或其他視覺元素。同樣地,也不得使用重疊、頁框或其他視覺元素來遮蓋嵌入式播放器的任何部分 (包括播放器控制項)。

滑鼠指向次數

您不得在 YouTube 播放器中,利用滑鼠遊標懸停或觸控事件代表使用者執行任何動作,例如開啟視窗或訂閱頻道。

上傳影片

如果 API 用戶端允許使用者將內容上傳至多個平台,使用者應該就能選取和取消選取要上傳影片的平台。

資料條件

讓使用者將影片上傳到 YouTube 的 API 用戶端,必須讓 users 設定下列清單的值。未列出的任何屬性都是選用屬性。

  名稱 說明
資源屬性
snippet.title 必填。影片的標題。如果值超過 100 個半形字元,YouTube 就會傳回錯誤。YouTube 支援所有有效的 UTF-8 字元 (<> 除外)。

snippet.description 必填。影片的說明。如果值超過 5000 個位元組,YouTube 會傳回錯誤。YouTube 支援所有有效的 UTF-8 字元 (<> 除外)。
status.privacyStatus 必填。影片的隱私設定。使用者必須能夠選擇要將上傳的影片設為公開、私人或不公開。
要求參數
onBehalfOfContentOwnerChannel 必要 (有條件)。如果要求的授權憑證已設定內容擁有者,且已設定 onBehalfOfContentOwner 參數,API 使用者也必須能夠指定上傳影片的 YouTube 頻道。

顯示註解

  名稱 說明
資源屬性
snippet.textDisplay 必填。留言的文字。API 用戶端必須 (a) 顯示留言或留言回覆的全文,或者 (b) 截斷文字,並讓檢視者從截斷的版本輕鬆存取完整文字。

無論留言與何種資源 (影片、頻道等) 相關聯,這項規定適用於所有留言和留言回覆。

請注意,commentThread 資源的 snippet.topLevelComment 屬性值為 comment 資源,replies.comments[] 屬性值為一項資源。comment因此,這項規定也適用於 snippet.topLevelComment.snippet.textDisplayreplies.comments[].snippet.textDisplay 屬性。
snippet.title
(channel)
必填 (建議):頻道標題。
  • 如果留言與頻道有關,API 用戶端必須顯示管道的名稱。
  • 如果是與影片相關的留言,API 用戶端必須顯示上傳影片的頻道名稱。
snippet.title
(video)
必要 (建議):影片的標題。如果留言與影片相關,則必須顯示這個值。
snippet.moderationStatus 必要 (有條件)。如果 API 要求中的 moderationStatus 參數值是 heldForReviewlikelySpam,螢幕必須利用屬性值、類似語言 (例如「這則留言待審)、標題 (例如「待審核」) 或其他不明確的語言,明確識別狀態。commentThreads.list 方法支援根據留言的審核狀態擷取留言。

新增註解

  名稱 說明
資源屬性
snippet.title
(channel)
必填。頻道標題。
  • 如果使用者新增關於頻道的評論,API 用戶端必須顯示頻道的名稱。
  • 如果使用者要評論影片,API 用戶端必須顯示上傳影片的頻道名稱。
snippet.title
(video)
必填。如果使用者新增影片評論,API 用戶端必須顯示影片標題。
其他規定
Comment author's channel name 必填。API 用戶端必須明確指出留言所屬的 YouTube 使用者帳戶。如果要求的授權憑證已設定內容擁有者,且已設定 onBehalfOfContentOwner 參數,API 使用者也必須能夠指定留言所屬的 YouTube 頻道。

正在新增回覆留言

  名稱 說明
資源屬性
snippet.textDisplay 必填。留言的文字。API 用戶端必須根據本文件「顯示註解」一節中定義的規則,顯示使用者回覆的註解文字。
snippet.title
(channel)
必填。頻道標題。
  • 如果使用者回覆的頻道評論內容,API 用戶端必須顯示管道名稱。
  • 如果使用者回應了某部影片的評論,API 用戶端必須顯示上傳影片的頻道名稱。
snippet.title
(video)
必填。如果使用者要回覆影片評論,API 用戶端必須顯示影片標題。
其他規定
Comment author's channel name 必填。API 用戶端必須明確指出留言回覆將屬於哪個 YouTube 使用者帳戶。如果要求的授權憑證已設定內容擁有者,且已設定 onBehalfOfContentOwner 參數,API 使用者也必須能夠指定留言回覆將屬於哪個 YouTube 頻道。

編輯或刪除留言回覆

  名稱 說明
資源屬性
snippet.textDisplay 必填。留言的文字。API 用戶端必須根據本文件「顯示註解」一節所定義的規則,顯示使用者正在編輯或刪除的註解文字。
snippet.title
(channel)
必填。頻道標題。
  • 如果使用者正在修改或刪除頻道留言,API 用戶端必須顯示管道的名稱。
  • 如果使用者正在編輯或刪除影片評論,API 用戶端必須顯示上傳影片的頻道名稱。
snippet.title
(video)
必填。如果使用者正在編輯或刪除影片評論,API 用戶端必須顯示影片標題。
其他規定
Comment author's channel name 必填。API 用戶端必須明確指出留言所屬的 YouTube 使用者帳戶。

將聊天室中的使用者停權 (或移除停權)

  名稱 說明
資源屬性
snippet.title
(channel)
必填。遭禁或解除停權的 YouTube 頻道名稱。此外,您也必須顯示頻道名稱連結或頻道網址。
其他規定
留言作者的頻道名稱 必填。API 用戶端必須明確指明用來新增或移除停權的 YouTube 使用者帳戶。