LiveChatBans: insert
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Impide que un usuario específico participe en el chat en vivo. El propietario del canal o un moderador del chat en vivo asociado con la prohibición debe autorizar la solicitud a la API.
Casos de uso habituales
Solicitud
Solicitud HTTP
POST https://www.googleapis.com/youtube/v3/liveChat/bans
Autorización
Esta solicitud requiere autorización con al menos uno de los siguientes permisos. Para obtener más información sobre la autenticación y autorización, consulta Cómo implementar la autenticación de OAuth 2.0.
| Alcance |
|---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
Parámetros
En la siguiente tabla, se enumeran los parámetros que admite esta consulta. Todos los parámetros mencionados son parámetros de consulta.
| Parámetros |
| Parámetros obligatorios |
part |
string
El parámetro part tiene dos propósitos en esta operación. Identifica las propiedades que establecerá la operación de escritura, así como las propiedades que muestra la respuesta de la API. Establece el valor del parámetro en snippet. |
Cuerpo de la solicitud
Proporciona un recurso liveChatBan en el cuerpo de la solicitud.
Para ese recurso:
Respuesta
Si se aplica correctamente, este método muestra un recurso liveChatBan en el cuerpo de la respuesta.
Errores
En la siguiente tabla, se identifican los mensajes de error que podría mostrar la API en respuesta a una llamada a este método. Para obtener más información, consulta API de YouTube Live Streaming: Errores.
| Tipo de error |
Detalle del error |
Descripción |
forbidden (403) |
insufficientPermissions |
No tienes los permisos necesarios para banear a un usuario del chat en vivo especificado. |
forbidden (403) |
liveChatBanInsertionNotAllowed |
No se puede crear la prohibición especificada. Este error puede ocurrir si la solicitud intenta banear al propietario del chat o a otro moderador. |
invalidValue (400) |
invalidChannelId |
No se puede encontrar el ID de canal especificado. |
invalidValue (400) |
invalidLiveChatId |
El valor de snippet.liveChatId especificado en la solicitud no es válido. Verifica el recurso liveBroadcast asociado para asegurarte de tener el valor correcto. |
notFound (404) |
liveChatNotFound |
No se puede encontrar el chat en vivo especificado. Verifica el recurso liveBroadcast asociado para asegurarte de que configures la propiedad snippet.liveChatId con el valor correcto. |
notFound (404) |
liveChatUserNotFound |
No se puede encontrar el usuario del chat en vivo que intentas banear. |
required (400) |
bannedUserChannelIdRequired |
El recurso liveChatBan que se envía en el cuerpo de la solicitud debe especificar un valor para la propiedad snippet.bannedUserDetails.channelId. |
required (400) |
liveChatIdRequired |
El recurso liveChatBan que se envía en el cuerpo de la solicitud debe especificar un valor para la propiedad snippet.liveChatId. |
Pruébalo
Usa APIs Explorer para llamar a esta API y ver la solicitud y la respuesta de la API.
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-01-02 (UTC)
[null,null,["Última actualización: 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."]]
