SuperChatEvents: list

Liệt kê các sự kiện Super Chat trong sự kiện phát trực tiếp của một kênh trong 30 ngày qua.

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

Ủ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 superChatEvent 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 máy chủ API định dạng giá trị thuộc tính snippet.displayString. Giá trị này cho biết số tiền mua và đơn vị tiền tệ của một Super Chat theo quy ước của một ngôn ngữ cụ thể. Giá trị tham số phải là mã ngôn ngữ có trong danh sách được phương thức i18nLanguages.list trả về. Giá trị mặc định là en, nghĩa là hành vi mặc định là định dạng các chuỗi hiển thị vì chúng sẽ được sử dụng trong tiếng Anh. Ví dụ: theo mặc định, một chuỗi được định dạng là $1.00 thay vì $1,00.
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ừ 1 đế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#superChatEventListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    superChatEvent 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#superChatEventListResponse.
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 giao dịch mua Super Chat 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 Yêu cầu này không được phép truy xuất đúng cách các sự kiện Super Chat.

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.