SuperChatEvents

ทรัพยากร superChatEvent แสดงถึงข้อความ Super Chat ที่แฟนๆ ซื้อระหว่างการไลฟ์สดบน YouTube ในแชทสดของ YouTube ข้อความ Super Chat จะโดดเด่นกว่าข้อความอื่นๆ 2 ลักษณะดังนี้

  • Super Chat จะไฮไลต์ด้วยสี
  • Super Chat จะปักหมุดไว้ในแถบเลื่อนตามระยะเวลาที่กำหนด

สีของ Super Chat, ระยะเวลาที่ปักหมุดไว้ในทิกเกอร์ และความยาวสูงสุดของข้อความทั้งหมดจะกำหนดโดยยอดรวมการซื้อ ดูข้อมูลเพิ่มเติมเกี่ยวกับ Super Chat ได้ที่ศูนย์ช่วยเหลือของ YouTube

เมธอด

API รองรับเมธอดต่อไปนี้สำหรับทรัพยากร superChatEvents

list
แสดงรายการเหตุการณ์ Super Chat จากการไลฟ์สดของช่องในช่วง 30 วันที่ผ่านมา ลองใช้เลย

การแสดงทรัพยากร

โครงสร้าง 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 Sticker ซึ่งเป็นข้อความ Super Chat ประเภทหนึ่งที่มีรูปภาพที่เชื่อมโยง หากค่าของฟิลด์นี้เป็น true ฟิลด์ superStickerMetadata จะมีข้อมูลที่ใช้แสดงรูปภาพได้
snippet.superStickerMetadata object
รายละเอียดเกี่ยวกับ Super Sticker ระบบจะแสดงผลออบเจ็กต์นี้ก็ต่อเมื่อค่าของฟิลด์ snippet.isSuperStickerEvent เป็น true
snippet.superStickerMetadata.stickerId string
รหัสที่ไม่ซ้ำกันที่ระบุรูปภาพสติกเกอร์ โปรดทราบว่าระบบจะแสดงรูปภาพเป็นส่วนหนึ่งของข้อความ Super Sticker เท่านั้นเมื่อผู้ใช้ดูหน้าต่างแชทบน YouTube อย่างไรก็ตาม URL ของรูปภาพจะไม่พร้อมใช้งานผ่าน API คุณสามารถดูรหัสสติกเกอร์ที่เกี่ยวข้องกับ Super Sticker ใดได้ใน ไฟล์ CSV นี้เพื่อใช้อ้างอิงเท่านั้น
snippet.superStickerMetadata.altText string
สตริงข้อความที่อธิบายสติกเกอร์ ฟิลด์ snippet.superStickerMetadata.language ระบุภาษาของข้อความ เมื่อเรียกใช้เมธอด superChatEvents.list ให้ตั้งค่าพารามิเตอร์ hl เป็นภาษาที่ต้องการสำหรับข้อความ
snippet.superStickerMetadata.language string
ภาษาของค่าพร็อพเพอร์ตี้ snippet.superStickerMetadata.altText หาก Super Sticker แสดงข้อความใดๆ ข้อความนั้นจะเป็นภาษานี้ด้วย