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
    • snippet.bannedUserDetails.channelId

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

    • snippet.banDurationSeconds

Ответ

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

Ошибки

В следующей таблице указаны сообщения об ошибках, которые API может вернуть в ответ на вызов этого метода. Дополнительные сведения см. в разделе API потоковой передачи YouTube Live — ошибки .

Тип ошибки Детализация ошибки Описание
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.