يسرد المشرفين على محادثة مباشرة. يجب أن يوافق مالك قناة المحادثة المباشرة على هذا الطلب.
حالات الاستخدام الشائعة
الطلب
طلب HTTP
GET https://www.googleapis.com/youtube/v3/liveChat/moderators
المَعلمات
يسرد الجدول التالي المعلَمات التي يتيحها طلب البحث هذا. كلّ المَعلمات المدرَجة هي مَعلمات طلب بحث.
المَعلمات | ||
---|---|---|
المَعلمات المطلوبة | ||
liveChatId |
string تحدّد المعلَمة liveChatId المحادثة المباشرة في YouTube التي يجب أن تعيد واجهة برمجة التطبيقات تعيين مشرفين لها. يتم عرض معرّف المحادثة المباشرة المرتبط بالبث في السمة snippet.liveChatId لمورد liveBroadcast . |
|
part |
string تحدّد المعلَمة part أجزاء الموارد liveChatModerator التي ستتضمّنها استجابة واجهة برمجة التطبيقات. القيمتان المسموح بإدراجهما هما id وsnippet . |
|
المَعلمات الاختيارية | ||
maxResults |
unsigned integer تحدّد المعلَمة maxResults الحدّ الأقصى لعدد العناصر التي يجب عرضها في مجموعة النتائج. تتراوح القيم المقبولة بين 0 و50 ، بما في ذلك القيم الواقعة بينهما. القيمة التلقائية هي 5 . |
|
pageToken |
string تحدِّد المعلَمة pageToken صفحة معيّنة في مجموعة النتائج يجب عرضها. في استجابة واجهة برمجة التطبيقات، تحدّد السمتان nextPageToken وprevPageToken الصفحات الأخرى التي يمكن استردادها. |
نص الطلب
لا تقدِّم نص طلب عند استدعاء هذه الطريقة.
الإجابة
إذا نجحت هذه الطريقة، ستعرض هذه الطريقة نص استجابة بالبنية التالية:
{ "kind": "youtube#liveChatModeratorListResponse", "etag": etag, "prevPageToken": string, "nextPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ liveChatModerator Resource ] }
أماكن إقامة
يحدد الجدول التالي الخصائص التي تظهر في هذا المورد:
أماكن إقامة | |
---|---|
kind |
string يحدّد نوع مورد واجهة برمجة التطبيقات. ستكون القيمة youtube#liveChatModeratorListResponse . |
etag |
etag علامة هذا المرجع. |
prevPageToken |
string الرمز المميّز الذي يمكن استخدامه كقيمة للمَعلمة pageToken لاسترداد الصفحة السابقة في مجموعة النتائج. |
nextPageToken |
string الرمز المميّز الذي يمكن استخدامه كقيمة للمَعلمة pageToken لاسترداد الصفحة التالية في مجموعة النتائج. |
pageInfo |
object يحتوي الكائن pageInfo على معلومات التقسيم على صفحات لمجموعة النتائج. |
pageInfo.totalResults |
integer إجمالي عدد النتائج في مجموعة النتائج. |
pageInfo.resultsPerPage |
integer عدد النتائج المضمَّنة في ردّ واجهة برمجة التطبيقات |
items[] |
list قائمة للمشرفين الذين يتطابقون مع معايير الطلب. |
الأخطاء
لا تحدّد واجهة برمجة التطبيقات أي رسائل خطأ تكون فريدة في طريقة واجهة برمجة التطبيقات هذه. ومع ذلك، لا يزال من الممكن أن تعرض هذه الطريقة أخطاء واجهة برمجة التطبيقات العامة الواردة في مستندات رسالة الخطأ.
تجربة
يمكنك استخدام APIs Explorer لطلب بيانات من واجهة برمجة التطبيقات هذه والاطّلاع على طلب البيانات من واجهة برمجة التطبيقات والاستجابة لها.