LiveChatBans: insert
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Proíbe um usuário específico de participar do chat ao vivo. A solicitação da 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
Esta solicitação requer autorização com pelo menos um dos seguintes escopos. Para saber mais
sobre autenticação e autorização, consulte
Como implementar a autenticação 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 parâmetro part tem duas finalidades nesta operação. Ele identifica as propriedades que a operação de gravação vai definir, bem como as propriedades que a resposta da API vai retornar. 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:
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 foi 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 de 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ê está 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 APIs Explorer para chamar essa API e conferir a solicitação e a resposta dela.
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-01-02 UTC.
[null,null,["Última atualização 2025-01-02 UTC."],[],[],null,["# LiveChatBans: insert\n\nBans a specific user from participating in the live chat. The API request must be authorized by the channel owner or a moderator of the live chat associated with the ban.\n\nCommon use cases\n----------------\n\nThe list below shows common use cases for this method. Hover over a use case to see its description, or click on a use case to load sample parameter values in the APIs Explorer. You can open the [fullscreen APIs Explorer](#) to see code samples that dynamically update to reflect the parameter values entered in the Explorer.\n\nThe table below shows common use cases for this method. You can click on a use case name to load sample parameter values in the APIs Explorer. Or you can see code samples for a use case in the fullscreen APIs Explorer by clicking on the code icon below a use case name. In the fullscreen UI, you can update parameter and property values and the code samples will dynamically update to reflect the values you enter. \nThis method has one common use case, which is described below. The buttons below the description populate the APIs Explorer with sample values or open the fullscreen APIs Explorer to show code samples that use those values. The code samples also dynamically update if you change the values.\n\n\u003cbr /\u003e\n\nRequest\n-------\n\n### HTTP request\n\n```\nPOST https://www.googleapis.com/youtube/v3/liveChat/bans\n```\n\n### Authorization\n\nThis request requires authorization with at least one of the following scopes. To read more\nabout authentication and authorization, see\n[Implementing OAuth 2.0 authentication](/youtube/v3/live/authentication).\n\n| Scope |\n|-----------------------------------------------------|\n| `https://www.googleapis.com/auth/youtube` |\n| `https://www.googleapis.com/auth/youtube.force-ssl` |\n\n### Parameters\n\nThe following table lists the parameters that this query supports. All of the parameters listed are query parameters.\n\n| Parameters ||\n|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| **Required parameters** |||\n| `part` | `string` The **part** parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response returns. Set the parameter value to `snippet`. |\n\n### Request body\n\nProvide a [liveChatBan resource](/youtube/v3/live/docs/liveChatBans#resource) in the request body.\nFor that resource:\n\n- You must specify a value for these properties:\n\n \u003cbr /\u003e\n\n - `snippet.liveChatId`\n - `snippet.type`\n - `snippet.bannedUserDetails.channelId`\n\n \u003cbr /\u003e\n\n- You can set values for these properties:\n\n \u003cbr /\u003e\n\n - `snippet.banDurationSeconds`\n\n \u003cbr /\u003e\n\nResponse\n--------\n\nIf successful, this method returns a [liveChatBan resource](/youtube/v3/live/docs/liveChatBans#resource) in the response body.\n\nErrors\n------\n\nThe following table identifies error messages that the API could return in response to a call to this method. For more details, see [YouTube Live Streaming API - Errors](/youtube/v3/live/docs/errors).\n\n| Error type | Error detail | Description |\n|----------------------|----------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `forbidden (403)` | `insufficientPermissions` | You do not have the necessary permissions to ban a user from the specified live chat. |\n| `forbidden (403)` | `liveChatBanInsertionNotAllowed` | The specified ban cannot be created. This error can occur if the request attempts to ban the chat owner or another moderator. |\n| `invalidValue (400)` | `invalidChannelId` | The specified channel ID cannot be found. |\n| `invalidValue (400)` | `invalidLiveChatId` | The `snippet.liveChatId` value specified in the request is invalid. Check the associated `liveBroadcast` resource to ensure that you have the correct value. |\n| `notFound (404)` | `liveChatNotFound` | The specified live chat cannot be found. Check the associated `liveBroadcast` resource to ensure that you are setting the `snippet.liveChatId` property to the correct value. |\n| `notFound (404)` | `liveChatUserNotFound` | The live chat user you are trying to ban cannot be found. |\n| `required (400)` | `bannedUserChannelIdRequired` | The `liveChatBan` resource submitted in the request body must specify a value for the `snippet.bannedUserDetails.channelId` property. |\n| `required (400)` | `liveChatIdRequired` | The `liveChatBan` resource submitted in the request body must specify a value for the `snippet.liveChatId` property. |\n\nTry it!\n-------\n\nUse the APIs Explorer to call this API and see the API request and response."]]
