דף זה תורגם על ידי Cloud Translation API.

SuperChatEvents

משאב superChatEvent מייצג הודעת Super Chat שנרכשה על ידי מעריץ במהלך שידור חי ב-YouTube. בזמן השידור החי ב-YouTube, הודעות ה-Super Chat מובלטות בשתי דרכים:

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

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

שיטות

ה-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` התאריך והשעה שבהם נרכש הסופר צ'אט. הערך מצוין בפורמט 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` מכיל את הערך הזה. הרמה מבוססת על סכום הכסף שהוצאת כדי לרכוש את ההודעה. ההגדרה גם קובעת את הצבע שישמש להדגשת ההודעה בממשק המשתמש של הצ'אט בשידור חי, את האורך המקסימלי של ההודעה ואת משך הזמן שבו ההודעה מוצמדת. אפשר למצוא מידע על רמות ה-Super Chat במרכז העזרה של YouTube. (ניתן לעיין בקטע הניתן להרחבה של פרטי הרכישות בסופר צ'אט). ברשימה הזו, הרמה עם סכום הרכישה הנמוך ביותר היא רמה 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. לידיעתך, בקובץ ה-CSV הזה אפשר למצוא אילו מזהי סטיקרים קשורים לכל אחד מסוגי ה-Super Stickers.
`snippet.superStickerMetadata.altText`	`string` מחרוזת טקסט שמתארת את הסטיקר. השדה `snippet.superStickerMetadata.language` מזהה את שפת הטקסט. כשמפעילים את השיטה `superChatEvents.list`, מגדירים את ערך הפרמטר hl לשפה הרצויה של הטקסט.
`snippet.superStickerMetadata.language`	`string` השפה של ערך המאפיין `snippet.superStickerMetadata.altText`. אם מוצג גם טקסט כלשהו ב-Super Sticker, הטקסט הזה יופיע גם בשפה הזו.