LiveChatMessages: transition

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 modifiez l'état d'un sondage en direct en closed, YouTube met fin au sondage de ce message. Avant d'appeler cette méthode, vous devez vérifier que la valeur de la propriété status du message de sondage en direct est active.

Impact sur le quota : un appel à cette méthode coûte 20 unités de quota.

Requête

Requête HTTP

POST https://www.googleapis.com/youtube/v3/liveChat/messages/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 string
Le paramètre id spécifie l'identifiant unique du message dont l'état est en cours de modification.
status enum
Le paramètre status identifie l'état dans lequel le message est en cours de modification. Pour modifier l'état d'un message en closed, le paramètre status doit être défini sur active pour le sondage auquel le message est lié.

Vous ne pouvez passer qu'à closed, ce qui signifie que le sondage est fermé.
Paramètres facultatifs
part string
Le 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

Ne fournissez pas de corps de requête lorsque vous appelez cette méthode.

Réponse

Si la requête aboutit, cette méthode renvoie une ressource liveChatMessages 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 à cette méthode. Pour en savoir plus, consultez la documentation sur les messages d'erreur.

Type d'erreur Détails de l'erreur Description
forbidden (403) forbidden Vous ne disposez pas des autorisations nécessaires pour modifier 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 être modifié. Le paramètre id peut identifier un message dont l'état ne peut pas être modifié.

Essayer

Utilisez le APIs Explorer pour appeler cette API et afficher la requête et la réponse.