SuperChatEvents

משאב superChatEvent מייצג הודעת סופר צ'אט שמעריץ רכש במהלך שידור חי ב-YouTube. בפיד של הצ'אט בשידור חי ב-YouTube, הודעות סופר צ'אט בולטות יותר מהודעות אחרות בשתי דרכים:

  • הודעות סופר צ'אט מודגשות בצבע.
  • הודעות סופר צ'אט נשארות מוצמדות בטיקר למשך פרק זמן מוגדר.

הצבע של הסופר צ'אט, משך הזמן שהוא מוצמד לטיקר ואורך ההודעה המקסימלי נקבעים לפי סכום הרכישה. מידע נוסף על סופר צ'אטים זמין במרכז העזרה של YouTube.

Methods

ה-API תומך בשיטות הבאות למשאבי superChatEvents:

list
הצגת רשימה של אירועי סופר צ'אט משידורים חיים בערוץ ב-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 מקצה כדי לזהות באופן ייחודי את אירוע הסופר צ'אט.
snippet object
האובייקט snippet מכיל פרטים בסיסיים על אירוע הסופר צ'אט.
snippet.channelId string
מזהה ערוץ YouTube שמזהה את הערוץ שבו שודר השידור החי שמשויך לאירוע הסופר צ'אט.
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
התאריך והשעה שבהם נרכשה הודעת הסופר צ'אט. הערך מצוין בפורמט ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
snippet.amountMicros unsigned long
סכום הרכישה, במיקרו-יחידות של מטבע הרכישה. לדוגמה, אם סכום הרכישה הוא דולר אחד, ערך המאפיין snippet.amountMicros הוא 1000000.
snippet.currency string
המטבע שבו בוצעה הרכישה. הערך הוא קוד מטבע לפי תקן ISO 4217.
snippet.displayString string
מחרוזת, כמו $1.00, שמציגה את סכום הרכישה והמטבע. מחרוזת התצוגה מעוצבת לפי המוסכמות של השפה שצוינה בפרמטר הבקשה hl. כברירת מחדל, מחרוזות התצוגה מעוצבות כמו באנגלית. לדוגמה, כברירת מחדל, מחרוזת מעוצבת כ-$1.00 ולא כ-$1,00.
snippet.messageType unsigned integer
רמת המינוי של ההודעה בתשלום. שימו לב: כשמשאב liveChatMessage מזהה הודעת סופר צ'אט, המאפיין snippet.superChatDetails.tier מכיל את הערך הזה.

הרמה מבוססת על הסכום שהוצא על רכישת ההודעה. הוא גם קובע את הצבע שבו ההודעה תודגש בממשק המשתמש של הצ'אט בשידור חי, את האורך המקסימלי של ההודעה ואת משך הזמן שבו ההודעה תוצמד לשורת ההודעות.

הרמות של סופר צ'אט מתועדות במרכז העזרה של YouTube. (אפשר לעיין בקטע הניתן להרחבה בנושא פרטי הרכישה של סופר צ'אט). ברשימה הזו, רמת המחיר עם סכום הרכישה הנמוך ביותר היא רמה 1, רמת המחיר עם סכום הרכישה הנמוך הבא היא רמה 2 וכן הלאה.
snippet.isSuperStickerEvent ‫boolean
מציין אם מקור המידע הוא Super Sticker, שהוא סוג מסוים של הודעת Super Chat עם תמונה משויכת. אם הערך של השדה הזה הוא true, השדה superStickerMetadata יכיל מידע שאפשר להשתמש בו כדי להציג את התמונה.
snippet.superStickerMetadata object
פרטים על הסופר סטיקר. האובייקט הזה מוחזר רק אם הערך של השדה snippet.isSuperStickerEvent הוא true.
snippet.superStickerMetadata.stickerId string
מזהה ייחודי של תמונת הסטיקר. חשוב לשים לב שהתמונה מוצגת כחלק מההודעה של הסופר סטיקר רק כשמשתמשים צופים בחלון הצ'אט ב-YouTube. עם זאת, כתובת ה-URL של התמונה לא זמינה דרך ה-API. לעיון בלבד, בקובץ ה-CSV הזה מפורטים מזהי הסטיקרים שקשורים לכל אחד מה-Super Stickers.
snippet.superStickerMetadata.altText string
מחרוזת טקסט שמתארת את הסטיקר. השדה snippet.superStickerMetadata.language מזהה את שפת הטקסט. כשקוראים ל-method‏ superChatEvents.list, מגדירים את ערך הפרמטר hl לשפה הרצויה של הטקסט.
snippet.superStickerMetadata.language string
השפה של ערך המאפיין snippet.superStickerMetadata.altText. אם הסופר סטיקר כולל גם טקסט, הטקסט הזה יהיה גם הוא בשפה הזו.