SuperChatEvents

Tài nguyên superChatEvent đại diện cho một tin nhắn Super Chat mà người hâm mộ đã mua trong một sự kiện phát trực tiếp trên YouTube. Trong cuộc trò chuyện trực tiếp trên YouTube, Super Chat nổi bật hơn so với các tin nhắn khác theo hai cách:

  • Super Chat được làm nổi bật bằng màu sắc.
  • Super Chat được ghim vào khu vực đầu cuộc trò chuyện trong một khoảng thời gian cố định.

Màu của tin nhắn Super Chat, khoảng thời gian ghim Super Chat vào biểu ngữ và độ dài tin nhắn tối đa đều được xác định bằng số tiền mua. Hãy truy cập vào Trung tâm trợ giúp của YouTube để tìm hiểu thêm về Super Chat.

Phương thức

API hỗ trợ các phương thức sau cho tài nguyên superChatEvents:

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

Biểu diễn tài nguyên

Cấu trúc JSON sau đây cho thấy định dạng của tài nguyên superChatEvent:

{
  "kind": "youtube#superChatEvent",
  "etag": etag,
  "id": string,
  "snippet": {
    "channelId": string,
    "supporterDetails": {
      "channelId": string,
      "channelUrl": string,
      "displayName": string,
      "profileImageUrl": string
    },
    "commentText": string,
    "createdAt": datetime,
    "amountMicros": unsigned long,
    "currency": string,
    "displayString": string,
    "messageType": unsigned integer,
    "isSuperStickerEvent": boolean,
    "superStickerMetadata": {
      "stickerId": string,
      "altText": string,
      "language": string
    }
  }
}

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#superChatEvent.
etag etag
Etag của tài nguyên này.
id string
Mã nhận dạng mà YouTube gán để nhận dạng riêng sự kiện Super Chat.
snippet object
Đối tượng snippet chứa thông tin cơ bản về sự kiện Super Chat.
snippet.channelId string
Mã nhận dạng kênh YouTube giúp xác định kênh phát sóng sự kiện trực tiếp liên kết với sự kiện Super Chat.
snippet.supporterDetails object
Thông tin chi tiết về kênh của người ủng hộ.
snippet.supporterDetails.channelId string
Mã nhận dạng kênh YouTube của người ủng hộ.
snippet.supporterDetails.channelUrl string
URL kênh của người ủng hộ.
snippet.supporterDetails.displayName string
Tên hiển thị kênh của người ủng hộ.
snippet.supporterDetails.profileImageUrl string
URL hình đại diện trên kênh của người ủng hộ.
snippet.commentText string
Nội dung văn bản trong bình luận của người ủng hộ.
snippet.createdAt datetime
Ngày và giờ mua Super Chat. Giá trị được chỉ định theo định dạng ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
snippet.amountMicros unsigned long
Số tiền mua, tính bằng một phần triệu đơn vị tiền tệ của giao dịch mua. Ví dụ: nếu số tiền mua là 1 đô la, thì giá trị thuộc tính snippet.amountMicros1000000.
snippet.currency string
Đơn vị tiền tệ của giao dịch mua hàng. Giá trị là mã đơn vị tiền tệ ISO 4217.
snippet.displayString string
Một chuỗi (chẳng hạn như $1.00) cho biết số tiền mua và đơn vị tiền tệ. Chuỗi hiển thị được định dạng dựa trên quy ước cho ngôn ngữ mà tham số yêu cầu hl chỉ định. Theo mặc định, các chuỗi hiển thị được định dạng giống như 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.
snippet.messageType unsigned integer
Bậc của tin nhắn có tính phí. Xin lưu ý rằng khi một tài nguyên liveChatMessage xác định được một tin nhắn Super Chat thì tài sản snippet.superChatDetails.tier sẽ chứa giá trị này.

Cấp bậc dựa trên số tiền đã chi tiêu để mua tin nhắn đó. Thẻ này cũng sẽ xác định màu dùng để làm nổi bật tin nhắn trong giao diện người dùng của cuộc trò chuyện trực tiếp, thời lượng tin nhắn tối đa và khoảng thời gian ghim tin nhắn.

Các bậc tin nhắn Super Chat được ghi lại trong Trung tâm trợ giúp của YouTube. (Xem phần có thể mở rộng về thông tin chi tiết về giao dịch mua Super Chat.) Trong danh sách đó, cấp có mức mua thấp nhất là cấp 1, cấp thấp nhất tiếp theo là cấp 2, v.v.
snippet.isSuperStickerEvent boolean
Cho biết tài nguyên đó có phải là Super Stickers hay không. Đây là một loại tin nhắn Super Chat cụ thể có hình ảnh liên kết. Nếu giá trị của trường này là true, thì trường superStickerMetadata sẽ chứa thông tin có thể dùng để hiển thị hình ảnh.
snippet.superStickerMetadata object
Thông tin chi tiết về Hình dán đặc biệt. Đối tượng này chỉ được trả về nếu giá trị của trường snippet.isSuperStickerEventtrue.
snippet.superStickerMetadata.stickerId string
Mã nhận dạng duy nhất xác định hình dán. Xin lưu ý rằng hình ảnh này chỉ xuất hiện trong tin nhắn Super Stickers khi người dùng xem cửa sổ trò chuyện trên YouTube. Tuy nhiên, URL hình ảnh không có sẵn thông qua API. Chỉ để tham khảo, bạn có thể tìm thấy mã hình dán liên quan đến Super Stickers nào trong tệp CSV này.
snippet.superStickerMetadata.altText string
Chuỗi văn bản mô tả hình dán. Trường snippet.superStickerMetadata.language xác định ngôn ngữ của văn bản. Khi gọi phương thức superChatEvents.list, hãy đặt giá trị tham số hl thành ngôn ngữ mong muốn cho văn bản.
snippet.superStickerMetadata.language string
Ngôn ngữ của giá trị thuộc tính snippet.superStickerMetadata.altText. Nếu Super Stickers cũng hiển thị một văn bản nào đó thì văn bản đó cũng hiển thị bằng ngôn ngữ đó.