Un recurso liveChatBan
identifica a un usuario y un chat en vivo de YouTube en los que el usuario tiene prohibido participar.
Métodos
La API admite los siguientes métodos para los recursos de liveChatBans
:
- insertar
- Bloqueará a un usuario específico para que no participe 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. Pruébala ahora.
- borrar
- Quita una prohibición que impide que un usuario específico contribuya a un chat en vivo para que pueda volver a unirse. 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. Pruébala ahora.
Representación de recursos
La siguiente estructura JSON muestra el formato de un recurso liveChatBans
:
{ "kind": "youtube#liveChatBan", "etag": etag, "id": string, "snippet": { "liveChatId": string, "type": string, "banDurationSeconds": unsigned long, "bannedUserDetails": { "channelId": string } } }
Propiedades
La siguiente tabla define las propiedades que aparecen en este recurso:
Propiedades | |
---|---|
kind |
string Identifica el tipo de recurso de API. El valor será youtube#liveChatBan . |
etag |
etag Es la Etag de este recurso. |
id |
string ID que YouTube asigna para identificar de forma exclusiva el bloqueo. |
snippet |
object El objeto snippet identifica al usuario bloqueado y contiene detalles sobre la prohibición. |
snippet.liveChatId |
string Chat en vivo en el que se aplica la prohibición. El ID del chat en vivo asociado con una transmisión se muestra en la propiedad snippet.liveChatId del recurso liveBroadcast . |
snippet.type |
string El tipo de bloqueo. Los valores válidos para esta propiedad son los siguientes:
|
snippet.banDurationSeconds |
unsigned long La duración del bloqueo. Solo establece un valor para esta propiedad si el tipo de bloqueo es temporary . El valor predeterminado es 300 (5 minutos). |
snippet.bannedUserDetails |
object Este objeto contiene información que identifica al usuario bloqueado. |
snippet.bannedUserDetails.channelId |
string Es el ID del canal de YouTube del usuario bloqueado. |