LiveChatMessages: insert

Dodaje wiadomość lub ankietę do czatu na żywo.

Wpływ na limit: wywołanie tej metody ma koszt limitu wynoszący 20 jednostek.

Częste zastosowania

Żądanie

Żądanie HTTP

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

Autoryzacja

To żądanie wymaga autoryzacji z użyciem co najmniej jednego z tych zakresów. Więcej informacji o uwierzytelnianiu i autoryzacji znajdziesz w artykule Implementowanie 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 pełni 2 funkcje. Określa właściwości, które zostaną ustawione przez operację zapisu, oraz właściwości, które zostaną 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 określić 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, dodaj obiekt snippet.pollDetails o takiej strukturze:
    • snippet.pollDetails.metadata.questionText (ciąg znaków): główne pytanie w ankiecie.
    • snippet.pollDetails.metadata.options (tablica): lista obiektów opcji.
    • Wymagania: musisz podać co najmniej 2 i co najwyżej 4 elementy.
    • Kolejność: elementy są wyświetlane kolejno w takiej samej kolejności, w jakiej zostały podane.
    • Każdy obiekt w tablicy musi zawierać:
      • optionText (ciąg znaków): tekst wyświetlany w przypadku wyboru tej opcji w ankiecie.

Odpowiedź

Jeśli operacja się uda, ta metoda zwróci w treści odpowiedzi zasób liveChatMessage.

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 YouTube Live Streaming API – błędy.

Typ błędu Szczegóły błędu Opis
forbidden (403) forbidden Nie masz uprawnień wymaganych do utworzenia określonej wiadomości.
forbidden (403) liveChatDisabled Określony czat na żywo został wyłączony przez właściciela, co oznacza, że nie można dodawać do niego wiadomości.
forbidden (403) liveChatEnded Określony 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 określony w żądaniu do interfejsu API nie istnieje. Ten błąd występuje, jeśli czat został usunięty przez właściciela.
required (400) liveChatIdRequired Zasób liveChatMessage musi zawierać właściwość snippet.liveChatId i określać jej wartość.
required (400) messageTextRequired Zasób liveChatMessage musi zawierać właściwość snippet.textMessageDetails.messageText i określać jej wartość.
required (400) typeRequired Zasób liveChatMessage musi zawierać właściwość snippet.type i określać jej wartość. Ustaw wartość parametru na text
required (400) preconditionCheckFailed Istnieje już przypięta aktywna ankieta.
rateLimitExceeded rateLimitExceeded Użytkownik opublikował zbyt wiele wiadomości na czacie w danym przedziale czasu.

Wypróbuj

Aby wywołać ten interfejs API i zobaczyć żądanie do interfejsu API oraz odpowiedź, użyj APIs Explorer.