SuperChatEvents

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