Ce paramètre modifie l'état d'un message de chat en direct YouTube et lance tous les processus associés au nouvel état. Par exemple, lorsque vous faites passer l'état d'un sondage en direct à closed, YouTube met fin au sondage associé à ce message. Avant d'appeler cette méthode, vérifiez que la valeur de la propriété status pour le message de sondage en direct est active.
Requête
Requête HTTP
POST https://www.googleapis.com/youtube/v3/liveChatMessages/transition
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
| Champ d'application |
|---|
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 | ||
|---|---|---|
| Paramètres obligatoires | ||
id |
stringLe paramètre id spécifie l'identifiant unique du message qui passe à un autre état. |
|
status |
enumLe paramètre status identifie l'état auquel le message change. Pour faire passer un message à l'état closed, status doit être active pour le sondage auquel le message est lié.
Vous ne pouvez passer qu'à closed. Le sondage est alors fermé.
|
|
| Paramètres facultatifs | ||
part |
stringLe paramètre part spécifie les parties de la ressource liveChatMessage que la réponse de l'API inclura. Les valeurs acceptées sont id, snippet et authorDetails.
Définissez la valeur du paramètre sur snippet pour obtenir le résultat final du sondage dans le corps de la réponse.
|
|
Corps de la requête
N'indiquez pas de corps de requête lorsque vous appelez cette méthode.
Réponse
Lorsque cette méthode fonctionne, elle renvoie une ressource liveChatMessages dans le corps de 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 la documentation relative aux messages d'erreur.
| Type d'erreur | Détails de l'erreur | Description |
|---|---|---|
forbidden (403) |
forbidden |
Vous ne disposez pas des autorisations nécessaires pour faire passer l'état du message spécifié. |
required (400) |
idRequired |
Le paramètre id obligatoire doit identifier le message dont vous souhaitez modifier l'état. |
required (400) |
statusRequired |
La requête API doit spécifier une valeur pour le paramètre status. |
notFound (404) |
liveChatMessagesNotFound |
Le message spécifié par le paramètre id n'existe pas. |
forbidden (403) |
modificationNotAllowed |
L'état de la ressource liveChatMessage spécifiée ne peut pas faire l'objet d'une transition. Le paramètre id peut identifier un message dont l'état ne peut pas faire l'objet d'une transition. |
Essayer
Utilisez APIs Explorer pour appeler cette API, et afficher la requête et la réponse de l'API.