Impedisce a un utente specifico di partecipare alla chat live. La richiesta API deve essere autorizzata dal proprietario del canale o da un moderatore della chat live associata all'esclusione.
Casi d'uso comuni
Richiesta
Richiesta HTTP
POST https://www.googleapis.com/youtube/v3/liveChat/bans
Autorizzazione
Questa richiesta richiede l'autorizzazione con almeno uno dei seguenti ambiti (scopri di più su autenticazione e autorizzazione).
| Ambito |
|---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
Parametri
La tabella seguente elenca i parametri supportati da questa query. Tutti i parametri elencati sono parametri di query.
| Parametri | ||
|---|---|---|
| Parametri obbligatori | ||
part |
stringIl parametro part ha due scopi in questa operazione. Identifica le proprietà che verranno impostate dall'operazione di scrittura, nonché le proprietà restituite dalla risposta dell'API. Imposta il valore del parametro su snippet. |
|
Corpo della richiesta
Fornisci una risorsa liveChatBan nel corpo della richiesta. Per questa risorsa:
-
Devi specificare un valore per queste proprietà:
snippet.liveChatIdsnippet.typesnippet.bannedUserDetails.channelId
-
Puoi impostare i valori per le seguenti proprietà:
snippet.banDurationSeconds
Risposta
Se l'esito è positivo, questo metodo restituisce una risorsa liveChatBan nel corpo della risposta.
Errori
La tabella seguente identifica i messaggi di errore che l'API potrebbe restituire in risposta a una chiamata a questo metodo. Per ulteriori dettagli, consulta la documentazione relativa ai messaggi di errore.
| Tipo di errore | Dettagli errore | Descrizione |
|---|---|---|
forbidden (403) |
insufficientPermissions |
Non disponi delle autorizzazioni necessarie per escludere un utente dalla chat live specificata. |
forbidden (403) |
liveChatBanInsertionNotAllowed |
Impossibile creare l'esclusione specificata. Questo errore può verificarsi se la richiesta tenta di escludere il proprietario della chat o un altro moderatore. |
invalidValue (400) |
invalidChannelId |
Impossibile trovare l'ID canale specificato. |
invalidValue (400) |
invalidLiveChatId |
Il valore snippet.liveChatId specificato nella richiesta non è valido. Controlla la risorsa liveBroadcast associata per assicurarti che il valore sia corretto. |
notFound (404) |
liveChatNotFound |
Impossibile trovare la chat live specificata. Controlla la risorsa liveBroadcast associata per assicurarti di impostare la proprietà snippet.liveChatId sul valore corretto. |
notFound (404) |
liveChatUserNotFound |
Impossibile trovare l'utente della chat live che stai tentando di escludere. |
required (400) |
bannedUserChannelIdRequired |
La risorsa liveChatBan inviata nel corpo della richiesta deve specificare un valore per la proprietà snippet.bannedUserDetails.channelId. |
required (400) |
liveChatIdRequired |
La risorsa liveChatBan inviata nel corpo della richiesta deve specificare un valore per la proprietà snippet.liveChatId. |
Prova.
Usa APIs Explorer per chiamare questa API e visualizzare la richiesta e la risposta dell'API.