LiveChatBans: insert
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
یک کاربر خاص را از شرکت در چت زنده منع می کند. درخواست API باید توسط مالک کانال یا ناظر چت زنده مرتبط با ممنوعیت مجاز باشد.
موارد استفاده رایج
درخواست کنید
درخواست 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 در این عملیات دو هدف را دنبال می کند. ویژگی هایی را که عملیات نوشتن تنظیم می کند و همچنین ویژگی هایی را که پاسخ API برمی گرداند، شناسایی می کند. مقدار پارامتر را روی snippet تنظیم کنید. |
درخواست بدن
یک منبع liveChatBan در بدنه درخواست ارائه دهید. برای آن منبع:
خطاها
جدول زیر پیام های خطایی را مشخص می کند که API می تواند در پاسخ به تماس با این روش بازگرداند. برای جزئیات بیشتر، 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 برای فراخوانی این API و مشاهده درخواست و پاسخ API استفاده کنید.
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده 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."]]
