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 可識別寫入作業會設定的屬性，以及 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 要求和回應。