Triển khai: Phụ đề

Các ví dụ sau đây cho biết cách sử dụng API Dữ liệu YouTube (phiên bản 3) để thực hiện các chức năng liên quan đến phụ đề.

Truy xuất danh sách bản phụ đề cho một video

Để truy xuất danh sách các bản phụ đề có sẵn cho một video cụ thể, hãy gọi phương thức captions.list. Đặt giá trị thông số videoId thành mã video trên YouTube giúp nhận dạng duy nhất video mà bạn đang truy xuất phụ đề. Yêu cầu của bạn phải được uỷ quyền bằng OAuth 2.0.

Yêu cầu bên dưới truy xuất danh sách phụ đề của một video trên kênh Google Stories trên YouTube:

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.list?
part=snippet
&videoId=PRU2ShMzQRg

Xem tài liệu của phương thức captions.list để biết mã mẫu.

Tạo bản phụ đề

Bạn không thể kiểm thử truy vấn này bằng Trình khám phá API vì Trình khám phá API không hỗ trợ tính năng tải tệp lên (đây là yêu cầu đối với phương thức này).

Bạn có thể sử dụng phương thức captions.insert của API để tải một bản phụ đề mới lên cho một video. Khi tải một bản nhạc lên, bạn phải chỉ định giá trị cho các thuộc tính tài nguyên caption sau:

Bạn có thể sử dụng các tuỳ chọn bổ sung sau đây khi tải một bản phụ đề lên:

  • Nếu bạn đặt tham số sync thành true, YouTube sẽ bỏ qua mọi mã thời gian có trong tệp phụ đề đã tải lên và tạo mã thời gian mới cho phụ đề.

    Bạn nên đặt tham số sync thành true nếu bạn đang tải bản chép lời không có mã thời gian lên hoặc nếu bạn nghi ngờ mã thời gian trong tệp của mình không chính xác và muốn YouTube cố gắng khắc phục.

  • Nếu bạn đặt thuộc tính snippet.isDraft của tài nguyên caption thành true, thì bản nhạc sẽ không xuất hiện công khai.

Xem tài liệu của phương thức captions.insert để biết mã mẫu.

Tải bản phụ đề xuống

Bạn không thể kiểm thử truy vấn này bằng Trình khám phá API vì Trình khám phá API không hỗ trợ tính năng tải tệp xuống.

Để tải một bản nhạc phụ đề cụ thể xuống, hãy gọi phương thức captions.download. Đặt giá trị tham số id thành mã của bản phụ đề trên YouTube. Mã này giúp xác định duy nhất bản phụ đề mà bạn đang tải xuống. Yêu cầu của bạn phải được uỷ quyền bằng OAuth 2.0.

API phiên bản 3 hỗ trợ các tuỳ chọn sau:

  • Để chỉ định rằng một bản nhạc phụ đề sẽ được trả về theo một định dạng cụ thể, hãy đặt giá trị tham số tfmt để xác định định dạng mong muốn. Phần khai báo thông số liệt kê các giá trị được hỗ trợ.

  • Để truy xuất bản dịch của một bản phụ đề, hãy đặt giá trị thông số tlang thành mã ngôn ngữ gồm hai chữ cái theo ISO 639-1 để xác định ngôn ngữ phụ đề mong muốn. Bản dịch được tạo bằng công nghệ dịch máy, chẳng hạn như Google Dịch.

Xem tài liệu của phương thức captions.download để biết mã mẫu.

Cập nhật bản phụ đề

API này hỗ trợ việc thay đổi trạng thái bản nháp của một bản phụ đề, tải một bản phụ đề mới lên cho một tệp hoặc cả hai.

Bạn có thể sử dụng Trình khám phá API để kiểm thử khả năng thay đổi trạng thái nháp của một bản nhạc. Tuy nhiên, bạn không thể sử dụng Trình khám phá API để cập nhật bản lồng tiếng thực tế vì công cụ này không hỗ trợ tính năng tải tệp lên.

Yêu cầu bên dưới truy xuất danh sách phụ đề của một video trên kênh Google Stories trên YouTube:

Yêu cầu này sẽ cập nhật trạng thái bản nháp của một bản nhạc phụ đề thành true, nghĩa là bản nhạc đó sẽ không xuất hiện công khai. Để hoàn tất yêu cầu trong Trình khám phá API, bạn cần đặt giá trị của thuộc tính id để xác định một kênh phụ đề.

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.update?
part=snippet

Xem tài liệu của phương thức captions.update để biết mã mẫu.

Xoá bản phụ đề

Ví dụ này cho thấy cách xoá một bản lồng tiếng. Ví dụ này có các bước sau:

  • Bước 1: Truy xuất mã kênh phụ đề

    Làm theo các bước ở trên để truy xuất danh sách các bản phụ đề cho một video. Bạn có thể dùng danh sách này để hiển thị danh sách các bản nhạc phụ đề, sử dụng mã nhận dạng của từng bản nhạc làm khoá.

  • Bước 2: Xoá bản nhạc

    Gọi phương thức captions.delete để xoá một video cụ thể. Trong yêu cầu, tham số id chỉ định mã của bản nhạc phụ đề của bản nhạc mà bạn đang xoá. Yêu cầu phải được uỷ quyền bằng OAuth 2.0. Nếu đang kiểm thử truy vấn này trong Trình khám phá API, bạn cần thay thế mã nhận dạng kênh phụ đề hợp lệ cho giá trị tham số id.

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.delete?
id=CAPTION_TRACK_ID