Captions: list

Trả về danh sách các tệp phụ đề được liên kết với một video cụ thể. Xin lưu ý rằng phản hồi của API không chứa phụ đề thực tế và phương thức captions.download cho phép bạn truy xuất tệp phụ đề.

Tác động đến hạn mức: Một lệnh gọi đến phương thức này có chi phí hạn mức là 50 đơn vị.

Các trường hợp sử dụng phổ biến

Yêu cầu

Yêu cầu HTTP

GET https://www.googleapis.com/youtube/v3/captions

Ủy quyền

Yêu cầu này cần được uỷ quyền với ít nhất một trong các phạm vi sau (đọc thêm về quy trình xác thực và uỷ quyền).

Phạm vi
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtubepartner

Thông số

Bảng sau đây liệt kê các tham số mà truy vấn này hỗ trợ. Tất cả các tham số được liệt kê đều là tham số truy vấn.

Thông số
Tham số bắt buộc
part string
Tham số part chỉ định các phần tài nguyên caption mà phản hồi của API sẽ bao gồm.

Danh sách dưới đây chứa các tên part mà bạn có thể đưa vào giá trị tham số:
  • id
  • snippet
videoId string
Tham số videoId chỉ định mã video trên YouTube của video mà API sẽ trả về bản ghi chú thích.
Thông số tuỳ chọn
id string
Tham số id chỉ định danh sách mã được phân tách bằng dấu phẩy để xác định các tài nguyên caption cần truy xuất. Mỗi mã phải xác định một tệp phụ đề được liên kết với video cụ thể.
onBehalfOfContentOwner string
Tham số này chỉ có thể được dùng trong một yêu cầu được uỷ quyền đúng cách. Lưu ý: Tham số này chỉ dành riêng cho các đối tác nội dung trên YouTube.

Tham số onBehalfOfContentOwner cho biết rằng thông tin xác thực uỷ quyền của yêu cầu xác định một người dùng YouTube CMS đang thay mặt cho chủ sở hữu nội dung được chỉ định trong giá trị tham số. Tham số này dành cho các đối tác nội dung trên YouTube sở hữu và quản lý nhiều kênh YouTube. Tham số này cho phép chủ sở hữu nội dung xác thực một lần và truy cập vào tất cả dữ liệu video và kênh của họ mà không cần cung cấp thông tin xác thực cho từng kênh. Tài khoản CMS thực tế mà người dùng xác thực phải được liên kết với chủ sở hữu nội dung cụ thể trên YouTube.

Nội dung yêu cầu

Đừng cung cấp nội dung yêu cầu khi gọi phương thức này.

Phản hồi

Nếu thành công, phương thức này sẽ trả về một nội dung phản hồi có cấu trúc sau:

{
  "kind": "youtube#captionListResponse",
  "etag": etag,
  "items": [
    caption Resource
  ]
}

Thuộc tính

Bảng sau đây xác định các thuộc tính xuất hiện trong tài nguyên này:

Thuộc tính
kind string
Xác định loại tài nguyên API. Giá trị sẽ là youtube#captionListResponse.
etag etag
Etag của tài nguyên này.
items[] list
Danh sách các chú thích phù hợp với tiêu chí yêu cầu.

Lỗi

Bảng sau đây xác định các thông báo lỗi mà API có thể trả về để phản hồi lệnh gọi đến phương thức này. Vui lòng xem tài liệu về thông báo lỗi để biết thêm chi tiết.

Loại lỗi Chi tiết lỗi Mô tả
forbidden (403) forbidden Không truy xuất được một hoặc nhiều tệp phụ đề vì các quyền liên kết với yêu cầu không đủ để truy xuất các tài nguyên được yêu cầu. Yêu cầu có thể không được uỷ quyền đúng cách.
notFound (404) captionNotFound Không tìm thấy một hoặc nhiều tệp phụ đề được chỉ định. Lỗi này xảy ra nếu tham số videoId xác định một video thực tế, nhưng tham số id xác định các mã tệp phụ đề không tồn tại hoặc các mã theo dõi được liên kết với các video khác. Kiểm tra giá trị của các tham số id và videoId trong yêu cầu để đảm bảo rằng các giá trị đó là chính xác.
notFound (404) videoNotFound Không tìm thấy video được xác định bằng tham số videoId.

Hãy dùng thử!

Sử dụng APIs Explorer để gọi API này và xem Yêu cầu API và phản hồi của API.