Captions: update

更新字幕軌。更新字幕軌時,你可以變更字幕軌的草稿狀態、上傳字幕軌的新字幕檔,或同時執行這兩項操作。

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

  • 檔案大小上限:100 MB
  • 可接受的媒體 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 要求和回應。