傳回與指定影片相關聯的字幕軌清單。請注意,API 回應不包含實際字幕,而且 captions.download
方法可讓您擷取字幕軌。
配額影響:呼叫此方法的配額費用為 50 單位。
常見用途
要求
HTTP 要求
GET https://www.googleapis.com/youtube/v3/captions
授權
此要求需要至少具備下列其中一個範圍的授權 (進一步瞭解驗證和授權)。
範圍 |
---|
https://www.googleapis.com/auth/youtube.force-ssl |
https://www.googleapis.com/auth/youtubepartner |
參數
下表列出這項查詢支援的參數。上方列出的所有參數都是查詢參數。
參數 | ||
---|---|---|
必要參數 | ||
part |
string part 參數會指定 API 回應將包含的 caption 資源部分。以下清單包含可在參數值中加入的 part 名稱:
|
|
videoId |
string videoId 參數會指定 API 要傳回字幕軌的影片的 YouTube 影片 ID。 |
|
選用參數 | ||
id |
string id 參數會指定以逗號分隔的 ID 清單,以識別應擷取的 caption 資源。每個 ID 都必須識別與指定影片相關聯的字幕軌。 |
|
onBehalfOfContentOwner |
string 這個參數只能在妥善的授權要求中使用。注意:這個參數僅適用於 YouTube 內容合作夥伴。 onBehalfOfContentOwner 參數表示請求的授權憑證能代表代替參數值中所指定的內容擁有者所擔任的 YouTube CMS 使用者。這個參數適用於擁有和管理多個不同 YouTube 頻道的 YouTube 內容合作夥伴。內容擁有者只要驗證一次即可,就能存取所有影片和頻道資料,而不需要為每個頻道分別提供驗證憑證。使用者驗證的實際 CMS 帳戶必須連結至指定的 YouTube 內容擁有者。 |
要求主體
呼叫此方法時請不要提供要求主體。
回應
如果成功的話,這個方法會傳回回應內文,其結構如下:
{ "kind": "youtube#captionListResponse", "etag": etag, "items": [ caption Resource ] }
屬性
下表定義此資源中顯示的屬性:
屬性 | |
---|---|
kind |
string 識別 API 資源類型。這個值會是 youtube#captionListResponse 。 |
etag |
etag 這項資源的 Etag。 |
items[] |
list 符合要求條件的字幕清單。 |
錯誤
下表說明 API 在回應此方法時可能傳回的錯誤訊息。詳情請參閱錯誤訊息說明文件。
錯誤類型 | 錯誤詳細資料 | 說明 |
---|---|---|
forbidden (403) |
forbidden |
無法擷取一或多個字幕軌,因為與要求相關的權限不足以擷取要求的資源。要求可能未獲適當授權。 |
notFound (404) |
captionNotFound |
找不到一或多個指定的字幕軌。當 videoId 參數識別出實際影片,但 id 參數識別不存在的字幕軌編號或是與其他影片相關的追蹤 ID,就會發生這個錯誤。檢查要求的 id 和 videoId 參數值,確保這些參數正確無誤。 |
notFound (404) |
videoNotFound |
找不到以 videoId 參數識別的影片。 |
試試看!
使用 APIs Explorer 呼叫這個 API 並查看 API 要求和回應。