Playlists: update

修改播放清單。例如，您可以變更播放清單的標題、說明或隱私設定。

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

常見用途

要求

HTTP 要求

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

授權

這項要求需要至少下列其中一個範圍的授權 (進一步瞭解驗證和授權)。

內容範圍
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 內容擁有者。

要求主體

在要求主體中提供播放清單資源。針對該資源：

  • 您必須指定下列屬性的值：

    • id
    • snippet.title

  • 您可以設定下列屬性的值：

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

    如果您要提交更新要求，而您的要求並未為已經擁有值的屬性值指定值，系統會刪除該資源的現有值。

回應

如果成功的話，這個方法會在回應內文中傳回播放清單資源。

錯誤

下表列出 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 要求和回應。