Google Chat API

Interfejs Google Chat API umożliwia tworzenie aplikacji do Google Chat, które pozwalają integrować usługi z Google Chat i zarządzać zasobami Google Chat, takimi jak pokoje, informacje o uczestnikach rozmów oraz wiadomości.

Usługa: chat.googleapis.com

Zalecamy wywołanie tej usługi przy użyciu dostarczonych przez Google bibliotek klienta. Jeśli aplikacja musi wywoływać tę usługę przy użyciu własnych bibliotek, podczas tworzenia żądań interfejsu API należy używać poniższych informacji.

Dokument opisujący

Dokument opisujący to specyfikacja w formacie czytelnym dla komputerów, opisująca interfejsy API REST i sposób ich używania. Służy do tworzenia bibliotek klienta, wtyczek IDE i innych narzędzi, które współdziałają z interfejsami API Google. Jedna usługa może udostępniać wiele dokumentów opisujących. Ta usługa dostarcza następujący dokument opisujący interfejs API:

Punkt końcowy usługi

Punkt końcowy usługi to podstawowy adres URL, który określa adres sieciowy usługi interfejsu API. Jedna usługa może mieć wiele punktów końcowych. Ta usługa ma następujący punkt końcowy i wszystkie poniższe identyfikatory URI odnoszą się do niego:

  • https://chat.googleapis.com

Zasób REST: v1.customEmojis

Metody
create POST /v1/customEmojis
Tworzy niestandardowy emotikon.
delete DELETE /v1/{name=customEmojis/*}
Usuwa niestandardowy emotikon.
get GET /v1/{name=customEmojis/*}
Zwraca szczegółowe informacje o niestandardowym emotikonie.
list GET /v1/customEmojis
Wyświetla listę niestandardowych emotikonów widocznych dla uwierzytelnionego użytkownika.

Zasób REST: v1.media

Metody
download GET /v1/media/{resourceName=**}
Pobiera multimedia.
upload POST /upload/v1/{parent=spaces/*}/attachments:upload
Przesyła załącznik.

Zasób REST: v1.spaces

Metody
completeImport POST /v1/{name=spaces/*}:completeImport
Kończy proces importowania określonego pokoju i udostępnia go użytkownikom.
create POST /v1/spaces
Tworzy pokój.
delete DELETE /v1/{name=spaces/*}
Usuwa nazwany pokój.
findDirectMessage GET /v1/spaces:findDirectMessage
Zwraca istniejący czat z określonym użytkownikiem.
findGroupChats GET /v1/spaces:findGroupChats
Zwraca wszystkie pokoje z spaceType == GROUP_CHAT, których użytkownicy to dokładnie wywołujący użytkownik i użytkownicy określeni w FindGroupChatsRequest.users.
get GET /v1/{name=spaces/*}
Zwraca szczegółowe informacje o pokoju.
list GET /v1/spaces
Wyświetla listę pokoi, do których należy rozmówca.
patch PATCH /v1/{space.name=spaces/*}
Aktualizuje pokój.
search GET /v1/spaces:search
Zwraca listę pokoi w organizacji Google Workspace.
setup POST /v1/spaces:setup
Tworzy pokój i dodaje do niego określonych użytkowników.

Zasób REST: v1.spaces.members

Metody
create POST /v1/{parent=spaces/*}/members
Tworzy subskrypcję dla wywołującej aplikacji Google Chat, użytkownika lub grupy dyskusyjnej Google.
delete DELETE /v1/{name=spaces/*/members/*}
Usuwa subskrypcję.
get GET /v1/{name=spaces/*/members/*}
Zwraca szczegółowe informacje o subskrypcji.
list GET /v1/{parent=spaces/*}/members
Wyświetla listę użytkowników pokoju.
patch PATCH /v1/{membership.name=spaces/*/members/*}
Aktualizuje subskrypcję.

Zasób REST: v1.spaces.messagePins

Metody
create POST /v1/{parent=spaces/*}/messagePins
Tworzy przypięcie wiadomości.
delete DELETE /v1/{name=spaces/*/messagePins/*}
Usuwa przypięcie wiadomości.
list GET /v1/{parent=spaces/*}/messagePins
Wyświetla listę przypiętych wiadomości w pokoju.

Zasób REST: v1.spaces.messages

Metody
create POST /v1/{parent=spaces/*}/messages
Tworzy wiadomość w pokoju Google Chat.
delete DELETE /v1/{name=spaces/*/messages/*}
Usuwa wiadomość.
get GET /v1/{name=spaces/*/messages/*}
Zwraca szczegółowe informacje o wiadomości.
list GET /v1/{parent=spaces/*}/messages
Wyświetla listę wiadomości w pokoju, którego rozmówca jest członkiem, w tym wiadomości od zablokowanych użytkowników i z zablokowanych pokoi.
patch PATCH /v1/{message.name=spaces/*/messages/*}
Aktualizuje wiadomość.
replaceCards POST /v1/{name=spaces/*/messages/*}:replaceCards
Zastępuje karty zawarte w wiadomości.
search POST /v1/{parent=spaces/*}/messages:search
Wyszukuje wiadomości w Google Chat, do których użytkownik wywołujący ma dostęp.
update PUT /v1/{message.name=spaces/*/messages/*}
Aktualizuje wiadomość.

Zasób REST: v1.spaces.messages.attachments

Metody
get GET /v1/{name=spaces/*/messages/*/attachments/*}
Pobiera metadane załącznika do wiadomości.

Zasób REST: v1.spaces.messages.reactions

Metody
create POST /v1/{parent=spaces/*/messages/*}/reactions
Tworzy reakcję i dodaje ją do wiadomości.
delete DELETE /v1/{name=spaces/*/messages/*/reactions/*}
Usuwa reakcję na wiadomość.
list GET /v1/{parent=spaces/*/messages/*}/reactions
Wyświetla listę reakcji na wiadomość.

Zasób REST: v1.spaces.spaceEvents

Metody
get GET /v1/{name=spaces/*/spaceEvents/*}
Zwraca zdarzenie z pokoju Google Chat.
list GET /v1/{parent=spaces/*}/spaceEvents
Wyświetla listę zdarzeń z pokoju Google Chat.

Zasób REST: v1.users.availability

Metody
get GET /v1/{name=users/*/availability}
Zwraca informacje o dostępności użytkownika w Google Chat.
markAsActive POST /v1/{name=users/*/availability}:markAsActive
Oznacza użytkownika jako ACTIVE w Google Chat.
markAsAway POST /v1/{name=users/*/availability}:markAsAway
Oznacza użytkownika jako AWAY w Google Chat.
markAsDoNotDisturb POST /v1/{name=users/*/availability}:markAsDoNotDisturb
Oznacza użytkownika jako DO_NOT_DISTURB w Google Chat.
patch PATCH /v1/{availability.name=users/*/availability}
Aktualizuje informacje o dostępności użytkownika.

