下載字幕軌。除非要求指定了 tfmt
參數的值,否則系統會以原始格式傳回字幕軌 (如果要求指定了 tlang
參數的值)。
配額影響:呼叫此方法的配額費用為 200 個單位。
常見用途
要求
HTTP 要求
GET https://www.googleapis.com/youtube/v3/captions/id
授權
此要求需要至少具備下列其中一個範圍的授權 (進一步瞭解驗證和授權)。
範圍 |
---|
https://www.googleapis.com/auth/youtube.force-ssl |
https://www.googleapis.com/auth/youtubepartner |
參數
下表列出這項查詢支援的參數。上方列出的所有參數都是查詢參數。
參數 | ||
---|---|---|
必要參數 | ||
id |
string id 參數可識別正在擷取的字幕軌。這個值是 caption 資源中 id 屬性識別的字幕軌 ID。 |
|
選用參數 | ||
onBehalfOfContentOwner |
string 這個參數只能在妥善的授權要求中使用。注意:這個參數僅適用於 YouTube 內容合作夥伴。 onBehalfOfContentOwner 參數表示請求的授權憑證能代表代替參數值中所指定的內容擁有者所擔任的 YouTube CMS 使用者。這個參數適用於擁有和管理多個不同 YouTube 頻道的 YouTube 內容合作夥伴。內容擁有者只要驗證一次即可,就能存取所有影片和頻道資料,而不需要為每個頻道分別提供驗證憑證。使用者驗證的實際 CMS 帳戶必須連結至指定的 YouTube 內容擁有者。 |
|
tfmt |
string tfmt 參數會指定以特定格式傳回字幕軌。如果要求中未包含這個參數,系統將以原始格式傳回播放軌。支援的值如下:
|
|
tlang |
string tlang 參數會指定 API 回應應傳回指定字幕軌的翻譯。參數值為 ISO 639-1 雙字母語言代碼,識別所需的字幕語言。使用機器翻譯 (例如「Google 翻譯」) 進行翻譯。 |
要求主體
呼叫此方法時請不要提供要求主體。
回應
如果成功,此方法會傳回二進位檔案。回應的 Content-Type
標頭為 application/octet-stream
。
錯誤
下表列出 API 針對呼叫方法所傳回的錯誤訊息。詳情請參閱錯誤訊息說明文件。
錯誤類型 | 錯誤詳細資料 | 說明 |
---|---|---|
forbidden (403) |
forbidden |
與要求相關聯的權限不足以下載字幕軌。這項要求可能未獲得適當授權,或者影片委刊單可能未啟用這個字幕的第三方貢獻功能。 |
invalidValue (400) |
couldNotConvert |
字幕追蹤資料無法轉換成您要求的語言和/或格式。確認要求的 tfmt 和 tlang 值有效,且要求的字幕軌的 snippet.status 並非 failed 。 |
notFound (404) |
captionNotFound |
找不到字幕軌。請檢查要求的 id 參數值,確認該參數正確無誤。 |
試試看!
使用 APIs Explorer 呼叫這個 API 並查看 API 要求和回應。