Captions: list

Trả về danh sách phụ đề được liên kết với một video cụ thể. Lưu ý rằng phản hồi API không chứa phụ đề thực tế và phương thức captions.download cung cấp khả năng truy xuất phụ đề gốc.

Mức tác động cho hạn mức: Một lệnh gọi đến phương thức này có chi phí định 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 yêu cầu uỷ quyền có ít nhất một trong các phạm vi sau (đọc thêm về xác thực và cấp phép).

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

Các tham số

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

Các tham số
Các thông 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 API sẽ bao gồm.

Danh sách bên dưới chứa tên part mà bạn có thể đưa vào giá trị tham số:
  • id
  • snippet
videoId string
Thông số videoId chỉ định mã video trên YouTube của video mà API sẽ trả về bản phụ đề.
Tham số không bắt buộc
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 những tài nguyên caption cần được truy xuất. Mỗi mã nhận dạng phải xác định một phụ đề được liên kết với video cụ thể.
onBehalfOfContentOwner string
Bạn chỉ có thể sử dụng thông số này trong một yêu cầu được uỷ quyền phù hợp. Lưu ý: Tham số này chỉ dành cho các đối tác nội dung của YouTube.

Tham số onBehalfOfContentOwner cho biết rằng thông tin cấp phép của yêu cầu xác định người dùng CMS của YouTube đang thay mặt 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 YouTube sở hữu và quản lý nhiều kênh YouTube khác nhau. Tính năng 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 phải 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 YouTube đã chỉ định.

Nội dung yêu cầu

Khô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ề nội dung phản hồi với 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 phụ đề khớp với tiêu chí của 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ề khi một 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 thông tin chi tiết.

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

Hãy dùng thử!

Hãy dùng APIs Explorer để gọi API này cũng như xem yêu cầu và phản hồi của API.