ทรัพยากรของ superChatEvent
แสดงถึงข้อความ Super Chat ที่แฟนๆ ซื้อระหว่างสตรีมแบบสดบน YouTube Super Chat จะโดดเด่นกว่าข้อความอื่นๆ ใน 2 วิธีต่อไปนี้ในสตรีมแชทสดของ YouTube
- Super Chat จะไฮไลต์ด้วยสี
- Super Chat จะปักหมุดไว้ในทิกเกอร์ในระยะเวลาหนึ่ง
สีของ Super Chat ระยะเวลาที่ปักหมุดไว้ในทิกเกอร์ และความยาวสูงสุดของข้อความจะกําหนดโดยยอดรวมการซื้อ ดูข้อมูลเพิ่มเติมเกี่ยวกับ Super Chat ได้ในศูนย์ช่วยเหลือของ YouTube
วิธีการ
API รองรับวิธีต่อไปนี้สําหรับทรัพยากร superChatEvents
รายการ
การนําเสนอแหล่งข้อมูล
โครงสร้าง JSON ต่อไปนี้แสดงรูปแบบทรัพยากร 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 } } }
พร็อพเพอร์ตี้
ตารางต่อไปนี้กําหนดพร็อพเพอร์ตี้ที่ปรากฏในทรัพยากรนี้
พร็อพเพอร์ตี้ | |
---|---|
kind |
string ระบุประเภทของทรัพยากร API ค่านี้จะเป็น youtube#superChatEvent |
etag |
etag Etag ของทรัพยากรนี้ |
id |
string รหัสที่ YouTube กําหนดเพื่อระบุกิจกรรม Super Chat ที่ไม่ซ้ํากัน |
snippet |
object ออบเจ็กต์ snippet มีรายละเอียดพื้นฐานเกี่ยวกับเหตุการณ์ Super Chat |
snippet.channelId |
string รหัสช่อง YouTube ที่ระบุช่องที่ออกอากาศสตรีมแบบสดซึ่งเกี่ยวข้องกับกิจกรรม Super Chat |
snippet.supporterDetails |
object รายละเอียดเกี่ยวกับช่องของผู้สนับสนุน |
snippet.supporterDetails.channelId |
string รหัสช่อง YouTube ของผู้สนับสนุน |
snippet.supporterDetails.channelUrl |
string URL ช่องของผู้สนับสนุน |
snippet.supporterDetails.displayName |
string ชื่อที่แสดงของช่องของผู้สนับสนุน |
snippet.supporterDetails.profileImageUrl |
string URL รูปโปรไฟล์สําหรับช่องของผู้สนับสนุน |
snippet.commentText |
string เนื้อหาข้อความในความคิดเห็นของผู้สนับสนุน |
snippet.createdAt |
datetime วันที่และเวลาที่ซื้อ Super Chat ค่านี้ระบุในรูปแบบ ISO 8601 ( YYYY-MM-DDThh:mm:ss.sZ ) |
snippet.amountMicros |
unsigned long ยอดรวมการซื้อในหน่วยไมโครของสกุลเงินในการซื้อ ตัวอย่างเช่น หากยอดรวมการซื้อคือ 1 ดอลลาร์ ค่าพร็อพเพอร์ตี้ snippet.amountMicros จะเป็น 1000000 |
snippet.currency |
string สกุลเงินที่ทําการซื้อ ค่าคือรหัสสกุลเงิน ISO 4217 |
snippet.displayString |
string สตริง เช่น $1.00 ที่แสดงยอดรวมการซื้อและสกุลเงิน สตริงที่แสดงได้รับการจัดรูปแบบตามแบบแผนสําหรับภาษาที่ระบุโดยพารามิเตอร์คําขอ hl โดยค่าเริ่มต้น รูปแบบสตริงที่แสดงจะเป็นภาษาอังกฤษ เช่น โดยค่าเริ่มต้น สตริงจะมีรูปแบบเป็น $1.00 แทนที่จะเป็น $1,00 |
snippet.messageType |
unsigned integer ระดับของข้อความที่เสียค่าใช้จ่าย โปรดทราบว่าเมื่อทรัพยากร liveChatMessage ระบุข้อความ Super Chat พร็อพเพอร์ตี้ snippet.superChatDetails.tier จะมีค่านี้ระดับจะขึ้นอยู่กับจํานวนเงินที่ใช้ในการซื้อข้อความ นอกจากนี้ยังกําหนดสีที่ใช้ไฮไลต์ข้อความใน UI ของแชทสด ความยาวสูงสุดของข้อความ และระยะเวลาที่ข้อความปักหมุดบนทิกเกอร์ ระดับ Super Chat มีข้อมูลอยู่ในศูนย์ช่วยเหลือของ YouTube (ดูส่วนที่ขยายได้เกี่ยวกับรายละเอียดการซื้อ Super Chat) ในรายการดังกล่าว ระดับที่มีการซื้อต่ําสุดคือระดับ 1 ส่วนระดับต่ําสุดลําดับถัดไปคือระดับ 2 เป็นต้น |
snippet.isSuperStickerEvent |
boolean ระบุว่าทรัพยากรเป็น Super Stickers หรือไม่ ซึ่งเป็นข้อความประเภท Super Chat ที่เฉพาะเจาะจงซึ่งมีรูปภาพที่เกี่ยวข้อง หากค่าของช่องนี้คือ true ช่อง superStickerMetadata จะมีข้อมูลที่สามารถใช้เพื่อแสดงรูปภาพ |
snippet.superStickerMetadata |
object รายละเอียดเกี่ยวกับ Super Stickers ออบเจ็กต์นี้จะส่งคืนเฉพาะในกรณีที่ค่าของช่อง snippet.isSuperStickerEvent คือ true |
snippet.superStickerMetadata.stickerId |
string รหัสที่ไม่ซ้ํากันซึ่งระบุรูปภาพสติกเกอร์ โปรดทราบว่ารูปภาพจะแสดงเป็นส่วนหนึ่งของข้อความ Super Stickers เท่านั้นเมื่อผู้ใช้ดูหน้าต่างแชทใน YouTube แต่ URL รูปภาพจะไม่พร้อมใช้งานผ่าน API |
snippet.superStickerMetadata.altText |
string สตริงข้อความที่อธิบายสติกเกอร์ ช่อง snippet.superStickerMetadata.language จะระบุภาษาของข้อความ เมื่อเรียกใช้เมธอด superChatEvents.list ให้ตั้งค่าค่าพารามิเตอร์ hl เป็นภาษาที่ต้องการสําหรับข้อความ |
snippet.superStickerMetadata.language |
string ภาษาของค่าพร็อพเพอร์ตี้ snippet.superStickerMetadata.altText หาก Super Stickers แสดงข้อความใดๆ ข้อความนั้นจะอยู่ในภาษานั้นด้วย |