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

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

Google Chat API overview

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

Концепции

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

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

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

Resource reference:

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

Члены

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

Справочная информация:

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

Сообщения

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

Справочная информация:

For example usage, see:

Реакции

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

Resource reference:

For example usage, see:

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

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

Resource reference:

For example usage, see:

Медиафайлы и вложения

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

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

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

Справочная информация:

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

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

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

Справочная информация:

For example usage, see:

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

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

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

Thread read state resource reference:

For example usage, see:

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

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

Resource reference:

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

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

Чтобы узнать больше об аутентификации в чате, см. раздел «Обзор аутентификации» .

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

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

Если вы используете Google Apps Script для программирования, воспользуйтесь сервисом Advanced Chat вместо установки клиентской библиотеки.

Build Chat apps

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

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

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

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

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

Хотите увидеть API Google Chat в действии?
На канале Google Workspace Developers вы найдете видеоролики с советами, рекомендациями и информацией о новейших функциях.