LiveChatBans: insert

Damit wird ein bestimmter Nutzer von der Teilnahme am Livechat ausgeschlossen. Die API-Anfrage muss vom Kanalinhaber oder Moderator des mit der Sperre verknüpften Livechats autorisiert werden.

Gängige Anwendungsfälle

Anfragen

HTTP-Anfrage

POST https://www.googleapis.com/youtube/v3/liveChat/bans

Autorisierung

Diese Anfrage benötigt eine Autorisierung mit mindestens einem der folgenden Bereiche (weitere Informationen zu Authentifizierung und Autorisierung).

Bereich
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

Parameter

In der folgenden Tabelle sind die Parameter aufgeführt, die von dieser Abfrage unterstützt werden. Alle aufgeführten Parameter sind Abfrageparameter.

Parameter
Erforderliche Parameter
part string
Der Parameter part dient in diesem Vorgang zwei Zwecken. Sie identifiziert die Eigenschaften, die durch den Schreibvorgang festgelegt werden, sowie die Eigenschaften, die die API-Antwort zurückgibt. Legen Sie den Parameterwert auf snippet fest.

Anfragetext

Geben Sie im Anfragetext eine liveChatBan-Ressource an. Für diese Ressource:

  • Sie müssen einen Wert für diese Attribute angeben:

    • snippet.liveChatId
    • snippet.type
    • snippet.bannedUserDetails.channelId

  • Sie können Werte für diese Eigenschaften festlegen:

    • snippet.banDurationSeconds

Antwort

Wenn der Vorgang erfolgreich ist, wird mit dieser Methode eine liveChatBan-Ressource im Antworttext zurückgegeben.

Fehler

In der folgenden Tabelle finden Sie Fehlermeldungen, die die API als Antwort auf einen Aufruf dieser Methode zurückgeben könnte. Weitere Informationen finden Sie in der Dokumentation zu Fehlermeldungen.

Fehlertyp Fehlerdetails Beschreibung
forbidden (403) insufficientPermissions Du bist nicht berechtigt, einen Nutzer für den angegebenen Livechat zu sperren.
forbidden (403) liveChatBanInsertionNotAllowed Die angegebene Sperre kann nicht erstellt werden. Dieser Fehler kann auftreten, wenn mit der Anfrage versucht wird, den Inhaber des Chats oder einen anderen Moderator zu sperren.
invalidValue (400) invalidChannelId Die angegebene Kanal-ID wurde nicht gefunden.
invalidValue (400) invalidLiveChatId Der in der Anfrage angegebene snippet.liveChatId-Wert ist ungültig. Prüfen Sie, ob die verknüpfte liveBroadcast-Ressource den richtigen Wert enthält.
notFound (404) liveChatNotFound Der angegebene Livechat kann nicht gefunden werden. Prüfen Sie die zugehörige liveBroadcast-Ressource, um sicherzustellen, dass Sie das Attribut snippet.liveChatId auf den richtigen Wert festlegen.
notFound (404) liveChatUserNotFound Der Livechat-Nutzer, den du sperren möchtest, kann nicht gefunden werden.
required (400) bannedUserChannelIdRequired Die im Anfragetext gesendete Ressource liveChatBan muss einen Wert für das Attribut snippet.bannedUserDetails.channelId enthalten.
required (400) liveChatIdRequired Die im Anfragetext gesendete Ressource liveChatBan muss einen Wert für das Attribut snippet.liveChatId enthalten.

Jetzt testen

Verwenden Sie APIs Explorer, um diese API aufzurufen und die API-Anfrage und -Antwort anzusehen.