LiveChatBans: insert

Impede que um usuário específico participe do chat ao vivo. A solicitação de API precisa ser autorizada pelo proprietário do canal ou por um moderador do chat ao vivo associado à proibição.

Casos de uso comuns

Solicitação

Solicitação HTTP

POST https://www.googleapis.com/youtube/v3/liveChat/bans

Autorização

Essa solicitação exige autorização com pelo menos um dos escopos a seguir. Para saber mais sobre autenticação e autorização, consulte Implementar a autenticação do OAuth 2.0.

Escopo
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

Parâmetros

A tabela a seguir lista os parâmetros compatíveis com essa consulta. Todos os parâmetros listados são os parâmetros de consulta.

Parâmetros
Parâmetros obrigatórios
part string
O part parâmetro tem duas finalidades nessa operação. Ele identifica as propriedades que a operação de gravação vai definir, bem como as propriedades que a resposta da API retorna. Defina o valor do parâmetro como snippet.

Corpo da solicitação

Forneça um recurso liveChatBan no corpo da solicitação. Para esse recurso:

  • É necessário especificar um valor para essas propriedades:

    • snippet.liveChatId
    • snippet.type - escolha uma das seguintes opções: permanent ou temporary
    • snippet.bannedUserDetails.channelId

  • Você pode definir valores para estas propriedades:

    • snippet.banDurationSeconds

Resposta

Se for bem-sucedido, esse método retornará um recurso liveChatBan no corpo da resposta.

Erros

A tabela a seguir identifica as mensagens de erro que a API pode retornar em resposta a uma chamada para esse método. Para mais detalhes, consulte API YouTube Live Streaming - Erros.

Tipo de erro Detalhe do erro Descrição
forbidden (403) insufficientPermissions Você não tem as permissões necessárias para banir um usuário do chat ao vivo especificado.
forbidden (403) liveChatBanInsertionNotAllowed Não é possível criar a proibição especificada. Esse erro pode ocorrer se a solicitação tentar banir o proprietário do chat ou outro moderador.
invalidValue (400) invalidChannelId Não foi possível encontrar o ID do canal especificado.
invalidValue (400) invalidLiveChatId O valor snippet.liveChatId especificado na solicitação é inválido. Verifique o recurso liveBroadcast associado para garantir que você tenha o valor correto.
notFound (404) liveChatNotFound Não foi possível encontrar o chat ao vivo especificado. Verifique o recurso liveBroadcast associado para garantir que você esteja definindo a propriedade snippet.liveChatId com o valor correto.
notFound (404) liveChatUserNotFound Não foi possível encontrar o usuário do chat ao vivo que você está tentando banir.
required (400) bannedUserChannelIdRequired O recurso liveChatBan enviado no corpo da solicitação precisa especificar um valor para a propriedade snippet.bannedUserDetails.channelId.
required (400) liveChatIdRequired O recurso liveChatBan enviado no corpo da solicitação precisa especificar um valor para a propriedade snippet.liveChatId.

Confira!

Use o APIs Explorer para chamar essa API e conferir a solicitação e a resposta da API.