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 در این عملیات دو هدف را دنبال می‌کند. این منبع ویژگی‌هایی را که عملیات نوشتن تنظیم می‌کند و همچنین ویژگی‌هایی را که پاسخ میانای برنامه‌سازی کاربردی برمی‌گرداند شناسایی می‌کند. مقدار پارامتر را روی snippet تنظیم کنید.

متن درخواست

یک منبع liveChatBan در متن درخواست ارائه دهید. برای آن منبع:

  • باید مقداری برای این ویژگی‌ها مشخص کنید:

    • snippet.liveChatId
    • snippet.type - یکی از گزینه‌های زیر را انتخاب کنید: permanent یا temporary
    • snippet.bannedUserDetails.channelId

  • می‌توانید مقادیر این دارایی‌ها را تنظیم کنید:

    • snippet.banDurationSeconds

پاسخ

درصورت موفقیت‌آمیز بودن، این روش یک منبع 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 استفاده کنید.