حظر مستخدم معيّن من المشاركة في الدردشة المباشرة يجب أن يكون طلب البيانات من واجهة برمجة التطبيقات معتمَدًا من مالك القناة أو المشرف على المحادثة المباشرة المرتبطة بالحظر.
حالات الاستخدام الشائعة
الطلب
طلب HTTP
POST https://www.googleapis.com/youtube/v3/liveChat/bans
التفويض
يتطلب هذا الطلب تفويضًا باستخدام نطاق واحد على الأقل من النطاقات التالية (مزيد من المعلومات عن المصادقة والترخيص).
النطاق |
---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
المَعلمات
يسرد الجدول التالي المعلَمات التي يتيحها طلب البحث هذا. كلّ المَعلمات المدرَجة هي مَعلمات طلب بحث.
المَعلمات | ||
---|---|---|
المَعلمات المطلوبة | ||
part |
string تُستخدم المعلَمة part لغرضَين في هذه العملية. وتحدّد هذه السمة الخصائص التي ستضبطها عملية الكتابة بالإضافة إلى الخصائص التي تعرضها استجابة واجهة برمجة التطبيقات. اضبط قيمة المعلَمة على snippet . |
نص الطلب
وفِّر مورد LiveChatBan في نص الطلب. بالنسبة لهذا المورد:
-
يجب تحديد قيمة لهذه السمات:
snippet.liveChatId
snippet.type
snippet.bannedUserDetails.channelId
-
ويمكنك ضبط قيم لهذه المواقع الإلكترونية:
snippet.banDurationSeconds
الإجابة
في حال نجاحها، تعرض هذه الطريقة مورد LiveChatBan في نص الاستجابة.
الأخطاء
يحدّد الجدول التالي رسائل الخطأ التي يمكن أن تعرضها واجهة برمجة التطبيقات استجابةً لطلب بيانات إلى هذه الطريقة. يُرجى الاطّلاع على وثائق رسالة الخطأ للحصول على مزيد من التفاصيل.
نوع الخطأ | تفاصيل الخطأ | الوصف |
---|---|---|
forbidden (403) |
insufficientPermissions |
ليس لديك الأذونات اللازمة لحظر مستخدم من المحادثة المباشرة المحدّدة. |
forbidden (403) |
liveChatBanInsertionNotAllowed |
يتعذّر إنشاء الحظر المحدّد. يمكن أن يحدث هذا الخطأ إذا حاول الطلب حظر مالك المحادثة أو مشرف آخر. |
invalidValue (400) |
invalidChannelId |
يتعذر العثور على معرّف القناة المحدد. |
invalidValue (400) |
invalidLiveChatId |
قيمة snippet.liveChatId المحدّدة في الطلب غير صالحة. راجِع مورد liveBroadcast المرتبط للتأكّد من أنّ لديك القيمة الصحيحة. |
notFound (404) |
liveChatNotFound |
تعذّر العثور على المحادثة المباشرة المحدّدة. راجِع مورد liveBroadcast المرتبط لضمان ضبط السمة snippet.liveChatId على القيمة الصحيحة. |
notFound (404) |
liveChatUserNotFound |
لا يمكن العثور على مستخدم المحادثة المباشرة الذي تحاول حظره. |
required (400) |
bannedUserChannelIdRequired |
يجب أن يحدّد مورد liveChatBan المُرسَل في نص الطلب قيمة للسمة snippet.bannedUserDetails.channelId . |
required (400) |
liveChatIdRequired |
يجب أن يحدّد مورد liveChatBan المُرسَل في نص الطلب قيمة للسمة snippet.liveChatId . |
تجربة
يمكنك استخدام APIs Explorer لطلب بيانات من واجهة برمجة التطبيقات هذه والاطّلاع على طلب البيانات من واجهة برمجة التطبيقات والاستجابة لها.