Ресурс liveChatBan идентифицирует пользователя 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 |
etagТег Etag этого ресурса. |
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Идентификатор канала YouTube заблокированного пользователя. |