Escludi un utente specifico dalla partecipazione alla chat dal vivo. La richiesta dell'API deve essere autorizzata dal proprietario del canale o da un moderatore della chat dal vivo associata all'esclusione.
Casi d'uso comuni
Risorse richieste:
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
Nella tabella seguente sono elencati i parametri supportati dalla query. Tutti i parametri elencati sono parametri di ricerca.
Parametri | ||
---|---|---|
Parametri obbligatori | ||
part |
string In questa operazione il parametro part ha due scopi. Identifica le proprietà impostate dall'operazione di scrittura e le proprietà che restituisce la risposta API. Imposta il valore del parametro su snippet . |
Corpo della richiesta
Fornisci una risorsa liveChatBan nel corpo della richiesta. Per la risorsa:
-
Devi specificare un valore per queste proprietà:
snippet.liveChatId
snippet.type
snippet.bannedUserDetails.channelId
-
Puoi impostare i valori delle seguenti proprietà:
snippet.banDurationSeconds
Risposta
In caso di 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 maggiori dettagli, consulta la documentazione sui messaggi di errore.
Tipo di errore | Dettagli errore | Descrizione |
---|---|---|
forbidden (403) |
insufficientPermissions |
Non hai le autorizzazioni necessarie per escludere un utente dalla chat dal vivo specificata. |
forbidden (403) |
liveChatBanInsertionNotAllowed |
Impossibile creare il esclusione specificato. 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 dal vivo 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 dal vivo 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.