Tải một tệp phụ đề xuống. Tệp phụ đề được trả về ở định dạng ban đầu, trừ phi yêu cầu chỉ định một giá trị cho tham số tfmt và ở ngôn ngữ ban đầu, trừ phi yêu cầu chỉ định một giá trị cho tham số tlang.
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à 200 đơn vị.
Phương thức này yêu cầu người dùng phải có quyền chỉnh sửa video.
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/id
Ủ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 dưới đâ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.
| Thông số | ||
|---|---|---|
| Tham số bắt buộc | ||
id |
stringTham số id xác định tệp phụ đề đang được truy xuất. Giá trị này là mã tệp phụ đề như được xác định bằng thuộc tính id trong tài nguyên caption. |
|
| Thông số tùy chọn | ||
onBehalfOfContentOwner |
stringTham 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 của YouTube. Tham số onBehalfOfContentOwner cho biết rằng thông tin đăng nhập 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 của 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 về 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 chỉ định trên YouTube. |
|
tfmt |
stringTham số tfmt chỉ định rằng tệp phụ đề phải được trả về ở một định dạng cụ thể. Nếu tham số này không có trong yêu cầu, thì tệp phụ đề sẽ được trả về ở định dạng ban đầu.Các giá trị được hỗ trợ là:
|
|
tlang |
stringTham số tlang chỉ định rằng phản hồi của API phải trả về bản dịch của tệp phụ đề được chỉ định. Giá trị tham số là mã ngôn ngữ gồm 2 chữ cái theo tiêu chuẩn ISO 639-1 xác định ngôn ngữ phụ đề mong muốn. Bản dịch được tạo bằng cách sử dụng bản dịch máy, chẳng hạn như Google Dịch. |
|
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 tệp nhị phân. Tiêu đề Content-Type cho phản hồi là application/octet-stream.
Lỗi
Bảng dưới đây xác định các thông báo lỗi mà API có thể trả về để phản hồi 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.
| Loại lỗi | Chi tiết lỗi | Mô tả |
|---|---|---|
forbidden (403) |
forbidden |
Các quyền liên kết với yêu cầu không đủ để tải tệp phụ đề xuống. Yêu cầu có thể không được uỷ quyền đúng cách. |
invalidValue (400) |
couldNotConvert |
Không chuyển đổi được dữ liệu tệp phụ đề sang ngôn ngữ và/hoặc định dạng được yêu cầu. Đảm bảo rằng các giá trị tfmt và tlang được yêu cầu là hợp lệ và snippet.status của tệp phụ đề được yêu cầu không phải là failed. |
notFound (404) |
captionNotFound |
Không tìm thấy tệp phụ đề. Kiểm tra giá trị của tham số id trong yêu cầu để đảm bảo rằng giá trị đó là chính xác. |
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.