Разрабатывайте с помощью Google Chat

На этой странице представлен обзор API Google Chat и приложений Google Chat.

Обзор API Google Chat

API чата состоит из служб gRPC или ресурсов REST и методов , которые предоставляют доступ к чату, включая пространства, участников пространств, сообщения, реакции на сообщения, вложения сообщений, события пространств и состояния чтения пользователей.

Концепции

В следующем разделе определяются службы, ресурсы и методы для API чата:

Пространства

Пространства — это места, где люди и приложения могут общаться и обмениваться файлами. Существует несколько типов пространств. Личные сообщения (DM) — это общение один на один между двумя пользователями или пользователем и приложением Chat. Групповые чаты — это общение между тремя или более пользователями и приложениями Chat. Именованные пространства — это постоянные места, где люди отправляют сообщения, делятся файлами и работают вместе.

Ссылка на ресурс:

Пример использования см.:

Участники

Участники — это пользователи и чат-приложения, которые присоединились к пространству или были приглашены в него.

Ссылка на ресурс:

Пример использования см.:

Сообщения

Сообщения включают текстовые сообщения и открытки , публикуемые в чатах. К сообщениям можно прикреплять файлы. Пользователи могут реагировать на сообщения, добавляя к ним эмодзи.

Ссылка на ресурс:

Пример использования см.:

Реакции

Реакции представляют собой эмодзи, которые люди используют для реагирования на сообщение, например, 👍, 🚲 и 🌞.

Ссылка на ресурс:

Пример использования см.:

Пользовательские эмодзи

Пользовательские эмодзи представляют собой пользовательские эмодзи, созданные и распространенные внутри организации в Google Chat. Пользовательские эмодзи можно добавлять в текст сообщения или использовать для реакции на сообщение.

Ссылка на ресурс:

Пример использования см.:

Медиа и вложения

Медиафайлы представляют собой файлы, загруженные в Google Chat, такие как изображения, видео и документы.

Ссылка на медиаресурс (недоступно в RPC):

Вложения — это экземпляры медиафайлов (файлов), прикрепленные к сообщениям.

Ссылка на ресурс:

Пример использования см.:

Космические события

События пространства представляют собой изменения в пространстве или его дочерних ресурсах, включая его участников, сообщения и реакции.

Ссылка на ресурс:

Пример использования см.:

Состояния чтения пользователя

Состояния прочтения пользователя — это одиночные ресурсы, которые содержат сведения о последнем прочитанном сообщении определенного пользователя в чате Google или ветке сообщений.

Ссылка на ресурс состояния чтения пространства:

Ссылка на ресурс состояния чтения потока:

Пример использования см.:

Настройки уведомлений пользовательского пространства

Настройки уведомлений пространства пользователя — это единичные ресурсы, которые представляют заданные настройки уведомлений пользователя в пространстве Google Chat.

Ссылка на ресурс:

Аутентификация

Вызов Chat API требует аутентификации. Каждый метод Chat API требует либо аутентификации пользователя (для выполнения действий или доступа к данным от имени пользователя), либо аутентификации приложения (для выполнения действий или доступа к данным от имени приложения Chat). Некоторые методы поддерживают как аутентификацию пользователя, так и аутентификацию приложения.

Дополнительную информацию об аутентификации в чате см. в разделе Обзор аутентификации .

Клиентские библиотеки

Большинству разработчиков рекомендуется вызывать API Google Chat с помощью наших официально поддерживаемых облачных клиентских библиотек для предпочитаемого вами языка, например Python, Java или Node.js.

Если вы пишете код с помощью Google Apps Script, используйте службу Advanced Chat вместо установки клиентской библиотеки.

Создавайте чат-приложения

API чата позволяет создавать приложения Google Chat, которые позволяют использовать ваши сервисы и ресурсы прямо в Google Chat. Вы можете создавать приложения Chat для выполнения любых из следующих задач:

  • Извлекайте информацию на основе структурированных или свободных текстовых запросов, введенных пользователем.
  • Создание отчетов об инцидентах и других артефактов с использованием информации, предоставленной пользователем.
  • Улучшайте взаимодействие в команде, например, обеспечивая «командную память» или планирование ресурсов.

Вы можете разработать свое приложение чата, используя несколько различных архитектурных стилей, включая следующие:

  • Интерактивные приложения : реагируют на взаимодействие с пользователем, например, на @упоминания или слэш-команды, а также представляют информацию или направляют пользователей по рабочему процессу с помощью карточек и диалогов.
  • Приложения командной строки или веб-перехватчики : отправка упреждающих сообщений, таких как сигналы тревоги или уведомления, из другой системы в пространство. Пользователи не могут напрямую взаимодействовать с приложениями такого типа.
  • Приложения, управляемые событиями : подписывайтесь на активность в чате и реагируйте на неё, например, на присоединение нового участника. В ответ на событие приложение может отправить сообщение или выполнить другое действие.

Подробную информацию о разработке приложения чата см. в разделе Выбор архитектуры приложения Google Chat .

Хотите увидеть API Google Chat в действии?
Канал разработчиков Google Workspace предлагает видеоролики с советами, приемами и новейшими функциями.