Captions: update

更新字幕軌。更新字幕軌時，您可以變更播放軌的「草稿狀態」、上傳新曲目的新字幕檔案，或同時上傳兩者。

這個方法支援媒體上傳。上傳檔案必須符合下列限制：

  • 檔案大小上限：100MB
  • 系統接受的媒體 MIME 類型：text/xml、application/octet-stream、*/*

配額影響：呼叫此方法的配額費用為 450 單位。

常見用途

要求

HTTP 要求

PUT https://www.googleapis.com/upload/youtube/v3/captions

授權

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

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

參數

下表列出這項查詢支援的參數。上方列出的所有參數都是查詢參數。

參數
必要參數
part string
在這項作業中，part 參數有兩個用途。可識別寫入作業將設定的屬性，以及 API 回應將包含的屬性。如果您要更新測試群組的草稿狀態，請將屬性值設為 snippet。否則，請將屬性值設為 id。

以下清單包含可在參數值中加入的 part 名稱：
  • id
  • snippet
選用參數
onBehalfOfContentOwner string
這個參數只能在妥善的授權要求中使用。注意：這個參數僅適用於 YouTube 內容合作夥伴。

onBehalfOfContentOwner 參數表示請求的授權憑證能代表代替參數值中所指定的內容擁有者所擔任的 YouTube CMS 使用者。這個參數適用於擁有和管理多個不同 YouTube 頻道的 YouTube 內容合作夥伴。內容擁有者只要驗證一次即可，就能存取所有影片和頻道資料，而不需要為每個頻道分別提供驗證憑證。使用者驗證的實際 CMS 帳戶必須連結至指定的 YouTube 內容擁有者。
sync boolean
注意：只有在要求包含更新的字幕檔時，API 伺服器才會處理參數值。

sync 參數指示 YouTube 是否應讓字幕檔案與影片的音軌自動同步。如果將值設為 true，YouTube 會自動同步處理音軌與音軌。

要求主體

在要求主體中提供說明文字資源。這項資源：

  • 您必須指定這些屬性的值：

    • id

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

    • snippet.isDraft

    如果您提交了更新要求，且您的要求沒有已指定屬性的值，系統將刪除該屬性的現有值。

回應

如果成功的話，這個方法會傳回回應主體中的字幕資源。

錯誤

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

錯誤類型 錯誤詳細資料 說明
badRequest (400) contentRequired 要求未上傳更新後的字幕檔案。如果 sync 參數設為 true，就必須使用實際音軌內容。
forbidden (403) forbidden 與要求相關聯的權限不足，無法更新字幕軌。要求可能未獲適當授權。
notFound (404) captionNotFound 找不到指定的字幕軌。檢查要求的 id 屬性值，以確保值正確無誤。

試試看！

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