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 в теле запроса. Для этого ресурса:

  • Для следующих свойств необходимо указать значение:

    • snippet.liveChatId
    • snippet.type – выберите один из следующих вариантов: permanent или temporary.
    • snippet.bannedUserDetails.channelId

  • Вы можете задать значения для следующих свойств:

    • snippet.banDurationSeconds

Ответ

В случае успеха этот метод возвращает в теле ответа ресурс liveChatBan.

Ошибки

В таблице ниже перечислены сообщения об ошибках, которые API может возвращать в ответ на вызов этого метода. Подробнее об ошибках YouTube Live Streaming 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 и ответ.