SuperChatEvents: list

عرض أحداث Super Chat من أحداث البث المباشر للقناة خلال آخر 30 يومًا

حالات الاستخدام الشائعة

الطلب

طلب HTTP

GET https://www.googleapis.com/youtube/v3/superChatEvents

التفويض

يتطلب هذا الطلب تفويضًا بنطاق واحد على الأقل من النطاقات التالية. للاطّلاع على مزيد من المعلومات عن المصادقة والتفويض، يُرجى الاطّلاع على مقالة تنفيذ مصادقة OAuth 2.0.

النطاق
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtube.readonly

المعلمات

يعرض الجدول التالي المَعلمات التي يتيح طلب البحث استخدامها. جميع المَعلمات المُدرَجة هي مَعلمات طلب بحث.

المعلمات
المَعلمات المطلوبة
part string
تُحدِّد المَعلمة part أجزاء المَعلمة superChatEvent التي سيتضمّنها استجابة واجهة برمجة التطبيقات. القيم المسموح بها هي id وsnippet.
المَعلمات الاختيارية
hl string
تُوجّه المَعلمة hl خادم واجهة برمجة التطبيقات لتنسيق قيمة السمة snippet.displayString التي تعرض مبلغ الشراء وعملته في Super Chat وفقًا لقواعد لغة معيّنة. يجب أن تكون قيمة المَعلمة رمز لغة مُدرَجًا في القائمة التي تُعرِضها الطريقة i18nLanguages.list. القيمة التلقائية هي en، ما يعني أنّ السلوك التلقائي هو تنسيق سلاسل العرض على النحو الذي سيتم استخدامه باللغة الإنجليزية. على سبيل المثال، يتم تلقائيًا تنسيق سلسلة على النحو التالي: $1.00 بدلاً من $1,00.
maxResults unsigned integer
تحدِّد المَعلمة maxResults الحد الأقصى لعدد العناصر التي يجب عرضها في مجموعة النتائج. القيم المقبولة هي من 1 إلى 50. تكون القيمة التلقائية 5.
pageToken string
تُحدِّد المَعلمة pageToken صفحة معيّنة في مجموعة النتائج التي يجب عرضها. في استجابة واجهة برمجة التطبيقات، تحدِّد السمتَان nextPageToken وprevPageToken الصفحات الأخرى التي يمكن استرجاعها.

نص الطلب

لا تقدِّم محتوى طلب عند استدعاء هذه الطريقة.

الردّ

إذا كانت الاستجابة ناجحة، تعرض هذه الطريقة نص استجابة بالبنية التالية:

{
  "kind": "youtube#superChatEventListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    superChatEvent resource
  ]
}

أماكن إقامة

يحدِّد الجدول التالي السمات التي تظهر في هذا المرجع:

أماكن إقامة
kind string
لتحديد نوع مورد واجهة برمجة التطبيقات. ستكون القيمة youtube#superChatEventListResponse.
etag etag
رقم تعريف Etag لهذا المورد.
nextPageToken string
الرمز المميّز الذي يمكن استخدامه كقيمة للمَعلمة pageToken لاسترداد الصفحة التالية في مجموعة النتائج
pageInfo object
يُحاط عنصر pageInfo بمعلومات الفهرسة لمجموعة النتائج.
pageInfo.totalResults integer
إجمالي عدد النتائج في مجموعة النتائج.
pageInfo.resultsPerPage integer
عدد النتائج المضمّنة في ردّ واجهة برمجة التطبيقات
items[] list
قائمة بعمليات شراء رسائل Super Chat التي تتطابق مع معايير الطلب

الأخطاء

يحدِّد الجدول التالي رسائل الخطأ التي يمكن أن تعرِضها واجهة برمجة التطبيقات استجابةً لطلب موجَّه إلى هذه الطريقة. يُرجى الاطّلاع على مستندات رسالة الخطأ للحصول على مزيد من التفاصيل.

نوع الخطأ تفاصيل الخطأ الوصف
forbidden (403) insufficientPermissions الطلب غير مفوَّض بشكل صحيح لاسترداد أحداث Super Chat.

جرّب الآن

استخدِم APIs Explorer لطلب بيانات من واجهة برمجة التطبيقات هذه والاطّلاع على طلب البيانات والاستجابة.