Um recurso liveChatBan identifica um usuário do YouTube e um chat ao vivo do YouTube em que o usuário está banido de participar.
Métodos
A API oferece suporte aos seguintes métodos para recursos liveChatBans:
- inserir
- Impede que um usuário específico participe 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. Faça um teste agora.
- delete
- Remove uma proibição que impede que um usuário específico participe de um chat ao vivo, permitindo que o usuário volte a participar do chat. A solicitação da API precisa ser autorizada pelo proprietário do canal ou por um moderador do chat ao vivo associado à proibição. Faça um teste agora.
Representação de recurso
A estrutura JSON a seguir mostra o formato de um recurso liveChatBans:
{
"kind": "youtube#liveChatBan",
"etag": etag,
"id": string,
"snippet": {
"liveChatId": string,
"type": string,
"banDurationSeconds": unsigned long,
"bannedUserDetails": {
"channelId": string
}
}
}Propriedades
A tabela a seguir define as propriedades que aparecem neste recurso:
| Propriedades | |
|---|---|
kind |
stringIdentifica o tipo do recurso da API. O valor será youtube#liveChatBan. |
etag |
etagA Etag deste recurso. |
id |
stringO ID que o YouTube atribui para identificar exclusivamente a proibição. |
snippet |
objectO objeto snippet identifica o usuário banido e contém detalhes sobre a proibição. |
snippet.liveChatId |
stringO chat ao vivo em que a proibição se aplica. O ID do chat ao vivo associado a uma transmissão é retornado na propriedade snippet.liveChatId do recurso liveBroadcast. |
snippet.type |
stringO tipo de proibição. Os valores válidos para essa propriedade são:
|
snippet.banDurationSeconds |
unsigned longA duração da proibição. Defina um valor para essa propriedade somente se o tipo da proibição for temporary. O valor padrão é 300 (cinco minutos). |
snippet.bannedUserDetails |
objectEsse objeto contém informações que identificam o usuário banido. |
snippet.bannedUserDetails.channelId |
stringO ID do canal do YouTube do usuário banido. |