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'exclusion.
Cas d'utilisation courants
Demande
Requête HTTP :
POST https://www.googleapis.com/youtube/v3/liveChat/bans
Autorisation
Une autorisation est requise pour cette requête. Celle-ci doit inclure au moins l'un des champs d'application suivants. En savoir plus sur le processus d'authentification et d'autorisation
Portée |
---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
Paramètres
Le tableau suivant répertorie les paramètres compatibles avec cette requête. Tous les paramètres listés sont des paramètres de requête.
Paramètres | ||
---|---|---|
Réglages obligatoires | ||
part |
string Le paramètre part a une double finalité. 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
Indiquez une ressource liveChatBan dans le corps de la requête. Pour cette ressource:
-
Vous devez spécifier une valeur pour ces propriétés:
snippet.liveChatId
snippet.type
snippet.bannedUserDetails.channelId
-
Vous pouvez définir des valeurs pour les propriétés suivantes:
snippet.banDurationSeconds
Réponse
Lorsque cette méthode fonctionne, elle renvoie une ressource "liveChatBan" dans le corps de la réponse.
Erreurs
Le tableau suivant identifie les messages d'erreur que l'API pourrait renvoyer en réponse à un appel à cette méthode. Veuillez consulter la documentation sur les messages d'erreur pour en savoir plus.
Type d'erreur | Détails de l'erreur | Description |
---|---|---|
forbidden (403) |
insufficientPermissions |
Vous ne disposez pas des autorisations nécessaires pour exclure un utilisateur du chat en direct indiqué. |
forbidden (403) |
liveChatBanInsertionNotAllowed |
Impossible de créer l'exclusion spécifiée. Cette erreur peut se produire si la requête tente d'exclure le propriétaire du chat ou un autre modérateur. |
invalidValue (400) |
invalidChannelId |
L'ID de critère 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 la valeur est correcte. |
notFound (404) |
liveChatNotFound |
Impossible de trouver le chat en direct spécifié. Vérifiez la ressource liveBroadcast associée pour vous assurer que vous définissez la propriété snippet.liveChatId sur la valeur correcte. |
notFound (404) |
liveChatUserNotFound |
L'utilisateur du chat en direct que vous essayez d'exclure 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 API et la réponse.