Blokuje konkretnemu użytkownikowi możliwość uczestniczenia 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ą.
Typowe przypadki użycia
Prośba
Żądanie HTTP
POST https://www.googleapis.com/youtube/v3/liveChat/bans
Upoważnienie
To żądanie wymaga autoryzacji z użyciem co najmniej jednego z tych zakresów (więcej informacji o uwierzytelnianiu i autoryzacji).
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 są parametrami zapytania.
Parametry | ||
---|---|---|
Parametry wymagane | ||
part |
string Parametr part służy w tej operacji do 2 celów. Wskazuje on właściwości, które ustawi operacja zapisu, a także właściwości zwracane przez odpowiedź interfejsu API. Ustaw wartość parametru na snippet . |
Treść żądania
Podaj zasób LiveChatBan w treści żądania. W przypadku tego zasobu:
-
Musisz podać wartość tych właściwości:
snippet.liveChatId
snippet.type
snippet.bannedUserDetails.channelId
-
Możesz ustawić wartości dla tych właściwości:
snippet.banDurationSeconds
Odpowiedź
Jeśli operacja się uda, metoda zwróci w treści odpowiedzi zasóbliveChatBan.
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 szczegółów znajdziesz w dokumentacji komunikatów o błędach.
Typ błędu | Szczegóły błędu | Opis |
---|---|---|
forbidden (403) |
insufficientPermissions |
Nie masz odpowiednich uprawnień, aby zablokować 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ć, gdy prośba próbuje zablokować właściciela czatu lub innego moderatora. |
invalidValue (400) |
invalidChannelId |
Nie można znaleźć podanego identyfikatora kanału. |
invalidValue (400) |
invalidLiveChatId |
Wartość snippet.liveChatId podana w żądaniu jest nieprawidłowa. Sprawdź, czy wartość powiązanego zasobu liveBroadcast jest prawidłowa. |
notFound (404) |
liveChatNotFound |
Nie udało się znaleźć podanego czatu na żywo. Sprawdź powiązany zasób liveBroadcast , aby upewnić się, że właściwość snippet.liveChatId ma ustawioną prawidłową wartość. |
notFound (404) |
liveChatUserNotFound |
Nie można znaleźć użytkownika czatu na żywo, którego chcesz zablokować. |
required (400) |
bannedUserChannelIdRequired |
Zasób liveChatBan przesłany w treści żądania musi określać wartość właściwości snippet.bannedUserDetails.channelId . |
required (400) |
liveChatIdRequired |
Zasób liveChatBan przesłany w treści żądania musi określać wartość właściwości snippet.liveChatId . |
Wypróbuj
Użyj interfejsu APIs Explorer, aby wywołać ten interfejs API i wyświetlić żądanie oraz odpowiedź interfejsu API.