Tài nguyên superChatEvent đại diện cho một tin nhắn Super Chat do người hâm mộ mua trong một sự kiện phát trực tiếp trên YouTube. Trong luồng Trò chuyện trong sự kiện phát trực tiếp trên YouTube, Super Chat nổi bật hơn các tin nhắn khác theo hai cách:
- Super Chat được làm nổi bật bằng một màu.
- Super Chat được ghim trong bảng thông báo trong một khoảng thời gian cố định.
Màu của Super Chat, khoảng thời gian Super Chat được ghim trong bảng thông báo và độ dài tối đa của tin nhắn đều được xác định theo số tiền mua. Hãy xem Trung tâm trợ giúp của YouTube để tìm hiểu thêm về Super Chat.
Phương thức
API này hỗ trợ các phương thức sau đây cho tài nguyên superChatEvents:
Cách trình bày 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 |
stringXác định loại tài nguyên API. Giá trị sẽ là youtube#superChatEvent. |
etag |
etagEtag của tài nguyên này. |
id |
stringMã nhận dạng mà YouTube chỉ định để xác định duy nhất 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 |
stringMã nhận dạng kênh YouTube xác định kênh phát sự kiện phát trực tiếp được liên kết với sự kiện Super Chat. |
snippet.supporterDetails |
objectThông tin chi tiết về kênh của người ủng hộ. |
snippet.supporterDetails.channelId |
stringMã nhận dạng kênh YouTube của người ủng hộ. |
snippet.supporterDetails.channelUrl |
stringURL của kênh của người ủng hộ. |
snippet.supporterDetails.displayName |
stringTên hiển thị của kênh của người ủng hộ. |
snippet.supporterDetails.profileImageUrl |
stringURL hình đại diện của kênh của người ủng hộ. |
snippet.commentText |
stringNội dung văn bản trong bình luận của người ủng hộ. |
snippet.createdAt |
datetimeNgày và giờ mua Super Chat. Giá trị được chỉ định ở định dạng ISO 8601 ( YYYY-MM-DDThh:mm:ss.sZ). |
snippet.amountMicros |
unsigned longSố tiền mua, tính bằng micro của đơn vị tiền tệ mua. Ví dụ: nếu số tiền mua là 1 đô la, thì giá trị thuộc tính snippet.amountMicros là 1000000. |
snippet.currency |
stringĐơn vị tiền tệ dùng để mua. Giá trị là mã tiền tệ ISO 4217. |
snippet.displayString |
stringMộ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 về ngôn ngữ được chỉ định theo tham số yêu cầu hl. Theo mặc định, chuỗi hiển thị được định dạ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 integerCấp cho tin nhắn trả phí. Xin lưu ý rằng khi tài nguyên liveChatMessage xác định một tin nhắn Super Chat, thuộc tính snippet.superChatDetails.tier sẽ chứa giá trị này.Cấp dựa trên số tiền chi tiêu để mua tin nhắn. Cấp này cũng xác định màu dùng để làm nổi bật tin nhắn trong giao diện người dùng Trò chuyện trong sự kiện phát trực tiếp, độ dài tối đa của tin nhắn và khoảng thời gian tin nhắn được ghim trong đầu cuộc trò chuyện. Các cấp 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ó số tiền mua thấp nhất là cấp 1, số tiền thấp tiếp theo là cấp 2, v.v. |
snippet.isSuperStickerEvent |
booleanCho biết liệu tài nguyên có phải là Hình dán đặc biệt hay không. Đây là một loại tin nhắn Super Chat cụ thể có hình ảnh được 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 |
objectThông tin chi tiết về Super Stickers. Đối tượng này chỉ được trả về nếu giá trị của trường snippet.isSuperStickerEvent là true. |
snippet.superStickerMetadata.stickerId |
stringMã nhận dạng duy nhất xác định hình ảnh hình dán. Xin lưu ý rằng hình ảnh 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ã nhận dạng hình dán liên quan đến Super Stickers nào trong tệp CSV này. |
snippet.superStickerMetadata.altText |
stringMột 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 |
stringNgôn ngữ của giá trị thuộc tính snippet.superStickerMetadata.altText. Nếu Super Stickers cũng hiển thị văn bản, thì văn bản đó cũng ở ngôn ngữ này. |