注意: 遵守 YouTube 開發人員政策提供指引和範例,協助您確保 API 用戶端遵守 YouTube API 服務條款和政策 (API 服務條款) 的特定部分。本指南可讓您瞭解 YouTube 如何執行 API 使用條款的特定部分,但不會取代任何現有文件。
本文為 API 用戶端定義最低功能需求,這些用戶端會實作或提供 YouTube API 服務的特定功能存取權 (稱為「API 用戶端」)。
這些規範和指南可確保 API 用戶端提供一致的使用者體驗,保護 YouTube 使用者、內容擁有者和廣告主的權益。這些規則是《YouTube API 服務條款》的重要組成部分,開發人員在開發及實作任何 API 用戶端時,都必須遵守這些規則。
請注意,本文件中的規定可能會有所變動,以確保使用者能享有更優質的 YouTube 體驗。也會隨著 YouTube 新功能和更新內容而變動。有時,您可能需要更新 API 用戶端,以符合新規定。服務條款修訂版本記錄會記錄所有異動,因此請經常查看該文件,或訂閱其 RSS 動態饋給,以便快速瞭解可能影響 API 用戶端的異動。
除了本文件中的規定外,我們強烈建議您遵循《YouTube API 服務政策》和 YouTube 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 API 服務,自動啟動播放的 YouTube 嵌入式播放器。
-
自動播放影片的嵌入式播放器應在網頁載入時或嵌入式播放器完全顯示時立即開始播放。不過,API 用戶端必須等到播放器可見,且頁面或螢幕上有超過一半的播放器可見,才能啟動自動播放功能。
-
一個網頁或畫面不得同時播放多個自動播放的 YouTube 影片。
-
任何可啟動播放的 YouTube 縮圖,寬度至少須為 120 像素,高度至少須為 70 像素。
YouTube 播放器屬性
YouTube 播放器的屬性和參數 (例如播放器中 YouTube 品牌的顯示方式) 已在 YouTube API 說明文件和規格 (https://developers.google.com/youtube) 中指定。請勿對 YouTube 播放器做出 API 說明文件未明確說明的變更。
疊加層和框架
請勿在 YouTube 嵌入式播放器的任何部分 (包括播放器控制項) 前方顯示疊加層、邊框或其他視覺元素。同樣地,您不得使用疊加層、邊框或其他視覺元素遮蓋內嵌播放器的任何部分,包括播放器控制項。
滑鼠指向次數
請勿在 YouTube 播放器上使用滑鼠懸停或觸控事件,代表使用者啟動任何動作,例如開啟視窗或訂閱頻道。
上傳影片
如果 API 用戶端允許使用者將內容上傳至多個平台,使用者應可選取及取消選取要上傳影片的平台。
資料條件
允許使用者上傳影片至 YouTube 的 API 用戶端必須讓使用者設定下列清單中的值。未列出的屬性皆為選用屬性。
名稱 | 說明 | |
---|---|---|
資源屬性 | ||
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.textDisplay 和 replies.comments[].snippet.textDisplay 屬性。 |
|
snippet.title ( channel ) |
必要 (建議)。頻道名稱。
|
|
snippet.title ( video ) |
必要 (有條件) (建議)。影片的標題。如果留言與影片相關,就必須顯示這個值。 | |
snippet.moderationStatus |
必要 (有條件)。如果 API 要求中的 moderationStatus 參數值為 heldForReview 或 likelySpam ,則顯示畫面必須使用屬性值、類似的文字 (例如「This comment is being held for review」)、標題 (例如「Held for review」) 或其他不含歧義的文字,清楚標示該狀態。commentThreads.list 方法可讓您根據留言的管理狀態擷取留言。 |
新增註解
名稱 | 說明 | |
---|---|---|
資源屬性 | ||
snippet.title ( channel ) |
必填。頻道名稱。
|
|
snippet.title ( video ) |
必填。如果使用者要為影片新增留言,API 用戶端必須顯示影片標題。 | |
其他規定 | ||
Comment author's channel name |
必填。API 用戶端必須明確指出留言的歸屬 YouTube 使用者帳戶。如果要求的授權憑證可識別內容擁有者,且已設定 onBehalfOfContentOwner 參數,API 使用者也必須能夠指定留言的 YouTube 頻道。 |
新增留言回覆
名稱 | 說明 | |
---|---|---|
資源屬性 | ||
snippet.textDisplay |
必填。留言的文字。API 用戶端必須依照本文件「顯示評論」一節所定義的規則,顯示使用者要回覆的評論文字。 | |
snippet.title ( channel ) |
必填。頻道名稱。
|
|
snippet.title ( video ) |
必填。如果使用者回覆影片留言,API 用戶端必須顯示影片標題。 | |
其他規定 | ||
Comment author's channel name |
必填。API 用戶端必須明確指出留言回覆的 YouTube 使用者帳戶。如果要求的授權憑證可識別內容擁有者,且已設定 onBehalfOfContentOwner 參數,API 使用者也必須能夠指定留言回覆的 YouTube 頻道。 |
編輯或刪除留言回覆
名稱 | 說明 | |
---|---|---|
資源屬性 | ||
snippet.textDisplay |
必填。留言的文字。API 用戶端必須根據本文件「顯示註解」一節中定義的規則,顯示使用者正在編輯或刪除的註解文字。 | |
snippet.title ( channel ) |
必填。頻道名稱。
|
|
snippet.title ( video ) |
必填。如果使用者要編輯或刪除影片留言,API 用戶端必須顯示影片標題。 | |
其他規定 | ||
Comment author's channel name |
必填。API 用戶端必須明確指出留言的 YouTube 使用者帳戶。 |
將使用者從聊天室中停權 (或解除停權)
名稱 | 說明 | |
---|---|---|
資源屬性 | ||
snippet.title ( channel ) |
必填。遭到停權或解除停權的 YouTube 頻道名稱。此外,名稱必須連結至頻道,或同時顯示頻道網址。 | |
其他規定 | ||
留言作者的頻道名稱 | 必填。API 用戶端必須明確指出用來新增或移除封鎖的 YouTube 使用者帳戶。 |