SuperChatEvents

يمثّل مرجع superChatEvent رسالة Super Chat اشتراها أحد المعجبين خلال بث مباشر على YouTube. في المحادثة المباشرة على YouTube، تبرز رسائل Super Chat عن الرسائل الأخرى بطريقتَين:

• يتم تمييز رسائل Super Chat بلون.
• تبقى رسائل Super Chat مثبّتة في شريط التمرير لفترة زمنية محدّدة.

يتم تحديد لون رسالة Super Chat والفترة الزمنية التي تبقى فيها مثبّتة في شريط التمرير والحد الأقصى لطول الرسالة استنادًا إلى مبلغ الشراء. يمكنكم الاطّلاع على مركز مساعدة YouTube لمزيد من المعلومات حول رسائل Super Chat.

الطُرق

تتيح واجهة برمجة التطبيقات الطرق التالية لمراجع 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 يحدّد نوع مرجع واجهة برمجة التطبيقات. ستكون القيمة 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 مبلغ الشراء بوحدات الميكرو من عملة الشراء. على سبيل المثال، إذا كان مبلغ الشراء دولارًا واحدًا، تكون قيمة السمة 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 على هذه القيمة. تستند الفئة إلى مبلغ المال الذي تم إنفاقه لشراء الرسالة. تحدّد الفئة أيضًا اللون المستخدَم لتمييز الرسالة في واجهة المحادثة المباشرة، والحد الأقصى لطول الرسالة، والمدة الزمنية التي يتم فيها تثبيت الرسالة في شريط التمرير. تم توثيق فئات Super Chat في مركز مساعدة YouTube. (يمكنكم الاطّلاع على القسم القابل للتوسيع حول تفاصيل شراء Super Chat.) في تلك القائمة، تكون الفئة التي تتضمّن أقل مبلغ شراء هي الفئة 1، والفئة التي تتضمّن المبلغ الأقل التالي هي الفئة 2، وهكذا.
snippet.isSuperStickerEvent	boolean يشير إلى ما إذا كان المرجع "ملصقًا عجيبًا"، وهو نوع معيّن من رسائل Super Chat يتضمّن صورة مرتبطة به. إذا كانت قيمة هذا الحقل true، سيحتوي الحقل superStickerMetadata على معلومات يمكن استخدامها لعرض الصورة.
snippet.superStickerMetadata	object تفاصيل حول Super Stickers. لا يتم عرض هذا الكائن إلا إذا كانت قيمة الحقل snippet.isSuperStickerEvent هي true.
snippet.superStickerMetadata.stickerId	string معرّف فريد يحدّد صورة الملصق. ملاحظة: لا يتم عرض الصورة إلا كجزء من رسالة Super Stickers عندما يعرض المستخدمون نافذة المحادثة على YouTube. ومع ذلك، لا يتوفّر عنوان URL للصورة من خلال واجهة برمجة التطبيقات. للعلم فقط، يمكنكم الاطّلاع على معرّفات الملصقات المرتبطة بـ "Super Stickers" في ملف CSV هذا.
snippet.superStickerMetadata.altText	string سلسلة نصية تصف الملصق. يحدّد الحقل snippet.superStickerMetadata.language لغة النص. عند استدعاء طريقة superChatEvents.list، اضبطوا قيمة المَعلمة hl على اللغة المطلوبة للنص.
snippet.superStickerMetadata.language	string لغة قيمة السمة snippet.superStickerMetadata.altText. إذا كان Super Stickers يعرض أي نص أيضًا، فسيكون هذا النص بهذه اللغة أيضًا.