LiveChatMessages: insert
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Ajoute un message ou un sondage à un chat en direct.
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.
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 |
string
Le paramètre part a deux fonctions. Il identifie les propriétés que l'opération d'écriture définira, ainsi que les propriétés 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
, ajoutez snippet.textMessageDetails.messageText
.
- Si le type est
pollEvent
, incluez snippet.pollDetails
avec les valeurs suivantes :
snippet.pollDetails.metadata.options.questionText
- Liste de
snippet.pollDetails.metadata.options.optionText
. Vous devez indiquer au moins deux éléments et pas plus de cinq. Les éléments sont affichés de manière séquentielle dans l'ordre dans lequel ils sont listés.
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) |
forbidden |
Vous ne disposez pas des autorisations requises pour créer le message spécifié. |
forbidden (403) |
liveChatDisabled |
Le chat en direct spécifié a été désactivé par le propriétaire. Par conséquent, vous ne pouvez pas y ajouter de messages. |
forbidden (403) |
liveChatEnded |
Le chat en direct spécifié n'est plus actif. |
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 Chat sur une période donnée. |
Essayer
Utilisez APIs Explorer pour appeler cette API et afficher la requête et la réponse de l'API.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/01/02 (UTC).
[null,null,["Dernière mise à jour le 2025/01/02 (UTC)."],[],[],null,["# LiveChatMessages: insert\n\nAdds a message or a poll to a live chat.\n\nCommon use cases\n----------------\n\nThe list below shows common use cases for this method. Hover over a use case to see its description, or click on a use case to load sample parameter values in the APIs Explorer. You can open the [fullscreen APIs Explorer](#) to see code samples that dynamically update to reflect the parameter values entered in the Explorer.\n\nThe table below shows common use cases for this method. You can click on a use case name to load sample parameter values in the APIs Explorer. Or you can see code samples for a use case in the fullscreen APIs Explorer by clicking on the code icon below a use case name. In the fullscreen UI, you can update parameter and property values and the code samples will dynamically update to reflect the values you enter. \nThis method has one common use case, which is described below. The buttons below the description populate the APIs Explorer with sample values or open the fullscreen APIs Explorer to show code samples that use those values. The code samples also dynamically update if you change the values.\n\n\u003cbr /\u003e\n\nRequest\n-------\n\n### HTTP request\n\n```\nPOST https://www.googleapis.com/youtube/v3/liveChat/messages\n```\n\n### Authorization\n\nThis request requires authorization with at least one of the following scopes. To read more about authentication and authorization, see [Implementing OAuth 2.0 authentication](/youtube/v3/live/authentication).\n\n| Scope |\n|-----------------------------------------------------|\n| `https://www.googleapis.com/auth/youtube` |\n| `https://www.googleapis.com/auth/youtube.force-ssl` |\n\n### Parameters\n\nThe following table lists the parameters that this query supports. All of the parameters listed are query parameters.\n\n| Parameters ||\n|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| **Required parameters** |||\n| `part` | `string` The **part** parameter serves two purposes. It identifies the properties that the write operation will set as well as the properties that the API response will include. Set the parameter value to `snippet`. |\n\n### Request body\n\nProvide a [liveChatMessage resource](/youtube/v3/live/docs/liveChatMessages#resource) in the request body.\nFor that resource, you must specify values for these properties\n\n- `snippet.liveChatId`\n- `snippet.type` - choose one of the following options: `textMessageEvent` or `pollEvent`\n- If type is `textMessageEvent`, include `snippet.textMessageDetails.messageText`\n- If type is `pollEvent`, include `snippet.pollDetails` with the following values:\n - `snippet.pollDetails.metadata.options.questionText`\n - List of `snippet.pollDetails.metadata.options.optionText`. You must list at least two items and no more than four items. Items are displayed sequentially in the order they're listed.\n\nResponse\n--------\n\nIf successful, this method returns a [liveChatMessage resource](/youtube/v3/live/docs/liveChatMessages#resource) in the response body.\n\nErrors\n------\n\nThe following table identifies error messages that the API could return in response to a call to this method. For more details, see [YouTube Live Streaming API - Errors](/youtube/v3/live/docs/errors).\n\n| Error type | Error detail | Description |\n|----------------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `forbidden (403)` | `forbidden` | You don't have the permissions required to create the specified message. |\n| `forbidden (403)` | `liveChatDisabled` | The specified live chat has been disabled by the owner, which means messages cannot be added to the chat. |\n| `forbidden (403)` | `liveChatEnded` | The specified live chat is no longer live. |\n| `invalidValue (400)` | `messageTextInvalid` | The message text (`snippet.textMessageDetails.messageText`) is not valid. |\n| `notFound (404)` | `liveChatNotFound` | The live chat identified in the API request does not exist. This error occurs if the chat has been deleted by the owner. |\n| `required (400)` | `liveChatIdRequired` | The [liveChatMessage resource](/youtube/v3/live/docs/liveChatMessages#resource) must include and specify a value for the `snippet.liveChatId` property. |\n| `required (400)` | `messageTextRequired` | The [liveChatMessage resource](/youtube/v3/live/docs/liveChatMessages#resource) must include and specify a value for the `snippet.textMessageDetails.messageText` property. |\n| `required (400)` | `typeRequired` | The [liveChatMessage resource](/youtube/v3/live/docs/liveChatMessages#resource) must include and specify a value for the `snippet.type` property. Set the parameter value to `text` |\n| `required (400)` | `preconditionCheckFailed` | A pinned active poll already exists. |\n| `rateLimitExceeded` | `rateLimitExceeded` | The user has posted too many chat messages in a given timeframe. |\n\nTry it!\n-------\n\nUse the APIs Explorer to call this API and see the API request and response."]]