PlaylistItems: update

修改播放清單項目。舉例來說，您可以更新項目在播放清單中的位置。

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

常見用途

要求

HTTP 要求

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

授權

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

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

參數

下表列出此查詢支援的參數。這裡列出的參數全都是查詢參數。

參數
必要參數
part string
在這項作業中，part 參數有兩個用途。可用於識別寫入作業將設定的屬性，以及 API 回應會包含的屬性。

請注意，這個方法會覆寫參數值指定部分所含可變動屬性的現有值。舉例來說，播放清單項目可以指定開始時間和結束時間，藉此指定使用者觀看播放清單中的影片時，該部分在影片中顯示的時間。如果您在要求更新的播放清單項目中設定這些值，且要求的 part 參數值包含 contentDetails 部分，則播放清單項目的開始和結束時間會更新為要求主體指定的值。如果要求主體並未指定值，系統會移除現有的開始和結束時間，並替換成預設設定。

以下清單列出您可以加入參數值的 part 名稱：
  • contentDetails
  • id
  • snippet
  • status
選用參數
onBehalfOfContentOwner string
注意：onBehalfOfContentOwner 參數僅適用於 YouTube 內容合作夥伴，且只可用於適當的授權要求。

這個參數專為擁有及管理多個不同 YouTube 頻道的 YouTube 內容合作夥伴而設計。透過這項功能，與內容擁有者相關聯的使用者只需驗證一次，就可以存取及管理內容擁有者的所有影片和頻道資料，而不必為每個頻道提供驗證憑證。

出現這個參數之後，該參數的值會識別內容擁有者，而要求的授權憑證可識別有權代表該內容擁有者的 YouTube 使用者。使用者驗證的帳戶必須在 YouTube 創作者工作室設定中，連結至指定的內容擁有者。

要求主體

在要求主體中提供 playlistItem 資源。針對該資源：

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

    • id
    • snippet.playlistId
    • snippet.resourceId

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

    • snippet.position
    • contentDetails.note
    • contentDetails.startAt
    • contentDetails.endAt

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

回應

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

錯誤

下表列出 API 回應此方法時可能傳回的錯誤訊息。詳情請參閱錯誤訊息的說明文件。

錯誤類型 錯誤詳細資料 說明
forbidden (403) playlistItemsNotAccessible 這項要求未獲適當授權，無法更新指定播放清單項目。
invalidValue (400) invalidPlaylistItemPosition 這項要求嘗試將播放清單項目的位置設為無效或不支援的值。檢查資源 snippet 中 position 屬性的值。
invalidValue (400) invalidResourceType 系統不支援針對資源 ID 指定的 type，進行這項作業。資源 ID 可用來識別要加入播放清單的項目，例如 youtube#video。
invalidValue (400) invalidSnippet 要求未指定有效的 snippet 屬性。
invalidValue (400) manualSortRequired 這項要求嘗試設定播放清單項目的位置，但播放清單並未使用手動排序。(例如，播放清單項目可以依照日期或熱門程度排序)。如要解決這個錯誤，請從要求插入的資源中移除 snippet.position 元素。如果您希望播放清單項目在清單中的特定位置，請先在播放清單設定中，將播放清單的「排序」選項更新為「手動」。你可以前往 YouTube 影片管理員調整這項設定。
notFound (404) playlistItemNotFound 找不到具有要求 id 屬性的播放清單項目。
notFound (404) playlistNotFound 找不到使用要求 playlistId 參數指定的播放清單。
required (400) channelIdRequired 要求並未指定必要的 channelId 屬性值。
required (400) playlistIdRequired 要求並未指定必要的 playlistId 屬性值。
required (400) playlistItemIdRequired 要求中指定的播放清單項目資源必須使用 id 屬性，才能識別要更新的播放清單項目。
invalidValue (400) playlistOperationUnsupported API 不支援更新指定播放清單中的影片。舉例來說，你無法更新上傳影片播放清單中的影片。

試試看！

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