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