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 của 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ụ đề.

Tác động đến hạn mức: 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

Tham số

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

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

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
Tham số videoId chỉ định mã video trên YouTube của video mà API này trả về phụ đề.
Thông số không bắt buộc
id string
Tham số id chỉ định một danh sách mã được phân tách bằng dấu phẩy nhằm 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ụ đề liên kết với video được chỉ định.
onBehalfOfContentOwner string
Bạn chỉ có thể dùng thông số này trong một yêu cầu được uỷ quyền đúng cách. Lưu ý: Thông số này chỉ dành cho các đối tác nội dung của YouTube.

Thông số onBehalfOfContentOwner cho biết thông tin uỷ quyền của yêu cầu giúp xác định một người dùng YouTube CMS đang hành động thay mặt cho chủ sở hữu nội dung được chỉ định trong giá trị thông số. Thông số này dành cho những đối tác nội dung trên 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à có quyền truy cập vào tất cả dữ liệu kênh cũng như video của mình 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 dùng để xác thực phải được liên kết với chủ sở hữu nội dung đã chỉ định 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ề nội dung phản hồi có cấu trúc như 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
Thẻ Etag của tài nguyên này.
items[] list
Danh sách phụ đề phù hợ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ề để 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 Nội dung mô tả
forbidden (403) forbidden Không thể truy xuất một hoặc nhiều phụ đề vì các quyền được liên kết với yêu cầu không đủ để truy xuất tài nguyên được yêu cầu. Yêu cầu có thể không được uỷ quyền đúng.
notFound (404) captionNotFound Không thể tìm thấy một hoặc nhiều phụ đề đã 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 mã phụ đề không tồn tại hoặc mã phụ đề được liên kết với các video khác. Kiểm tra các giá trị tham số id và videoId của yêu cầu để đảm bảo rằng các giá trị này chính xác.
notFound (404) videoNotFound Không thể tìm thấy video được xác định bằng thông số videoId.

Hãy dùng thử!

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.