Captions: list

傳回與指定影片相關聯的字幕軌清單。請注意，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 名稱：
  • id
  • snippet
videoId string
videoId 參數會指定 API 應傳回字幕軌的 YouTube 影片 ID。
選用參數
id string
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，就會發生這項錯誤。檢查要求中 id 和 videoId 參數的值，確保正確無誤。
notFound (404) videoNotFound 找不到 videoId 參數指定的影片。

試試看！

使用 APIs Explorer 呼叫這個 API，並查看 API 要求和回應。