LiveChatBans: insert

Sperrt einen bestimmten Nutzer für den Live-Chat. Die API-Anfrage muss vom Kanalinhaber oder einem Moderator des Live-Chats autorisiert werden, der mit der Sperrung verknüpft ist.

Gängige Anwendungsfälle

Anfrage

HTTP-Anfrage

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

Autorisierung

Für diese Anfrage ist eine Autorisierung mit mindestens einem der folgenden Bereiche erforderlich. Weitere Informationen zur Authentifizierung und Autorisierung finden Sie unter OAuth 2.0-Authentifizierung implementieren.

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 hat bei dieser Operation zwei Funktionen. Er gibt die Attribute an, die durch die Schreiboperation festgelegt werden, sowie die Attribute, die von der API-Antwort zurückgegeben werden. Legen Sie den Parameterwert auf snippet fest.

Anfragetext

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

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

    • snippet.liveChatId
    • snippet.type – wählen Sie eine der folgenden Optionen aus: permanent oder temporary
    • snippet.bannedUserDetails.channelId

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

    • snippet.banDurationSeconds

Antwort

Bei Erfolg gibt diese Methode eine liveChatBan-Ressource im Antworttext zurück.

Fehler

In der folgenden Tabelle sind die Fehlermeldungen aufgeführt, die die API als Antwort auf einen Aufruf dieser Methode zurückgeben kann. Weitere Informationen finden Sie unter YouTube Live Streaming API – Fehler.

Fehlertyp Fehlerdetails Beschreibung
forbidden (403) insufficientPermissions Sie haben nicht die erforderlichen Berechtigungen, um einen Nutzer aus dem angegebenen Live-Chat zu sperren.
forbidden (403) liveChatBanInsertionNotAllowed Die angegebene Sperrung kann nicht erstellt werden. Dieser Fehler kann auftreten, wenn in 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 Wert snippet.liveChatId ist ungültig. Prüfen Sie die zugehörige liveBroadcast-Ressource, um sicherzustellen, dass Sie den richtigen Wert haben.
notFound (404) liveChatNotFound Der angegebene Live-Chat wurde nicht gefunden. Prüfen Sie die zugehörige liveBroadcast-Ressource, um sicherzustellen, dass Sie das Attribut snippet.liveChatId auf den richtigen Wert setzen.
notFound (404) liveChatUserNotFound Der Live-Chat-Nutzer, den Sie sperren möchten, wurde nicht gefunden.
required (400) bannedUserChannelIdRequired Für die im Anfragetext übermittelte liveChatBan-Ressource muss ein Wert für das Attribut snippet.bannedUserDetails.channelId angegeben werden.
required (400) liveChatIdRequired Für die im Anfragetext übermittelte liveChatBan-Ressource muss ein Wert für das Attribut snippet.liveChatId angegeben werden.

Testen!

Mit dem APIs Explorer können Sie diese API aufrufen und die API-Anfrage und -Antwort ansehen.