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
    • status.podcastStatus
    • 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 要求和回應。