Zasób REST: v1.users.sections

Metody
create POST /v1/{parent=users/*}/sections
Tworzy sekcję w Google Chat.
delete DELETE /v1/{name=users/*/sections/*}
Usuwa sekcję typu CUSTOM_SECTION.
list GET /v1/{parent=users/*}/sections
Wyświetla listę sekcji dostępnych dla użytkownika Google Chat.
patch PATCH /v1/{section.name=users/*/sections/*}
Aktualizuje sekcję.
position POST /v1/{name=users/*/sections/*}:position
Zmienia kolejność sortowania sekcji.

Zasób REST: v1.users.sections.items

Metody
list GET /v1/{parent=users/*/sections/*}/items
Wyświetla listę elementów w sekcji.
move POST /v1/{name=users/*/sections/*/items/*}:move
Przenosi element z jednej sekcji do innej.

Zasób REST: v1.users.spaces

Metody
getSpaceReadState GET /v1/{name=users/*/spaces/*/spaceReadState}
Zwraca szczegółowe informacje o stanie odczytu użytkownika w pokoju, które służą do identyfikowania przeczytanych i nieprzeczytanych wiadomości.
updateSpaceReadState PATCH /v1/{spaceReadState.name=users/*/spaces/*/spaceReadState}
Aktualizuje stan odczytu użytkownika w pokoju, który służy do identyfikowania przeczytanych i nieprzeczytanych wiadomości.

Zasób REST: v1.users.spaces.spaceNotificationSetting

Metody
get GET /v1/{name=users/*/spaces/*/spaceNotificationSetting}
Pobiera ustawienie powiadomień o pokoju.
patch PATCH /v1/{spaceNotificationSetting.name=users/*/spaces/*/spaceNotificationSetting}
Aktualizuje ustawienia powiadomień w pokoju.

Zasób REST: v1.users.spaces.threads

Metody
getThreadReadState GET /v1/{name=users/*/spaces/*/threads/*/threadReadState}
Zwraca szczegółowe informacje o stanie odczytu wątku przez użytkownika, które służą do identyfikowania przeczytanych i nieprzeczytanych wiadomości.