В этом руководстве объясняется, как использовать метод update()
ресурса Message
API Google Chat для обновления текстового сообщения или сообщения-карточки в пространстве. Обновите сообщение, чтобы изменить атрибуты сообщения, например, его содержание или содержимое карточки. Вы также можете добавить текстовое сообщение к сообщению с карточкой или добавить карточку к текстовому сообщению.
В API чата сообщение чата представлено ресурсом Message
. Хотя пользователи чата могут отправлять только текстовые сообщения, приложения чата могут использовать множество других функций обмена сообщениями, включая отображение статических или интерактивных пользовательских интерфейсов, сбор информации от пользователей и частную доставку сообщений. Дополнительную информацию о функциях обмена сообщениями, доступных для Chat API, см. в обзоре сообщений Google Chat .
Предварительные условия
Node.js
- Аккаунт Google Workspace для бизнеса или предприятия с доступом к Google Chat .
- Настройте свою среду:
- Создайте проект Google Cloud .
- Настройте экран согласия OAuth .
- Включите и настройте API Google Chat , указав имя, значок и описание для вашего приложения Chat.
- Установите облачную клиентскую библиотеку Node.js.
- Создайте учетные данные доступа в зависимости от того, как вы хотите пройти аутентификацию в запросе к API Google Chat:
- Чтобы пройти аутентификацию в качестве пользователя Chat, создайте учетные данные идентификатора клиента OAuth и сохраните их в виде файла JSON с именем
client_secrets.json
в локальном каталоге. - Чтобы пройти аутентификацию в качестве приложения Chat, создайте учетные данные учетной записи службы и сохраните их в виде файла JSON с именем
credentials.json
.
- Чтобы пройти аутентификацию в качестве пользователя Chat, создайте учетные данные идентификатора клиента OAuth и сохраните их в виде файла JSON с именем
- Выберите область авторизации в зависимости от того, хотите ли вы пройти аутентификацию как пользователь или приложение Chat.
Питон
- Аккаунт Google Workspace для бизнеса или предприятия с доступом к Google Chat .
- Настройте свою среду:
- Создайте проект Google Cloud .
- Настройте экран согласия OAuth .
- Включите и настройте API Google Chat , указав имя, значок и описание для вашего приложения Chat.
- Установите облачную клиентскую библиотеку Python.
- Создайте учетные данные доступа в зависимости от того, как вы хотите пройти аутентификацию в запросе к API Google Chat:
- Чтобы пройти аутентификацию в качестве пользователя Chat, создайте учетные данные идентификатора клиента OAuth и сохраните их в виде файла JSON с именем
client_secrets.json
в локальном каталоге. - Чтобы пройти аутентификацию в качестве приложения Chat, создайте учетные данные учетной записи службы и сохраните их в виде файла JSON с именем
credentials.json
.
- Чтобы пройти аутентификацию в качестве пользователя Chat, создайте учетные данные идентификатора клиента OAuth и сохраните их в виде файла JSON с именем
- Выберите область авторизации в зависимости от того, хотите ли вы пройти аутентификацию как пользователь или приложение Chat.
Ява
- Аккаунт Google Workspace для бизнеса или предприятия с доступом к Google Chat .
- Настройте свою среду:
- Создайте проект Google Cloud .
- Настройте экран согласия OAuth .
- Включите и настройте API Google Chat , указав имя, значок и описание для вашего приложения Chat.
- Установите облачную клиентскую библиотеку Java.
- Создайте учетные данные доступа в зависимости от того, как вы хотите пройти аутентификацию в запросе к API Google Chat:
- Чтобы пройти аутентификацию в качестве пользователя Chat, создайте учетные данные идентификатора клиента OAuth и сохраните их в виде файла JSON с именем
client_secrets.json
в локальном каталоге. - Чтобы пройти аутентификацию в качестве приложения Chat, создайте учетные данные учетной записи службы и сохраните их в виде файла JSON с именем
credentials.json
.
- Чтобы пройти аутентификацию в качестве пользователя Chat, создайте учетные данные идентификатора клиента OAuth и сохраните их в виде файла JSON с именем
- Выберите область авторизации в зависимости от того, хотите ли вы пройти аутентификацию как пользователь или приложение Chat.
Скрипт приложений
- Аккаунт Google Workspace для бизнеса или предприятия с доступом к Google Chat .
- Настройте свою среду:
- Создайте проект Google Cloud .
- Настройте экран согласия OAuth .
- Включите и настройте API Google Chat , указав имя, значок и описание для вашего приложения Chat.
- Создайте автономный проект Apps Script и включите расширенную службу чата .
- В этом руководстве вы должны использовать аутентификацию пользователя или приложения . Для аутентификации в качестве приложения Chat создайте учетные данные сервисной учетной записи. Инструкции см. в разделе Аутентификация и авторизация в качестве приложения Google Chat .
- Выберите область авторизации в зависимости от того, хотите ли вы пройти аутентификацию как пользователь или приложение Chat.
Обновление сообщения от имени пользователя
При аутентификации пользователя можно обновить только текст сообщения.
Чтобы обновить сообщение с аутентификацией пользователя, передайте в запросе следующее:
- Укажите область авторизации
chat.messages
. - Вызовите метод
UpdateMessage()
. - Передайте
message
как экземплярMessage
со следующим:- Поле
name
содержит сообщение, которое необходимо обновить, включая идентификатор пространства и идентификатор сообщения. -
text
поле с новым текстом.
- Поле
- Передайте
updateMask
со значениемtext
.
Если обновленное сообщение представляет собой карточное сообщение , то текст добавляется к карточкам (которые продолжают отображаться).
Вот как обновить сообщение или добавить текстовое сообщение к сообщению карты с аутентификацией пользователя :
Node.js
Питон
Ява
Скрипт приложений
Чтобы запустить этот пример, замените следующее:
-
SPACE_NAME
: идентификатор изname
пространства. Вы можете получить идентификатор, вызвав методListSpaces()
или по URL-адресу пространства. -
MESSAGE_NAME
: идентификатор изname
сообщения. Вы можете получить идентификатор из тела ответа, возвращенного после асинхронного создания сообщения с помощью Chat API, или с помощью пользовательского имени, назначенного сообщению при создании.
API чата возвращает экземпляр Message
с подробным описанием обновленного сообщения.
Обновить сообщение как приложение Chat
С помощью аутентификации приложения можно обновить как текст, так и карточки сообщения.
Чтобы обновить сообщение с помощью аутентификации приложения, передайте в запросе следующее:
- Укажите область авторизации
chat.bot
. - Вызовите метод
UpdateMessage()
. - Передайте
message
как экземплярMessage
со следующим:- Поле
name
содержит сообщение, которое необходимо обновить, включая идентификатор пространства и идентификатор сообщения. -
text
поле с новым текстом, если его необходимо обновить. - Поле
cardsV2
содержит новые карты, если их необходимо обновить.
- Поле
- Передайте
updateMask
со списком полей для обновлений, таких какtext
иcardsV2
.
Если обновленное сообщение является сообщением-карточкой и текст обновлен, то обновленный текст добавляется к карточкам (которые продолжают отображаться). Если обновленное сообщение является текстовым сообщением и карточки обновлены, обновленные карточки добавляются к тексту (который продолжает отображаться).
Вот как обновить текст и карточки сообщения с помощью аутентификации приложения :
Node.js
Питон
Ява
Скрипт приложений
Чтобы запустить этот пример, замените следующее:
-
SPACE_NAME
: идентификатор изname
пространства. Вы можете получить идентификатор, вызвав методListSpaces()
или по URL-адресу пространства. -
MESSAGE_NAME
: идентификатор изname
сообщения. Вы можете получить идентификатор из тела ответа, возвращенного после асинхронного создания сообщения с помощью Chat API, или с помощью пользовательского имени, назначенного сообщению при создании.
API чата возвращает экземпляр Message
с подробным описанием обновленного сообщения.
Связанные темы
- Отформатируйте сообщение .
- Удалить сообщение .
- Получите подробную информацию о сообщении .
- Список сообщений в пространстве .
- Отправить сообщение .