LiveChatBans: insert
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
يحظِر مستخدمًا معيّنًا من المشاركة في المحادثة المباشرة. يجب أن يكون طلب البيانات من واجهة برمجة التطبيقات مفوَّضًا من قِبل مالك القناة أو مشرف المحادثة المباشرة المرتبطة بالحظر.
حالات الاستخدام الشائعة
الطلب
طلب HTTP
POST https://www.googleapis.com/youtube/v3/liveChat/bans
التفويض
يتطلب هذا الطلب تفويضًا بنطاق واحد على الأقل من النطاقات التالية. للاطّلاع على مزيد من المعلومات
حول المصادقة والتفويض، اطّلِع على مقالة
تنفيذ مصادقة OAuth 2.0.
| النطاق |
|---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
المعلمات
يعرض الجدول التالي المَعلمات التي يتيح طلب البحث استخدامها. جميع المَعلمات المُدرَجة هي مَعلمات طلب بحث.
| المعلمات |
| المَعلمات المطلوبة |
part |
string
تخدم المَعلمة part غرضَين في هذه العملية. ويحدِّد السمات التي ستضبطها عملية الكتابة بالإضافة إلى السمات التي تعرضها استجابة واجهة برمجة التطبيقات. اضبط قيمة المَعلمة على snippet. |
نص الطلب
قدِّم مرجعًا لميزة "حظر المحادثة المباشرة" في نص الطلب.
بالنسبة إلى هذا المرجع:
الردّ
إذا كانت الاستجابة ناجحة، تعرض هذه الطريقة مورد liveChatBan في نص الاستجابة.
الأخطاء
يحدِّد الجدول التالي رسائل الخطأ التي يمكن أن تعرِضها واجهة برمجة التطبيقات استجابةً لطلب موجَّه إلى هذه الطريقة. لمزيد من التفاصيل، يُرجى الاطّلاع على YouTube Live Streaming API - Errors.
| نوع الخطأ |
تفاصيل الخطأ |
الوصف |
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 للاتّصال بهذه الواجهة والاطّلاع على طلب البيانات والاستجابة من واجهة برمجة التطبيقات.
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2025-01-02 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2025-01-02 (حسب التوقيت العالمي المتفَّق عليه)"],[],[],null,["# LiveChatBans: insert\n\nBans a specific user from participating in the live chat. The API request must be authorized by the channel owner or a moderator of the live chat associated with the ban.\n\nCommon use cases\n----------------\n\nThe list below shows common use cases for this method. Hover over a use case to see its description, or click on a use case to load sample parameter values in the APIs Explorer. You can open the [fullscreen APIs Explorer](#) to see code samples that dynamically update to reflect the parameter values entered in the Explorer.\n\nThe table below shows common use cases for this method. You can click on a use case name to load sample parameter values in the APIs Explorer. Or you can see code samples for a use case in the fullscreen APIs Explorer by clicking on the code icon below a use case name. In the fullscreen UI, you can update parameter and property values and the code samples will dynamically update to reflect the values you enter. \nThis method has one common use case, which is described below. The buttons below the description populate the APIs Explorer with sample values or open the fullscreen APIs Explorer to show code samples that use those values. The code samples also dynamically update if you change the values.\n\n\u003cbr /\u003e\n\nRequest\n-------\n\n### HTTP request\n\n```\nPOST https://www.googleapis.com/youtube/v3/liveChat/bans\n```\n\n### Authorization\n\nThis request requires authorization with at least one of the following scopes. To read more\nabout authentication and authorization, see\n[Implementing OAuth 2.0 authentication](/youtube/v3/live/authentication).\n\n| Scope |\n|-----------------------------------------------------|\n| `https://www.googleapis.com/auth/youtube` |\n| `https://www.googleapis.com/auth/youtube.force-ssl` |\n\n### Parameters\n\nThe following table lists the parameters that this query supports. All of the parameters listed are query parameters.\n\n| Parameters ||\n|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| **Required parameters** |||\n| `part` | `string` The **part** parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response returns. Set the parameter value to `snippet`. |\n\n### Request body\n\nProvide a [liveChatBan resource](/youtube/v3/live/docs/liveChatBans#resource) in the request body.\nFor that resource:\n\n- You must specify a value for these properties:\n\n \u003cbr /\u003e\n\n - `snippet.liveChatId`\n - `snippet.type`\n - `snippet.bannedUserDetails.channelId`\n\n \u003cbr /\u003e\n\n- You can set values for these properties:\n\n \u003cbr /\u003e\n\n - `snippet.banDurationSeconds`\n\n \u003cbr /\u003e\n\nResponse\n--------\n\nIf successful, this method returns a [liveChatBan resource](/youtube/v3/live/docs/liveChatBans#resource) in the response body.\n\nErrors\n------\n\nThe following table identifies error messages that the API could return in response to a call to this method. For more details, see [YouTube Live Streaming API - Errors](/youtube/v3/live/docs/errors).\n\n| Error type | Error detail | Description |\n|----------------------|----------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `forbidden (403)` | `insufficientPermissions` | You do not have the necessary permissions to ban a user from the specified live chat. |\n| `forbidden (403)` | `liveChatBanInsertionNotAllowed` | The specified ban cannot be created. This error can occur if the request attempts to ban the chat owner or another moderator. |\n| `invalidValue (400)` | `invalidChannelId` | The specified channel ID cannot be found. |\n| `invalidValue (400)` | `invalidLiveChatId` | The `snippet.liveChatId` value specified in the request is invalid. Check the associated `liveBroadcast` resource to ensure that you have the correct value. |\n| `notFound (404)` | `liveChatNotFound` | The specified live chat cannot be found. Check the associated `liveBroadcast` resource to ensure that you are setting the `snippet.liveChatId` property to the correct value. |\n| `notFound (404)` | `liveChatUserNotFound` | The live chat user you are trying to ban cannot be found. |\n| `required (400)` | `bannedUserChannelIdRequired` | The `liveChatBan` resource submitted in the request body must specify a value for the `snippet.bannedUserDetails.channelId` property. |\n| `required (400)` | `liveChatIdRequired` | The `liveChatBan` resource submitted in the request body must specify a value for the `snippet.liveChatId` property. |\n\nTry it!\n-------\n\nUse the APIs Explorer to call this API and see the API request and response."]]
