LiveChatMessages: insert

Ajoute un message ou un sondage à un chat en direct.

Incidence sur le quota : un appel à cette méthode a un coût de quota de 20 unités.

Cas d'utilisation courants

Requête

Requête HTTP

POST https://www.googleapis.com/youtube/v3/liveChat/messages

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.

Champ d'application
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

Paramètres

Le tableau suivant liste les paramètres acceptés par 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 objectifs. Il identifie les propriétés que l'opération d'écriture définira, ainsi que celles que la réponse de l'API inclura. Définissez la valeur du paramètre sur snippet.

Corps de la requête

Fournissez une ressource liveChatMessage dans le corps de la requête. Pour cette ressource, vous devez spécifier des valeurs pour ces propriétés :

  • snippet.liveChatId
  • snippet.type : choisissez l'une des options suivantes : textMessageEvent ou pollEvent
  • Si le type est textMessageEvent, incluez snippet.textMessageDetails.messageText.
  • Si le type est pollEvent, incluez l'objet snippet.pollDetails structuré comme suit :
    • snippet.pollDetails.metadata.questionText (chaîne) : question principale du sondage.
    • snippet.pollDetails.metadata.options (tableau) : liste d'objets d'option.
    • Exigences : vous devez inclure au minimum deux éléments et au maximum quatre.
    • Ordre : les éléments sont affichés séquentiellement dans l'ordre exact dans lequel ils sont listés.
    • Chaque objet du tableau doit contenir les éléments suivants :
      • optionText (chaîne) : texte affiché pour ce choix de sondage spécifique.

Réponse

Si la requête aboutit, cette méthode renvoie une ressource liveChatMessage 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 YouTube Live Streaming API - Errors.

Type d'erreur Détails de l'erreur Description
forbidden (403) forbidden Vous ne disposez pas des autorisations nécessaires pour créer le message spécifié.
forbidden (403) liveChatDisabled Le chat en direct spécifié a été désactivé par le propriétaire, ce qui signifie qu'aucun message ne peut y être ajouté.
forbidden (403) liveChatEnded Le chat en direct spécifié n'est plus en direct.
invalidValue (400) messageTextInvalid Le texte du message (snippet.textMessageDetails.messageText) n'est pas valide.
notFound (404) liveChatNotFound Le chat en direct identifié dans la requête API n'existe pas. Cette erreur se produit si le chat a été supprimé par le propriétaire.
required (400) liveChatIdRequired La ressource liveChatMessage doit inclure et spécifier une valeur pour la propriété snippet.liveChatId.
required (400) messageTextRequired La ressource liveChatMessage doit inclure et spécifier une valeur pour la propriété snippet.textMessageDetails.messageText.
required (400) typeRequired La ressource liveChatMessage doit inclure et spécifier une valeur pour la propriété snippet.type. Définissez la valeur du paramètre sur text.
required (400) preconditionCheckFailed Un sondage actif épinglé existe déjà.
rateLimitExceeded rateLimitExceeded L'utilisateur a publié trop de messages de chat dans un délai donné.

Essayer

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