یک منبع liveChatBan یک کاربر YouTube و یک چت زنده YouTube را شناسایی می کند که کاربر از شرکت در آن منع شده است.
روش ها
API از روش های زیر برای منابع liveChatBans پشتیبانی می کند:
- insert
- یک کاربر خاص را از شرکت در چت زنده منع می کند. درخواست API باید توسط مالک کانال یا ناظر چت زنده مرتبط با ممنوعیت مجاز باشد. اکنون آن را امتحان کنید .
- delete
- ممنوعیتی را که مانع از مشارکت یک کاربر خاص در یک چت زنده میشود، حذف میکند و در نتیجه کاربر را قادر میسازد دوباره به چت ملحق شود. درخواست API باید توسط مالک کانال یا ناظر چت زنده مرتبط با ممنوعیت مجاز باشد. اکنون آن را امتحان کنید .
نمایندگی منابع
ساختار JSON زیر فرمت یک منبع liveChatBans را نشان می دهد:
{
"kind": "youtube#liveChatBan",
"etag": etag,
"id": string,
"snippet": {
"liveChatId": string,
"type": string,
"banDurationSeconds": unsigned long,
"bannedUserDetails": {
"channelId": string
}
}
}خواص
جدول زیر ویژگی های ظاهر شده در این منبع را تعریف می کند:
| خواص | |
|---|---|
kind | stringنوع منبع API را مشخص می کند. مقدار youtube#liveChatBan خواهد بود. |
etag | etagEtag این منبع |
id | stringشناسه ای که YouTube برای شناسایی منحصر به فرد ممنوعیت اختصاص می دهد. |
snippet | objectشی snippet کاربر ممنوع شده را شناسایی می کند و حاوی جزئیاتی در مورد ممنوعیت است. |
snippet. liveChatId | stringچت زنده ای که ممنوعیت برای آن اعمال می شود. شناسه چت زنده مرتبط با پخش در ویژگی snippet.liveChatId منبع liveBroadcast برگردانده می شود. |
snippet. type | stringنوع ممنوعیت. مقادیر معتبر برای این ویژگی عبارتند از:
|
snippet. banDurationSeconds | unsigned longمدت زمان ممنوعیت. فقط زمانی برای این ویژگی مقدار تعیین کنید که نوع ممنوعیت temporary باشد. مقدار پیش فرض 300 (5 دقیقه) است. |
snippet. bannedUserDetails | objectاین شی حاوی اطلاعاتی است که کاربر ممنوع شده را شناسایی می کند. |
snippet.bannedUserDetails. channelId | stringشناسه کانال یوتیوب کاربر ممنوعه. |