更新字幕軌。更新字幕軌時,您可以變更曲目的草稿狀態和/或上傳該曲目的新字幕檔。
這個方法支援媒體上傳功能。上傳的檔案必須符合下列條件:
- 檔案大小上限: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 名稱:
|
|
選用參數 | ||
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 要求和回應。