Tính năng Tài trợ của người hâm mộ đã ngừng hoạt động và API Tài trợ của người hâm mộ sẽ bị tắt vào ngày 28 tháng 2 năm 2017. Thông báo về việc ngừng cung cấp này trùng với việc phát hành tính năng Super Chat mới của YouTube.
Liệt kê các sự kiện tài trợ của người hâm mộ cho một kênh. Yêu cầu API phải được chủ sở hữu kênh cho phép.
Yêu cầu
Yêu cầu HTTP
GET https://www.googleapis.com/youtube/v3/fanFundingEvents
Ủ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 fanFundingEvent 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 | ||
hl |
string Thông số hl hướng dẫn API truy xuất chuỗi hiển thị nội dung được bản địa hóa cho một ngôn ngữ ứng dụng cụ thể mà trang web YouTube hỗ trợ. Ví dụ: bằng tiếng Anh, đơn vị tiền tệ sẽ hiển thị là $1.50 , nhưng bằng tiếng Pháp, đơn vị tiền tệ sẽ hiển thị là 1,50$ .Giá trị thông số phải là mã ngôn ngữ có trong danh sách được phương thức i18nLanguages.list trả về. |
|
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 trang cụ thể trong tập hợp kết quả mà máy chủ API được yêu cầu trả về. Trong một phản hồi API, thuộc tính nextPageToken xác định trang kết quả tiếp theo cho yêu cầu. |
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#fanFundingEventListResponse", "etag": etag, "nextPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ fanFundingEvent 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#fanFundingEventListResponse . |
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 các sự kiện liên quan đến Tài trợ của người hâm mộ phù hợp với 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ề 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 sự kiện Tài trợ của người hâm mộ của kênh. |
invalidValue (400) |
fanFundingNotEnabledForChannelId |
Kênh chưa bật tính năng Tài trợ của người hâm mộ. |
Hãy dùng thử!
Hãy dùng API Explorer để gọi phương thức này trên dữ liệu trực tiếp và xem yêu cầu cũng như phản hồi của API.