Playlists: update

修改播放清單。舉例來說,你可以變更播放清單的標題、說明或隱私權狀態。

配額影響:呼叫此方法的配額費用為 50 個單位。

常見用途

要求

HTTP 要求

PUT https://www.googleapis.com/youtube/v3/playlists

授權

這項要求需要至少具備下列其中一個範圍的授權。如要進一步瞭解驗證和授權,請參閱「實作 OAuth 2.0 授權」。

範圍
https://www.googleapis.com/auth/youtubepartner
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

參數

下表列出這項查詢支援的參數。列出的所有參數都是查詢參數。

參數
必要參數
part string
part 參數在這項作業中具有兩個用途。它會指出寫入作業會設定的屬性,以及 API 回應會納入的屬性。

請注意,這個方法會覆寫可變更屬性現有值,這些屬性包含在要求主體指定的任何部分中。舉例來說,播放清單的說明包含在 snippet 部分,而該部分必須包含在要求主體中。如果要求未指定 snippet.description 屬性的值,系統會刪除播放清單的現有說明。

以下清單列出可納入參數值的 part 名稱:
  • contentDetails
  • id
  • localizations
  • player
  • snippet
  • status
選用參數
onBehalfOfContentOwner string
這個參數只能用於適當的授權要求

注意:這個參數僅供 YouTube 內容合作夥伴使用。

onBehalfOfContentOwner 參數表示要求的授權憑證可識別 YouTube CMS 使用者,該使用者會代表參數值中指定的內容擁有者行事。這個參數適用於擁有及管理多個 YouTube 頻道的 YouTube 內容合作夥伴。這項功能可讓內容擁有者驗證一次,即可存取所有影片和頻道資料,不必為每個頻道提供驗證憑證。使用者驗證的 CMS 帳戶必須連結至指定的 YouTube 內容擁有者。

要求主體

請在要求主體中提供 playlist 資源。

針對該資源:
  • 您必須為下列屬性指定值:

    • id
    • snippet.title
  • 您可以為這些屬性設定值:

    • snippet.title
    • snippet.description
    • status.privacyStatus
    • status.podcastStatus
    • snippet.defaultLanguage
    • localizations.(key)
    • localizations.(key).title
    • localizations.(key).description

    如果您提交更新要求,但未為已設有值的屬性指定值,系統會刪除該屬性現有的值。

回應

如果成功的話,這個方法會在回應內文中傳回 playlist 資源。

錯誤

下表列出 API 在回應對此方法的呼叫時可能傳回的錯誤訊息。詳情請參閱「YouTube Data API - 錯誤」。

錯誤類型 錯誤詳細資料 說明
badRequest (400) defaultLanguageNotSetError defaultLanguage 必須設為更新 localizations
badRequest (400) localizationValidationError 本地化物件中的其中一個值驗證失敗。請使用 playlists.list 方法擷取有效值,並確保按照播放清單資源說明文件中的指南更新這些值。
forbidden (403) playlistForbidden 系統禁止這項作業,或是要求未經過適當授權。
invalidValue (400) invalidPlaylistSnippet 要求提供無效的播放清單片段。
notFound (404) playlistNotFound 找不到使用要求的 id 參數識別的播放清單。
required (400) playlistTitleRequired 要求必須指定播放清單標題。
invalidValue (400) playlistOperationUnsupported 這個 API 不支援更新指定播放清單的功能。舉例來說,你無法更新已上傳影片播放清單的屬性。

試試看!

使用 APIs Explorer 呼叫此 API,並查看 API 要求和回應。