SuperChatEvents: list

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

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 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 superChatEvent 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
hl string
Tham 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 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ị như được sử dụng trong tiếng Anh. Ví dụ: theo mặc định, một chuỗi sẽ đượ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 được trả về trong tập hợp kết quả. Các 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 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#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
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 giao dịch mua Super Chat đáp ứng 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 Yêu cầu không được uỷ quyền thích hợp để truy xuất sự kiện Super Chat.

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.