LiveChatMessages: insert
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Добавляет сообщение или опрос в чат.
Распространенные случаи использования
Запрос
HTTP-запрос
POST https://www.googleapis.com/youtube/v3/liveChat/messages
Авторизация
Для этого запроса требуется авторизация хотя бы с одной из следующих областей. Дополнительные сведения об аутентификации и авторизации см. в разделе «Реализация аутентификации OAuth 2.0» .
| Объем |
|---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
Параметры
В следующей таблице перечислены параметры, которые поддерживает этот запрос. Все перечисленные параметры являются параметрами запроса.
| Параметры |
|---|
| Обязательные параметры |
part | string
Параметр part служит двум целям. Он определяет свойства, которые будут установлены операцией записи, а также свойства, которые будут включены в ответ API. Установите значение параметра snippet . |
Тело запроса
Укажите ресурс liveChatMessage в теле запроса. Для этого ресурса необходимо указать значения этих свойств.
-
snippet.liveChatId -
snippet.type — выберите один из следующих вариантов: textMessageEvent или pollEvent - Если тип
textMessageEvent , включите snippet.textMessageDetails.messageText - Если тип —
pollEvent , включите snippet.pollDetails со следующими значениями:-
snippet.pollDetails.metadata.options.questionText - Список
snippet.pollDetails.metadata.options.optionText . Вы должны указать не менее двух и не более пяти пунктов. Элементы отображаются последовательно в том порядке, в котором они перечислены.
Ошибки
В следующей таблице указаны сообщения об ошибках, которые API может вернуть в ответ на вызов этого метода. Дополнительные сведения см. в разделе API потоковой передачи YouTube Live — ошибки .
| Тип ошибки | Детализация ошибки | Описание |
|---|
forbidden (403) | forbidden | У вас нет разрешений, необходимых для создания указанного сообщения. |
forbidden (403) | liveChatDisabled | Указанный чат отключен владельцем, поэтому в чат нельзя добавлять сообщения. |
forbidden (403) | liveChatEnded | Указанный чат больше не активен. |
invalidValue (400) | messageTextInvalid | Текст сообщения ( snippet.textMessageDetails.messageText ) недействителен. |
notFound (404) | liveChatNotFound | Онлайн-чат, указанный в запросе API, не существует. Эта ошибка возникает, если чат был удален владельцем. |
required (400) | liveChatIdRequired | Ресурс liveChatMessage должен включать и указывать значение свойства snippet.liveChatId . |
required (400) | messageTextRequired | Ресурс liveChatMessage должен включать и указывать значение свойства snippet.textMessageDetails.messageText . |
required (400) | typeRequired | Ресурс liveChatMessage должен включать и указывать значение свойства snippet.type . Установите значение параметра в text |
required (400) | preconditionCheckFailed | Закрепленный активный опрос уже существует. |
rateLimitExceeded | rateLimitExceeded | Пользователь разместил слишком много сообщений в чате за определенный период времени. |
Попробуйте!
Используйте APIs Explorer для вызова этого API и просмотра запроса и ответа API.
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2025-01-02 UTC.
[null,null,["Последнее обновление: 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."]]
