API Reference

YouTube Data API cho phép bạn tích hợp các chức năng thường được thực hiện trên trang web YouTube vào trang web hoặc ứng dụng của riêng bạn. Các phần sau đây xác định các loại tài nguyên mà bạn có thể truy xuất bằng API. API này cũng hỗ trợ các phương thức chèn, cập nhật hoặc xoá nhiều tài nguyên trong số này.

Hướng dẫn tham khảo này giải thích cách sử dụng API để thực hiện tất cả các thao tác này. Hướng dẫn này được sắp xếp theo loại tài nguyên. Tài nguyên đại diện cho một loại mục tạo nên một phần của trải nghiệm trên YouTube, chẳng hạn như video, danh sách phát hoặc gói thuê bao. Đối với mỗi loại tài nguyên, hướng dẫn này liệt kê một hoặc nhiều biểu diễn dữ liệu và tài nguyên được biểu diễn dưới dạng các đối tượng JSON. Hướng dẫn này cũng liệt kê một hoặc nhiều phương thức được hỗ trợ (LIST, POST, DELETE, v.v.) cho từng loại tài nguyên và giải thích cách sử dụng các phương thức đó trong ứng dụng của bạn.

Gọi API

Các yêu cầu sau đây áp dụng cho các yêu cầu gửi đến YouTube Data API:

  1. Mỗi yêu cầu phải chỉ định một khoá API (với tham số key) hoặc cung cấp mã thông báo OAuth 2.0. Bạn có thể tìm thấy khoá API trong ngăn Quyền truy cập API của Developer Console cho dự án của mình.

  2. Bạn phải gửi mã uỷ quyền cho mọi yêu cầu chèn, cập nhật và xoá. Bạn cũng phải gửi mã thông báo uỷ quyền cho mọi yêu cầu truy xuất dữ liệu riêng tư của người dùng đã xác thực.

    Ngoài ra, một số phương thức API để truy xuất tài nguyên có thể hỗ trợ các tham số yêu cầu uỷ quyền hoặc có thể chứa siêu dữ liệu bổ sung khi các yêu cầu được uỷ quyền. Ví dụ: yêu cầu truy xuất video do người dùng tải lên cũng có thể chứa video riêng tư nếu yêu cầu đó được người dùng cụ thể đó uỷ quyền.

  3. API này hỗ trợ giao thức xác thực OAuth 2.0. Bạn có thể cung cấp mã thông báo OAuth 2.0 theo một trong hai cách sau:

    • Sử dụng tham số truy vấn access_token như sau: ?access_token=oauth2-token
    • Sử dụng tiêu đề HTTP Authorization như sau: Authorization: Bearer oauth2-token

    Bạn có thể xem hướng dẫn đầy đủ về cách triển khai quy trình xác thực OAuth 2.0 trong ứng dụng của mình trong hướng dẫn xác thực.

Loại tài nguyên

Hoạt động

Tài nguyên activity chứa thông tin về một hành động mà một kênh hoặc người dùng cụ thể đã thực hiện trên YouTube. Các hành động được báo cáo trong bản tin hoạt động bao gồm đánh giá video, chia sẻ video, đánh dấu video là video yêu thích, tải video lên, v.v. Mỗi tài nguyên activity xác định loại hành động, kênh được liên kết với hành động và(các) tài nguyên được liên kết với hành động, chẳng hạn như video được xếp hạng hoặc tải lên.

Để biết thêm thông tin về tài nguyên này, hãy xem phần biểu thị tài nguyên và danh sách thuộc tính của tài nguyên.

Phương thức Yêu cầu HTTP Mô tả
URI liên quan đến https://www.googleapis.com/youtube/v3
list GET /activities Trả về danh sách các sự kiện hoạt động của kênh phù hợp với tiêu chí của yêu cầu. Ví dụ: bạn có thể truy xuất các sự kiện liên kết với một kênh cụ thể hoặc với kênh của chính người dùng.

Phụ đề

Tài nguyên caption đại diện cho một tệp phụ đề trên YouTube. Một tệp phụ đề được liên kết với chính xác một video trên YouTube.

Để biết thêm thông tin về tài nguyên này, hãy xem phần biểu thị tài nguyên và danh sách thuộc tính của tài nguyên.

Phương thức Yêu cầu HTTP Mô tả
URI liên quan đến https://www.googleapis.com/youtube/v3
delete DELETE /captions Xoá tệp phụ đề đã chỉ định.
download GET /captions/id Tải một tệp phụ đề xuống. Tệp phụ đề được trả về ở định dạng gốc, trừ phi yêu cầu chỉ định một giá trị cho tham số tfmt và ở ngôn ngữ gốc, trừ phi yêu cầu chỉ định một giá trị cho tham số tlang.
insert POST /captions Tải một tệp phụ đề lên.
list GET /captions Trả về danh sách các tệp phụ đề được liên kết với một video cụ thể. 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 tệp phụ đề.
update PUT /captions Cập nhật một tệp phụ đề. Khi cập nhật một tệp phụ đề, bạn có thể thay đổi trạng thái bản nháp của tệp, tải một tệp phụ đề mới lên cho tệp đó hoặc làm cả hai.

ChannelBanners

Tài nguyên channelBanner chứa URL mà bạn sẽ dùng để đặt một hình ảnh mới tải lên làm hình ảnh biểu ngữ cho một kênh.

Để biết thêm thông tin về tài nguyên này, hãy xem phần biểu thị tài nguyên và danh sách thuộc tính của tài nguyên.

