یک کاربر خاص را از شرکت در چت زنده منع می کند. درخواست API باید توسط مالک کانال یا ناظر چت زنده مرتبط با ممنوعیت مجاز باشد.
موارد استفاده رایج
درخواست
درخواست 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 در این عملیات دو هدف را دنبال می کند. ویژگی هایی را که عملیات نوشتن تنظیم می کند و همچنین ویژگی هایی را که پاسخ API برمی گرداند، شناسایی می کند. مقدار پارامتر را روی snippet تنظیم کنید. | |
درخواست بدن
یک منبع liveChatBan در بدنه درخواست ارائه دهید. برای آن منبع:
شما باید یک مقدار برای این ویژگی ها مشخص کنید:
-
snippet.liveChatId -
snippet.type -
snippet.bannedUserDetails.channelId
-
شما می توانید مقادیری را برای این ویژگی ها تنظیم کنید:
-
snippet.banDurationSeconds
-
واکنش
در صورت موفقیت آمیز بودن، این روش یک منبع liveChatBan را در بدنه پاسخ برمی گرداند.
خطاها
جدول زیر پیام های خطایی را مشخص می کند که API می تواند در پاسخ به تماس با این روش بازگرداند. لطفاً برای جزئیات بیشتر به مستندات پیام خطا مراجعه کنید.
| نوع خطا | جزئیات خطا | شرح |
|---|---|---|
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 استفاده کنید.