LiveChatBans: insert
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Empêche un utilisateur spécifique de participer au chat en direct. La demande d'API doit être autorisée par le propriétaire de la chaîne ou un modérateur du chat en direct associé à l'interdiction.
Cas d'utilisation courants
Requête
Requête HTTP
POST https://www.googleapis.com/youtube/v3/liveChat/bans
Autorisation
Cette requête nécessite une autorisation avec au moins l'un des champs d'application suivants. Pour en savoir plus sur l'authentification et l'autorisation, consultez Implémenter l'authentification OAuth 2.0.
| Portée |
|---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
Paramètres
Le tableau suivant présente les paramètres compatibles avec cette requête. Tous les paramètres listés sont des paramètres de requête.
| Paramètres |
| Paramètres obligatoires |
part |
string
Le paramètre part a deux fonctions dans cette opération. Il identifie les propriétés que l'opération d'écriture définira, ainsi que les propriétés renvoyées par la réponse de l'API. Définissez la valeur du paramètre sur snippet. |
Corps de la requête
Fournissez une ressource liveChatBan dans le corps de la requête.
Pour cette ressource:
Erreurs
Le tableau suivant identifie les messages d'erreur que l'API peut renvoyer en réponse à un appel de cette méthode. Pour en savoir plus, consultez API YouTube Live Streaming - Erreurs.
| Type d'erreur |
Détail de l'erreur |
Description |
forbidden (403) |
insufficientPermissions |
Vous ne disposez pas des autorisations nécessaires pour bannir un utilisateur du chat en direct spécifié. |
forbidden (403) |
liveChatBanInsertionNotAllowed |
Impossible de créer l'interdiction spécifiée. Cette erreur peut se produire si la demande tente d'interdire le propriétaire de la discussion ou un autre modérateur. |
invalidValue (400) |
invalidChannelId |
L'ID de chaîne spécifié est introuvable. |
invalidValue (400) |
invalidLiveChatId |
La valeur snippet.liveChatId spécifiée dans la requête n'est pas valide. Vérifiez la ressource liveBroadcast associée pour vous assurer que vous disposez de la valeur correcte. |
notFound (404) |
liveChatNotFound |
Le chat en direct spécifié est introuvable. Vérifiez la ressource liveBroadcast associée pour vous assurer que vous définissez la propriété snippet.liveChatId sur la valeur appropriée. |
notFound (404) |
liveChatUserNotFound |
L'utilisateur du chat en direct que vous essayez de bannir est introuvable. |
required (400) |
bannedUserChannelIdRequired |
La ressource liveChatBan envoyée dans le corps de la requête doit spécifier une valeur pour la propriété snippet.bannedUserDetails.channelId. |
required (400) |
liveChatIdRequired |
La ressource liveChatBan envoyée dans le corps de la requête doit spécifier une valeur pour la propriété snippet.liveChatId. |
Essayer
Utilisez APIs Explorer pour appeler cette API et afficher la requête et la réponse de l'API.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/01/02 (UTC).
[null,null,["Dernière mise à jour le 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."]]
