В этом разделе объясняется, как приложение Google Chat может вызывать API Chat, который позволяет приложениям Chat выполнять такие действия, как создание пространства, добавление в него людей и публикацию сообщения без запроса события взаимодействия приложения Chat .
Аутентификация
Для асинхронного вызова Chat API требуется проверка подлинности. Каждый метод Chat API требует либо аутентификации пользователя (для выполнения действий или доступа к данным от имени пользователя), либо аутентификации приложения (для выполнения действий или доступа к данным в качестве приложения Chat). Некоторые методы поддерживают как аутентификацию пользователя, так и аутентификацию приложения.
Дополнительные сведения об аутентификации в чате см. в разделе Обзор аутентификации .
Ресурсы и методы API
Ресурсы и методы REST предоставляют асинхронный доступ к пространствам чата, участникам пространства, сообщениям, реакциям на сообщения и вложениям сообщений.
- Пространства
Пространства — это места, где люди и приложения могут общаться и обмениваться файлами. Есть несколько типов помещений. Прямые сообщения (DM) — это разговоры один на один между двумя пользователями или пользователем и приложением чата. Групповые чаты — это разговоры между тремя или более пользователями и приложениями чата. Именованные пространства — это постоянные места, где люди отправляют сообщения, обмениваются файлами и сотрудничают.
Ресурс
spaces
представляет собой пространство.Пространства поддерживают следующие методы:
- Создайте пространство — место, где люди и приложения смогут общаться и обмениваться файлами.
- Настройте пространство , чтобы создать пространство, и добавьте в него людей и приложения чата.
- Получите пространство , чтобы просмотреть подробную информацию о нем.
- Перечислите пространства, чтобы просмотреть постраничный фильтруемый список пространств.
- Обновите пространство , чтобы изменить его атрибуты, такие как отображаемое пользователем имя, описание и рекомендации.
- Удалите пробел , когда он больше не нужен.
- Найдите прямое сообщение (DM), чтобы вернуть DM между двумя пользователями или DM между пользователем и вызывающими приложениями чата.
- Члены
Участники — это пользователи и приложения Chat, которые присоединились к пространству или были приглашены в него.
Ресурс
spaces.members
представляет члена.Участники поддерживают следующие методы:
- Создайте членство , чтобы добавить пользователя или приложение в пространство.
- Получите членство , чтобы увидеть подробную информацию о членстве.
- Перечислите участников, чтобы просмотреть постраничный фильтруемый список участников в пространстве.
- Обновите членство , чтобы изменить атрибуты членства, например изменить члена пространства на менеджера пространства или изменить менеджера пространства на участника пространства.
- Удалите членство , чтобы удалить пользователя или приложение из пространства.
- Сообщения
Сообщения включают в себя текстовые сообщения и карточки , размещенные в местах. К сообщениям могут быть прикреплены файлы. Люди могут реагировать на сообщения, добавляя к ним смайлы.
Ресурс
spaces.messages
представляет сообщение.Сообщения поддерживают следующие методы:
- Создайте сообщение , чтобы опубликовать текстовое сообщение или карточку . Вы также можете начать ветку сообщений или ответить на нее .
- Получите сообщение, чтобы получить подробную информацию о сообщении, например, когда оно было отправлено или что в нем говорится.
- Перечислите сообщения, чтобы просмотреть постраничный фильтруемый список сообщений в пространстве.
- Обновите сообщение , чтобы изменить его атрибуты, например то, что в нем говорится. Вы также можете добавить текст к сообщению с карточкой или карточку к текстовому сообщению .
- Удалите сообщение , когда оно больше не нужно.
- Реакции
Реакции представляют собой смайлы, которые люди используют для реакции на сообщение, например 👍, 🚲 и 🌞.
Ресурс
spaces.messages.reactions
представляет собой реакцию.Реакции поддерживают следующие методы:
- Создайте реакцию , чтобы добавить смайлик в сообщение.
- Перечислите реакции, чтобы просмотреть постраничный фильтруемый список реакций на сообщение.
- Удалите реакцию , чтобы удалить смайлик из сообщения.
- Медиа и вложения
Медиафайл представляет собой файл, загруженный в Google Chat, например изображения, видео и документы.
media
ресурс представляет собой медиафайлы, прикрепленные к сообщениям.Вложения — это экземпляры медиафайлов, прикрепленных к сообщениям.
Ресурс
spaces.messages.attachments
представляет собой вложение. Вложение включает в себя медиафайлы и связанные с ними метаданные, прикрепленные к сообщению.Медиафайлы и вложения поддерживают следующие методы:
- Загрузите медиафайл в виде вложения , чтобы загрузить его в Google Chat, а затем прикрепить его к сообщению.
- Загрузите медиафайл в виде вложения , чтобы загрузить медиафайлы из Google Chat в виде двоичного файла.
- Получить вложение , чтобы получить метаданные о вложении сообщения.
- Космические события
События пространства представляют собой изменения в пространстве или его дочерних ресурсах, включая его участников, сообщения и реакции.
Ресурс
spaces.spaceEvent
представляет космическое событие.Космические события поддерживают следующие методы:
- Получите космическое событие , чтобы получить подробную информацию о событии, произошедшем в пространстве.
- Список событий пространства , чтобы получить список событий, произошедших в пространстве.
- Состояния чтения пользователя
Состояния чтения пользователя — это одноэлементные ресурсы, которые представляют сведения о последнем прочитанном сообщении определенного пользователя в чате Google или цепочке сообщений.
Ресурс
users.spaces
представляет состояние чтения пользователя в пространстве.users.spaces.threads
представляет состояние чтения пользователя в потоке сообщений.Пользовательские состояния чтения поддерживают следующие методы:
- Получите состояние чтения пространства , чтобы получить подробную информацию о состоянии чтения пользователя в пространстве.
- Обновить состояние чтения пространства , чтобы обновить состояние чтения пользователя в пространстве.
- Получите состояние чтения потока , чтобы получить подробную информацию о состоянии чтения пользователя в потоке.