SuperChatEvents: list

Liệt kê các sự kiện Super Chat trong các 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 phải được uỷ quyền với ít nhất một trong các phạm vi sau. Để đọc thêm về việc xác thực và uỷ quyền, hãy xem bài viết Triển khai quy trình xác thực OAuth 2.0.

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ả cá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 mà phản hồi API sẽ bao gồm. Giá trị được hỗ trợ là id và snippet.
Thông số tuỳ chọn
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 một tin nhắn 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 do 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ách sử dụng bằng 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 sẽ được trả về trong tập hợp kết quả. Giá trị có thể chấp nhận là từ 1 đến 50. 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ả cần được trả về. Trong phản hồi API, các 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ề một phần nội dung phản hồi có 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 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 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 giao dịch mua Super Chat phù hợp với tiêu chí yêu cầu.

Lỗi

Bảng sau đây xác định 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 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 không được uỷ quyền đúng cách để truy xuất các sự kiện Super Chat.

Hãy dùng thử!

Sử dụng APIs Explorer để gọi API này và xem yêu cầu và phản hồi API.