Phương thức Yêu cầu HTTP Mô tả
URI liên quan đến https://www.googleapis.com/youtube/v3
insert POST /channelBanners/insert Tải ảnh biểu ngữ kênh lên YouTube. Phương thức này đại diện cho 2 bước đầu tiên trong quy trình gồm 3 bước để cập nhật ảnh biểu ngữ cho một kênh:
  1. Gọi phương thức channelBanners.insert để tải dữ liệu hình ảnh nhị phân lên YouTube. Hình ảnh phải có tỷ lệ khung hình 16:9 và kích thước tối thiểu là 2048x1152 pixel. Bạn nên tải ảnh có kích thước 2560px x 1440px lên.
  2. Trích xuất giá trị của thuộc tính url từ phản hồi mà API trả về cho bước 1.
  3. Gọi phương thức channels.update để cập nhật chế độ cài đặt bộ nhận diện thương hiệu của kênh. Đặt giá trị của thuộc tính brandingSettings.image.bannerExternalUrl thành URL thu được ở bước 2.

ChannelSections

Tài nguyên channelSection chứa thông tin về một nhóm video mà một kênh đã chọn để giới thiệu. Ví dụ: một phần có thể giới thiệu những video mới nhất, video phổ biến nhất hoặc video trong một hay nhiều danh sách phát của một kênh.

Các phần của kênh chỉ xuất hiện nếu kênh đó hiển thị nội dung ở chế độ xem duyệt qua (thay vì chế độ xem danh sách). Để cho phép một kênh hiển thị nội dung ở chế độ xem duyệt qua, hãy đặt thuộc tính brandingSettings.channel.showBrowseView thành true cho kênh được chỉ định.

Một kênh có thể tạo tối đa 10 kệ.

Để biết thêm thông tin về tài nguyên này, hãy xem phần biểu thị tài nguyên và danh sách thuộc tính của tài nguyên.

Phương thức Yêu cầu HTTP Mô tả
URI liên quan đến https://www.googleapis.com/youtube/v3
delete DELETE /channelSections Xoá một phần kênh.
insert POST /channelSections Thêm một phần trên kênh vào kênh của người dùng đã xác thực. Một kênh có thể tạo tối đa 10 kệ.
list GET /channelSections Trả về danh sách các tài nguyên channelSection phù hợp với tiêu chí của yêu cầu API.
update PUT /channelSections Cập nhật một phần kênh.

Kênh

Tài nguyên channel chứa thông tin về một kênh YouTube.

Để biết thêm thông tin về tài nguyên này, hãy xem phần biểu thị tài nguyên và danh sách thuộc tính của tài nguyên.

Phương thức Yêu cầu HTTP Mô tả
URI liên quan đến https://www.googleapis.com/youtube/v3
list GET /channels Trả về một tập hợp gồm 0 hoặc nhiều tài nguyên channel khớp với tiêu chí của yêu cầu.
update PUT /channels Cập nhật siêu dữ liệu của một kênh. Phương thức này chỉ hỗ trợ các nội dung cập nhật cho đối tượng brandingSettings và invideoPromotion của tài nguyên channel cũng như các thuộc tính con của các đối tượng này.

CommentThreads

Tài nguyên commentThread chứa thông tin về một chuỗi nhận xét trên YouTube, bao gồm một nhận xét cấp cao nhất và các phản hồi (nếu có) cho nhận xét đó. Tài nguyên commentThread có thể đại diện cho bình luận về video hoặc kênh.

Cả bình luận cấp cao nhất và câu trả lời đều là tài nguyên comment được lồng bên trong tài nguyên commentThread. Tài nguyên commentThread không nhất thiết phải chứa tất cả câu trả lời cho một bình luận. Bạn cần sử dụng phương thức comments.list nếu muốn truy xuất tất cả câu trả lời cho một bình luận cụ thể. Ngoài ra, một số bình luận không có câu trả lời.

Để biết thêm thông tin về tài nguyên này, hãy xem phần biểu thị tài nguyên và danh sách thuộc tính của tài nguyên.

Phương thức Yêu cầu HTTP Mô tả
URI liên quan đến https://www.googleapis.com/youtube/v3
list GET /commentThreads Trả về danh sách các chuỗi bình luận phù hợp với các tham số yêu cầu API.
insert POST /commentThreads Tạo một bình luận cấp cao nhất mới. Để thêm câu trả lời vào một bình luận hiện có, hãy sử dụng phương thức comments.insert.

Bình luận

Tài nguyên comment chứa thông tin về một bình luận trên YouTube. Tài nguyên comment có thể đại diện cho một bình luận về video hoặc kênh. Ngoài ra, bình luận đó có thể là bình luận cấp cao nhất hoặc là câu trả lời cho một bình luận cấp cao nhất.

Để biết thêm thông tin về tài nguyên này, hãy xem phần biểu thị tài nguyên và danh sách thuộc tính của tài nguyên.

Phương thức Yêu cầu HTTP Mô tả
URI liên quan đến https://www.googleapis.com/youtube/v3
list GET /comments Trả về danh sách các bình luận phù hợp với các tham số yêu cầu API.
setModerationStatus POST /comments/setModerationStatus Đặt trạng thái kiểm duyệt cho một hoặc nhiều bình luận. Chủ sở hữu của kênh hoặc video có liên quan đến bình luận phải uỷ quyền cho yêu cầu API.
insert