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