Sponsors: list

Lưu ý: Phương thức này sẽ không được dùng nữa kể từ ngày 31 tháng 3 năm 2020. Phương thức này đã được thay thế bằng phương thức members.list. Bạn có thể tìm thông tin về phương thức đó trong tài liệu về API Dữ liệu của YouTube.

Chúng tôi sẽ ngừng hỗ trợ phương thức sponsors.list kể từ ngày 30 tháng 9 năm 2020. Các ứng dụng API nên cập nhật lệnh gọi tới phương thức sponsors.list để sử dụng phương thức members.list.

Liệt kê các hội viên (trước đây gọi là "nhà tài trợ") của một kênh. Yêu cầu API phải được chủ sở hữu kênh cho phép.

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/sponsors

Ủ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
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtube.readonly

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 sponsor sẽ bao gồm phản hồi API. Các giá trị được hỗ trợ là id và snippet.
Thông số không bắt buộc
filter string
Tham số filter chỉ định kênh tài trợ sẽ trả lại hàng. Giá trị mặc định là newest.

Các giá trị được chấp nhận là:
  • all – Trả lại tất cả các nhà tài trợ, từ mới nhất đến cũ nhất.
  • newest – Trả lại một trang về các nhà tài trợ gần đây nhất. Các yêu cầu tiếp theo sử dụng nextPageToken sẽ truy xuất những người đăng ký mới hơn khi họ đăng ký.
maxResults unsigned integer
Tham số maxResults chỉ định số lượng mục tối đa cần được trả về trong tập hợp kết quả. Các giá trị được chấp nhận là từ 0 đến 50 (bao gồm cả hai giá trị này). Giá trị mặc định là 5.
pageToken string
Tham số pageToken xác định một trang cụ thể trong nhóm kết quả sẽ được trả về. Trong một phản hồi API, thuộc tính nextPageToken và prevPageToken xác định những trang khác có thể truy xuất.

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#sponsorListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    sponsor 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#sponsorListResponse.
etag etag
Thẻ Etag của tài nguyên này.
nextPageToken string
Mã thông báo có thể được dùng làm giá trị của tham số pageToken để truy xuất trang tiếp theo trong tập hợp kết quả.
pageInfo object
Đối tượng pageInfo đóng gói thông tin phân trang cho tập hợp kết quả.
pageInfo.totalResults integer
Tổng số kết quả trong nhóm kết quả.
pageInfo.resultsPerPage integer
Số lượng kết quả có trong phản hồi của API.
items[] list
Danh sách các nhà tài trợ đáp ứng các 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) insufficientPermissions Bạn không có các quyền cần thiết để xem nhà tài trợ của kênh.
invalidValue (400) invalidValueInRequest Yêu cầu chứa giá trị không hợp lệ.
invalidValue (400) sponsorshipNotEnabledForChannelId Kênh này chưa bật tính năng tài trợ.

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.