LiveChatMessages: insert
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Dodaje wiadomość lub ankietę do czatu na żywo.
Typowe zastosowania
Żądanie
Żądanie HTTP
POST https://www.googleapis.com/youtube/v3/liveChat/messages
Autoryzacja
To żądanie wymaga autoryzacji z co najmniej jednym z tych zakresów. Więcej informacji o uwierzytelnianiu i autoryzacji znajdziesz w artykule Wdrażanie uwierzytelniania OAuth 2.0.
Zakres |
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
Parametry
W tabeli poniżej znajdziesz listę parametrów obsługiwanych przez to zapytanie. Wszystkie wymienione parametry są parametrami zapytania.
Parametry |
Parametry wymagane |
part |
string Parametr part służy do 2 celów. Określa właściwości, które zostaną ustawione przez operację zapisu, a także właściwości, które będą uwzględnione w odpowiedzi interfejsu API. Ustaw wartość parametru na snippet . |
Treść żądania
W treści żądania podaj zasób liveChatMessage.
W przypadku tego zasobu musisz podać wartości tych właściwości
snippet.liveChatId
snippet.type
– wybierz jedną z tych opcji: textMessageEvent
lub pollEvent
- Jeśli typ to
textMessageEvent
, dodaj snippet.textMessageDetails.messageText
- Jeśli typ to
pollEvent
, podaj wartość snippet.pollDetails
z tymi wartościami:
snippet.pollDetails.metadata.options.questionText
- Lista
snippet.pollDetails.metadata.options.optionText
. Musisz podać co najmniej 2 i nie więcej niż 5 elementów. Elementy są wyświetlane w kolejności, w której się znajdują.
Błędy
W tabeli poniżej znajdziesz komunikaty o błędach, które interfejs API może zwrócić w odpowiedzi na wywołanie tej metody. Więcej informacji znajdziesz w artykule Błędy interfejsu YouTube Live Streaming API.
Typ błędu |
Szczegóły błędu |
Opis |
forbidden (403) |
forbidden |
Nie masz uprawnień wymaganych do utworzenia określonej wiadomości. |
forbidden (403) |
liveChatDisabled |
Właściciel wyłączył określony czat na żywo, co oznacza, że nie można dodawać do niego wiadomości. |
forbidden (403) |
liveChatEnded |
Wskazany czat na żywo nie jest już aktywny. |
invalidValue (400) |
messageTextInvalid |
Tekst wiadomości (snippet.textMessageDetails.messageText ) jest nieprawidłowy. |
notFound (404) |
liveChatNotFound |
Czat na żywo wskazany w żądaniu interfejsu API nie istnieje. Ten błąd występuje, gdy czat został usunięty przez właściciela. |
required (400) |
liveChatIdRequired |
Zasób liveChatMessage musi zawierać i określać wartość właściwości snippet.liveChatId . |
required (400) |
messageTextRequired |
Zasób liveChatMessage musi zawierać i określać wartość właściwości snippet.textMessageDetails.messageText . |
required (400) |
typeRequired |
Zasób liveChatMessage musi zawierać i określać wartość właściwości snippet.type . Ustaw wartość parametru na text |
required (400) |
preconditionCheckFailed |
Zaznaczona aktywna ankieta już istnieje. |
rateLimitExceeded |
rateLimitExceeded |
Użytkownik opublikował zbyt wiele wiadomości czatu w danym przedziale czasu. |
Wypróbuj
Użyj adresu APIs Explorer, aby wywołać ten interfejs API i zobaczyć żądanie oraz odpowiedź interfejsu API.
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0, a fragmenty kodu są dostępne na licencji Apache 2.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2025-01-02 UTC.
[null,null,["Ostatnia aktualizacja: 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."]]