LiveChatBans: insert

Ein bestimmter Nutzer wird vom Livechat ausgeschlossen. Die API-Anfrage muss vom Kanalinhaber oder einem Moderator des Livechats 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

Diese Anfrage erfordert eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche. Weitere Informationen zu Authentifizierung und Autorisierung finden Sie unter OAuth 2.0-Authentifizierung implementieren.

Umfang
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 bei diesem Vorgang zwei Zwecken. Sie gibt die Eigenschaften an, die durch den Schreibvorgang festgelegt werden, sowie die Eigenschaften, die in 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:

  • Sie müssen einen Wert für die folgenden Properties angeben:

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

  • Sie können Werte für die folgenden Properties 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 findest du unter YouTube Live Streaming API – Fehler.

Fehlertyp Fehlerdetails Beschreibung
forbidden (403) insufficientPermissions Du hast nicht die erforderlichen Berechtigungen, um einen Nutzer aus dem angegebenen Livechat auszuschließen.
forbidden (403) liveChatBanInsertionNotAllowed Das angegebene Verbot kann nicht erstellt werden. Dieser Fehler kann auftreten, wenn mit der Anfrage versucht wird, den Chatinhaber oder einen anderen Moderator zu sperren.
invalidValue (400) invalidChannelId Die angegebene Channel-ID wurde nicht gefunden.
invalidValue (400) invalidLiveChatId Der in der Anfrage angegebene Wert für snippet.liveChatId ist ungültig. Prüfen Sie in der zugehörigen liveBroadcast-Ressource, ob der Wert korrekt ist.
notFound (404) liveChatNotFound Der angegebene Livechat kann nicht gefunden werden. Prüfen Sie die zugehörige liveBroadcast-Ressource, um sicherzustellen, dass Sie für die snippet.liveChatId-Property den richtigen Wert festlegen.
notFound (404) liveChatUserNotFound Der Livechat-Nutzer, den du sperren möchtest, konnte nicht gefunden werden.
required (400) bannedUserChannelIdRequired Die im Anfragetext eingereichte liveChatBan-Ressource muss einen Wert für das Attribut snippet.bannedUserDetails.channelId angeben.
required (400) liveChatIdRequired Die im Anfragetext eingereichte liveChatBan-Ressource muss einen Wert für das Attribut snippet.liveChatId angeben.

Testen!

Verwenden Sie die APIs Explorer, um diese API aufzurufen und die API-Anfrage und ‑Antwort zu sehen.