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 |
stringLe 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:
-
Vous devez spécifier une valeur pour les propriétés suivantes:
snippet.liveChatIdsnippet.typesnippet.bannedUserDetails.channelId
-
Vous pouvez définir des valeurs pour les propriétés suivantes:
snippet.banDurationSeconds
Réponse
Si la requête aboutit, cette méthode renvoie une ressource "liveChatBan" dans le corps de la réponse.
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.