Prohibir la participación de un usuario específico en el chat en vivo. La solicitud de la API debe ser autorizada por el propietario del canal o un moderador del chat en vivo asociado con la prohibición.
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 alcances (obtén más información acerca de la autenticación y autorización).
| 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 |
stringEl 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:
-
Debes especificar un valor para estas propiedades:
snippet.liveChatIdsnippet.typesnippet.bannedUserDetails.channelId
-
Puedes establecer los valores de las siguientes propiedades:
snippet.banDurationSeconds
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 la API podría mostrar en respuesta a una llamada a este método. Consulta la documentación sobre mensajes de error para obtener más información.
| Tipo de error | Detalle del error | Descripción |
|---|---|---|
forbidden (403) |
insufficientPermissions |
No tienes los permisos necesarios para bloquear a un usuario del chat en vivo especificado. |
forbidden (403) |
liveChatBanInsertionNotAllowed |
No se puede crear el bloqueo especificado. Este error puede ocurrir si la solicitud intenta bloquear al propietario del chat o a otro moderador. |
invalidValue (400) |
invalidChannelId |
No se puede encontrar el ID del canal especificado. |
invalidValue (400) |
invalidLiveChatId |
El valor snippet.liveChatId especificado en la solicitud no es válido. Verifica el recurso liveBroadcast asociado para asegurarte de que tienes el valor correcto. |
notFound (404) |
liveChatNotFound |
No se puede encontrar el chat en vivo que especificaste. Verifica el recurso liveBroadcast asociado para asegurarte de establecer la propiedad snippet.liveChatId en el valor correcto. |
notFound (404) |
liveChatUserNotFound |
No se puede encontrar al usuario del chat en vivo que deseas bloquear. |
required (400) |
bannedUserChannelIdRequired |
El recurso liveChatBan que se envió en el cuerpo de la solicitud debe especificar un valor para la propiedad snippet.bannedUserDetails.channelId. |
required (400) |
liveChatIdRequired |
El recurso liveChatBan que se envió en el cuerpo de la solicitud debe especificar un valor para la propiedad snippet.liveChatId. |
Pruébela.
Usa APIs Explorer para llamar a esta API y ver la solicitud y la respuesta de la API.