Blokuje konkretnego użytkownika, uniemożliwiając mu udział w czacie na żywo. Żądanie do interfejsu API musi być autoryzowane przez właściciela kanału lub moderatora czatu na żywo powiązanego z blokadą.
Częste zastosowania
Żądanie
Żądanie HTTP
POST https://www.googleapis.com/youtube/v3/liveChat/bans
Autoryzacja
To żądanie wymaga autoryzacji z co najmniej jednym z tych zakresów. Więcej informacji o uwierzytelnianiu i autoryzacji znajdziesz w artykule Implementowanie uwierzytelniania OAuth 2.0.
| Zakres |
|---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
Parametry
W tabeli poniżej znajdziesz parametry obsługiwane przez to zapytanie. Wszystkie wymienione parametry to parametry zapytania.
| Parametry | ||
|---|---|---|
| Parametry wymagane | ||
part |
stringParametr part pełni w tej operacji 2 funkcje. Określa właściwości, które operacja zapisu ustawi, oraz właściwości zwracane przez odpowiedź interfejsu API. Ustaw wartość parametru na snippet. |
|
Treść żądania
W treści żądania podaj zasób liveChatBan. W przypadku tego zasobu:
-
Musisz podać wartość tych właściwości:
snippet.liveChatIdsnippet.type– wybierz jedną z tych opcji:permanentlubtemporarysnippet.bannedUserDetails.channelId
-
Możesz ustawić wartości tych właściwości:
snippet.banDurationSeconds
Odpowiedź
Jeśli operacja się uda, ta metoda zwróci w treści odpowiedzi zasób liveChatBan.
Błędy
W tabeli poniżej znajdziesz komunikaty o błędach, które interfejs API może zwrócić w odpowiedzi na wywołanie tej metody. Więcej informacji znajdziesz w artykule YouTube Live Streaming API – Errors.
| Typ błędu | Szczegóły błędu | Opis |
|---|---|---|
forbidden (403) |
insufficientPermissions |
Nie masz uprawnień do zablokowania użytkownika na określonym czacie na żywo. |
forbidden (403) |
liveChatBanInsertionNotAllowed |
Nie można utworzyć określonej blokady. Ten błąd może wystąpić, jeśli żądanie próbuje zablokować właściciela czatu lub innego moderatora. |
invalidValue (400) |
invalidChannelId |
Nie można znaleźć określonego identyfikatora kanału. |
invalidValue (400) |
invalidLiveChatId |
Wartość snippet.liveChatId podana w żądaniu jest nieprawidłowa. Sprawdź powiązany zasób liveBroadcast, aby upewnić się, że masz prawidłową wartość. |
notFound (404) |
liveChatNotFound |
Nie można znaleźć określonego czatu na żywo. Sprawdź powiązany zasób liveBroadcast, aby upewnić się, że ustawiasz właściwość snippet.liveChatId na prawidłową wartość. |
notFound (404) |
liveChatUserNotFound |
Nie można znaleźć użytkownika czatu na żywo, którego próbujesz zablokować. |
required (400) |
bannedUserChannelIdRequired |
Zasób liveChatBan przesłany w treści żądania musi zawierać wartość właściwości snippet.bannedUserDetails.channelId. |
required (400) |
liveChatIdRequired |
Zasób liveChatBan przesłany w treści żądania musi zawierać wartość właściwości snippet.liveChatId. |
Wypróbuj
Aby wywołać ten interfejs API i zobaczyć żądanie do interfejsu API oraz odpowiedź, użyj APIs Explorer.