Captions: download

下載字幕軌。除非要求指定 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 參數指定應以特定格式傳回字幕軌。如果要求中未包含這個參數,系統會以原始格式傳回音軌。

支援的值如下:
  • sbv - SubViewer 字幕
  • scc - Scenarist 隱藏式輔助字幕格式
  • srt – SubRip 字幕
  • ttml - 時序文本標記語言字幕
  • vtt - Web Video Text Tracks 字幕
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 要求和回應。