Trang này được dịch bởi Cloud Translation API.

Sponsors: list

Lưu ý: Phương thức này đã ngừng hoạt động 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ấy thông tin về phương thức đó trong tài liệu về API Dữ liệu YouTube.

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

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

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 yêu cầu uỷ quyền có ít nhất một trong các phạm vi sau (đọc thêm về xác thực và cấp phép).

Phạm vi
`https://www.googleapis.com/auth/youtube`
`https://www.googleapis.com/auth/youtube.force-ssl`
`https://www.googleapis.com/auth/youtube.readonly`

Các tham số

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

Các tham số
Các thông số bắt buộc
`part`	`string` Tham số `part` chỉ định các phần tài nguyên `sponsor` mà phản hồi API sẽ đưa vào. Giá trị được hỗ trợ là `id` và `snippet`.
Tham số không bắt buộc
`filter`	`string` Thông số `filter` cho biết kênh nào tài trợ để trả về. Giá trị mặc định là `newest`. Các giá trị được chấp nhận là: `all` – Trả lại tất cả nhà tài trợ, từ mới nhất đến cũ nhất. `newest` – Trả về một trang của các nhà tài trợ gần đây nhất. Các yêu cầu tiếp theo bằng cách sử dụng `nextPageToken` sẽ truy xuất 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 trả về trong tập hợp kết quả. 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 tập hợp kết quả nên được trả về. Trong phản hồi API, thuộc tính `nextPageToken` và `prevPageToken` xác định các trang khác có thể được truy xuất.

Nội dung yêu cầu

Khô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 với cấu trúc 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` 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 thông 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 tập hợp kết quả.
`pageInfo.resultsPerPage`	`integer` Số lượng kết quả có trong phản hồi API.
`items[]`	`list` Danh sách nhà tài trợ phù hợp với tiêu chí 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ề khi 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 chi tiết.

Loại lỗi	Thông tin chi tiết về lỗi	Mô tả
`forbidden (403)`	`insufficientPermissions`	Bạn không có các quyền cần thiết để xem tài trợ của kênh.
`invalidValue (400)`	`invalidValueInRequest`	Yêu cầu chứa một giá trị không hợp lệ.
`invalidValue (400)`	`sponsorshipNotEnabledForChannelId`	Kênh chưa bật tính năng tài trợ.

Hãy dùng thử!

Hãy 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.