W tej sekcji wyjaśniamy, jak aplikacja Google Chat może wywoływać interfejs Chat API, który umożliwia aplikacjom Google Chat wykonywanie takich czynności jak tworzenie pokoju, dodawanie do niego osób i publikowanie wiadomości bez wywołania zdarzenia interakcji z aplikacją.
Uwierzytelnianie
Asynchroniczne wywołanie interfejsu Chat API wymaga uwierzytelnienia. Każda metoda interfejsu Chat API wymaga uwierzytelniania użytkownika (do wykonywania działań lub uzyskiwania dostępu do danych w imieniu użytkownika) albo uwierzytelniania aplikacji (w celu wykonywania działań lub uzyskiwania dostępu do danych jako aplikacji do obsługi czatu). Niektóre metody obsługują zarówno uwierzytelnianie użytkowników, jak i uwierzytelnianie aplikacji.
Więcej informacji o uwierzytelnianiu w Google Chat znajdziesz w artykule Omówienie uwierzytelniania.
Zasoby i metody interfejsu API
Zasoby i metody REST zapewniają asynchroniczny dostęp do pokoi czatu, uczestników pokoi, wiadomości, reakcji na wiadomości oraz załączników do wiadomości.
- Pokoje
Pokoje to miejsca, w których użytkownicy i aplikacje mogą rozmawiać i udostępniać pliki. Jest kilka rodzajów pokoi. Czaty to rozmowy 1:1 między 2 użytkownikami lub użytkownikiem a aplikacją Google Chat. Czaty grupowe to rozmowy między co najmniej 3 użytkownikami a aplikacjami Google Chat. Pokoje nazwane to trwałe miejsca, w których użytkownicy wysyłają wiadomości, udostępniają pliki i współpracują.
Zasób
spacesreprezentuje pokój.Pokoje obsługują te metody:
- Utwórz pokój, w którym użytkownicy i aplikacje będą mogli rozmawiać i udostępniać pliki.
- Skonfiguruj pokój, aby utworzyć pokój i dodać do niego osoby oraz aplikacje Google Chat.
- Utwórz pokój, aby wyświetlić jego szczegóły.
- Lista pokoi, aby wyświetlić podzieloną na strony listę pokoi z możliwością filtrowania.
- aktualizować pokój, aby zmienić jego atrybuty, takie jak wyświetlana nazwa, opis i wytyczne;
- Usuń pokój, gdy nie jest już potrzebny.
- Znajdź czat, aby zwrócić czat między 2 użytkownikami lub czat między użytkownikiem a aplikacjami Google Chat.
- Członkowie
Użytkownicy to użytkownicy i aplikacje Google Chat, którzy dołączyli do pokoju lub zostali do niego zaproszeni.
Zasób
spaces.membersreprezentuje użytkownika.Członkowie obsługują te metody:
- Utwórz członkostwo, aby dodać użytkownika lub aplikację do pokoju.
- Kup subskrypcję, aby zobaczyć szczegóły na jej temat.
- Członkostwa na liście, aby wyświetlić podzieloną na strony i możliwą do filtrowania listę osób w pokoju.
- Zaktualizuj członkostwo, aby zmienić atrybuty osoby w pokoju, np. zmienić użytkownika pokoju w menedżera pokoju lub zmienić menedżera pokoju na osobę w pokoju.
- Usuń subskrypcję, aby usunąć użytkownika lub aplikację z pokoju.
- Wiadomości
Wiadomości obejmują komunikaty tekstowe i karty publikowane w pokojach. Do wiadomości można dołączać pliki. Użytkownicy mogą reagować na wiadomości, dołączając do nich emotikony.
Zasób
spaces.messagesreprezentuje wiadomość.Wiadomości obsługują te metody:
- Utwórz wiadomość, aby opublikować wiadomość tekstową lub kartę. Możesz też rozpocząć wątek wiadomości lub odpowiedzieć na niego.
- Odbierz wiadomość, aby uzyskać szczegółowe informacje na temat wiadomości, np. datę jej wysłania lub jej treść.
- Pokaż listę wiadomości, aby wyświetlić podzieloną na strony listę wiadomości w pokoju, która jest podzielona na strony i można ją filtrować.
- Zaktualizuj wiadomość, aby zmienić jej atrybuty, takie jak jej treść. Możesz też dołączyć tekst do wiadomości w formie karty lub do wiadomości tekstowej.
- Usuń wiadomość, gdy nie jest już potrzebna.
- Reakcje
Reakcje reprezentują emotikony, których użytkownicy używają podczas reakcji na wiadomość, np. 👍, 🚲 i 🌞.
Zasób
spaces.messages.reactionsreprezentuje reakcję.Reakcje obsługują te metody:
- Utwórz reakcję, aby dołączyć emotikon do wiadomości.
- Wyświetl listę reakcji, aby zobaczyć podzieloną na strony listę reakcji na wiadomość z możliwością filtrowania.
- Usuń reakcję, aby usunąć emotikon z wiadomości.
- Multimedia i załączniki
Multimedia to plik przesłany do Google Chat, w tym obrazy, filmy i dokumenty.
Zasób
mediareprezentuje multimedia dołączone do wiadomości.Załączniki to wystąpienia multimediów (plików) załączonych do wiadomości.
Zasób
spaces.messages.attachmentsreprezentuje załącznik. Załącznik zawiera multimedia i powiązane z nimi metadane.Nośniki i załączniki obsługują te metody:
- Prześlij multimedia jako załącznik, aby przesłać je do Google Chat, a potem załączyć je do wiadomości.
- Pobierz multimedia jako załącznik, aby pobrać multimedia z Google Chat jako plik binarny.
- Pobierz załącznik, aby pobrać metadane załącznika wiadomości.
- Wydarzenia na temat pokoju
Zdarzenia z pokoju przedstawiają zmiany w pokoju lub jego zasobach podrzędnych, w tym jego użytkowników, wiadomości i reakcje.
Zasób
spaces.spaceEventreprezentuje zdarzenie w pokoju.Zdarzenia w pokoju obsługują te metody:
- Pobierz zdarzenie pokoju, aby zwrócić szczegółowe informacje o zdarzeniu, które wystąpiło w pokoju.
- Wyświetl listę zdarzeń dotyczących pokoju, aby uzyskać listę zdarzeń, które wystąpiły w pokoju.
- Stany odczytu użytkownika
Stany odczytu użytkownika to pojedyncze zasoby, które przedstawiają szczegółowe informacje o ostatniej przeczytanej wiadomości określonego użytkownika w pokoju Google Chat lub w wątku wiadomości.
Zasób
users.spacesreprezentuje stan odczytu użytkownika w pokoju.Zasób
users.spaces.threadsreprezentuje stan odczytu użytkownika w wątku wiadomości.Stany odczytu użytkownika obsługują te metody:
- Pobierz stan odczytu pokoju, aby zwrócić informacje o stanie odczytu użytkownika w pokoju.
- Aktualizuj stan odczytu pokoju, aby zaktualizować stan odczytu użytkownika w pokoju.
- Uzyskiwanie stanu odczytu wątku, aby zwrócić szczegółowe informacje o stanie odczytu użytkownika w wątku.