LiveChatBans: insert
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
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:
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.
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2025-01-02 (UTC).
[null,null,["Zuletzt aktualisiert: 2025-01-02 (UTC)."],[],[],null,["# LiveChatBans: insert\n\nBans a specific user from participating in the live chat. The API request must be authorized by the channel owner or a moderator of the live chat associated with the ban.\n\nCommon use cases\n----------------\n\nThe list below shows common use cases for this method. Hover over a use case to see its description, or click on a use case to load sample parameter values in the APIs Explorer. You can open the [fullscreen APIs Explorer](#) to see code samples that dynamically update to reflect the parameter values entered in the Explorer.\n\nThe table below shows common use cases for this method. You can click on a use case name to load sample parameter values in the APIs Explorer. Or you can see code samples for a use case in the fullscreen APIs Explorer by clicking on the code icon below a use case name. In the fullscreen UI, you can update parameter and property values and the code samples will dynamically update to reflect the values you enter. \nThis method has one common use case, which is described below. The buttons below the description populate the APIs Explorer with sample values or open the fullscreen APIs Explorer to show code samples that use those values. The code samples also dynamically update if you change the values.\n\n\u003cbr /\u003e\n\nRequest\n-------\n\n### HTTP request\n\n```\nPOST https://www.googleapis.com/youtube/v3/liveChat/bans\n```\n\n### Authorization\n\nThis request requires authorization with at least one of the following scopes. To read more\nabout authentication and authorization, see\n[Implementing OAuth 2.0 authentication](/youtube/v3/live/authentication).\n\n| Scope |\n|-----------------------------------------------------|\n| `https://www.googleapis.com/auth/youtube` |\n| `https://www.googleapis.com/auth/youtube.force-ssl` |\n\n### Parameters\n\nThe following table lists the parameters that this query supports. All of the parameters listed are query parameters.\n\n| Parameters ||\n|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| **Required parameters** |||\n| `part` | `string` The **part** parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response returns. Set the parameter value to `snippet`. |\n\n### Request body\n\nProvide a [liveChatBan resource](/youtube/v3/live/docs/liveChatBans#resource) in the request body.\nFor that resource:\n\n- You must specify a value for these properties:\n\n \u003cbr /\u003e\n\n - `snippet.liveChatId`\n - `snippet.type`\n - `snippet.bannedUserDetails.channelId`\n\n \u003cbr /\u003e\n\n- You can set values for these properties:\n\n \u003cbr /\u003e\n\n - `snippet.banDurationSeconds`\n\n \u003cbr /\u003e\n\nResponse\n--------\n\nIf successful, this method returns a [liveChatBan resource](/youtube/v3/live/docs/liveChatBans#resource) in the response body.\n\nErrors\n------\n\nThe following table identifies error messages that the API could return in response to a call to this method. For more details, see [YouTube Live Streaming API - Errors](/youtube/v3/live/docs/errors).\n\n| Error type | Error detail | Description |\n|----------------------|----------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `forbidden (403)` | `insufficientPermissions` | You do not have the necessary permissions to ban a user from the specified live chat. |\n| `forbidden (403)` | `liveChatBanInsertionNotAllowed` | The specified ban cannot be created. This error can occur if the request attempts to ban the chat owner or another moderator. |\n| `invalidValue (400)` | `invalidChannelId` | The specified channel ID cannot be found. |\n| `invalidValue (400)` | `invalidLiveChatId` | The `snippet.liveChatId` value specified in the request is invalid. Check the associated `liveBroadcast` resource to ensure that you have the correct value. |\n| `notFound (404)` | `liveChatNotFound` | The specified live chat cannot be found. Check the associated `liveBroadcast` resource to ensure that you are setting the `snippet.liveChatId` property to the correct value. |\n| `notFound (404)` | `liveChatUserNotFound` | The live chat user you are trying to ban cannot be found. |\n| `required (400)` | `bannedUserChannelIdRequired` | The `liveChatBan` resource submitted in the request body must specify a value for the `snippet.bannedUserDetails.channelId` property. |\n| `required (400)` | `liveChatIdRequired` | The `liveChatBan` resource submitted in the request body must specify a value for the `snippet.liveChatId` property. |\n\nTry it!\n-------\n\nUse the APIs Explorer to call this API and see the API request and response."]]
