تعرض هذه الطريقة قائمة بالمشرفين على محادثة مباشرة. يجب أن يكون الطلب مأذونًا به من قِبل مالك قناة المحادثة المباشرة.
حالات الاستخدام الشائعة
طلب
طلب 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علامة Etag لهذا المرجع. |
prevPageToken |
stringالرمز المميّز الذي يمكن استخدامه كقيمة للمَعلمة pageToken لاسترداد الصفحة السابقة في مجموعة النتائج. |
nextPageToken |
stringالرمز المميّز الذي يمكن استخدامه كقيمة للمَعلمة pageToken لاسترداد الصفحة التالية في مجموعة النتائج. |
pageInfo |
objectيغلّف مرجع pageInfo معلومات تقسيم الصفحات لمجموعة النتائج. |
pageInfo.totalResults |
integerإجمالي عدد النتائج في مجموعة النتائج. |
pageInfo.resultsPerPage |
integerعدد النتائج المضمّنة في استجابة واجهة برمجة التطبيقات. |
items[] |
listقائمة بالمشرفين الذين يستوفون معايير الطلب. |
الأخطاء
لا تحدّد واجهة برمجة التطبيقات أي رسائل خطأ فريدة لطريقة واجهة برمجة التطبيقات هذه. ومع ذلك، قد تعرض هذه الطريقة أخطاء عامة في واجهة برمجة التطبيقات مدرَجة في مستندات رسائل الخطأ.
جرِّبها الآن.
استخدِم APIs Explorer لاستدعاء واجهة برمجة التطبيقات هذه والاطّلاع على طلب بيانات من واجهة برمجة التطبيقات واستجابتها.