- Ресурс: Сообщение
- JSON-представление
- Карта
- Заголовок карты
- Стиль изображения
- Раздел
- Разметка виджета
- Текстовый абзац
- Изображение
- OnClick
- ФормаДействие
- Параметр действия
- ОпенЛинк
- КлючЗначение
- Икона
- Кнопка
- ТекстКнопка
- Кнопка изображения
- КартаДействие
- Картасид
- Карта
- Заголовок карты
- Тип изображения
- Раздел
- Виджет
- Текстовый абзац
- Изображение
- OnClick
- Действие
- Параметр действия
- Индикатор нагрузки
- Взаимодействие
- ОпенЛинк
- ОпенАс
- При Закрытии
- ПереполнениеМеню
- ПереполнениеМенюЭлемент
- Икона
- МатериалИконка
- УкрашенныйТекст
- Кнопка
- Цвет
- Тип
- SwitchControl
- Тип управления
- Список кнопок
- ТекстИнпут
- Тип
- Предложения
- ПредложениеItem
- Валидация
- Тип ввода
- ВыборВвод
- Тип выбора
- Элемент выбора
- ПлатформаИсточник данных
- Общий источник данных
- HostAppDataSourceMarkup
- ChatClientDataSourceMarkup
- ПространствоИсточник Данных
- DateTimePicker
- DateTimePickerType
- Разделитель
- Сетка
- Гридитем
- Компонент изображения
- СтильОбрезки Изображения
- ТипОбрезки Изображения
- BorderStyle
- Тип границы
- GridItemLayout
- Столбцы
- Столбец
- Горизонтальныйразмерстиль
- Горизонтальное выравнивание
- Вертикальное выравнивание
- Виджеты
- Список чипов
- Макет
- Чип
- СвернутьControl
- РазделительСтиль
- КартаДействие
- КартаFixedFooter
- Стиль отображения
- Аннотация
- Тип аннотации
- UserMentionМетаданные
- Тип
- СлэшКомандаМетаданные
- Тип
- РичЛинкМетаданные
- РичЛинкТип
- DriveLinkData
- ChatSpaceLinkData
- Нить
- ДействиеОтвет
- Тип ответа
- ДиалогДействие
- Диалог
- Статус действия
- Код
- Обновленный виджет
- Элементы выбора
- СлэшКоманда
- Соответствующий URL
- EmojiРеакцияСводка
- Удаление метаданных
- Тип удаления
- ЦитируемоеСообщениеМетаданные
- ПрикрепленоGif
- АксессуарВиджет
- Методы
Ресурс: Сообщение
Сообщение в чате Google.
JSON-представление |
---|
{ "name": string, "sender": { object ( |
Поля | |
---|---|
name | Имя ресурса сообщения. Формат: Где Если вы задали собственный идентификатор при создании сообщения, вы можете использовать этот идентификатор для указания сообщения в запросе, заменив |
sender | Только вывод. Пользователь, создавший сообщение. Если ваше приложение Chat авторизуется как пользователь , в выходных данных будут указаны |
createTime | Необязательный. Неизменяемый. Для групп, созданных в Chat, — время создания сообщения. Это поле предназначено только для вывода, за исключением случаев, когда оно используется в пространствах режима импорта. Для пространств режима импорта установите в этом поле историческую временную метку создания сообщения в источнике, чтобы сохранить исходное время создания. |
lastUpdateTime | Только вывод. Время, когда сообщение в последний раз редактировалось пользователем. Если сообщение ни разу не редактировалось, это поле пусто. |
deleteTime | Только вывод. Время удаления сообщения в Google Chat. Если сообщение никогда не удаляется, это поле пусто. |
text | Простое текстовое тело сообщения. Первая ссылка на изображение, видео или веб-страницу генерирует чип предварительного просмотра . Вы также можете @упомянуть пользователя Google Chat или всех, кто находится в группе. Дополнительную информацию о создании текстовых сообщений см. в разделе «Отправка сообщения» . |
formattedText | Только вывод. Содержит
Дополнительные сведения см. в разделе Просмотр форматирования текста, отправленного в сообщении. |
cards[] | Устарело: вместо этого используйте Богатые, форматированные и интерактивные карты, которые можно использовать для отображения элементов пользовательского интерфейса, таких как форматированный текст, кнопки и интерактивные изображения. Карточки обычно отображаются под текстовым текстом сообщения. |
cardsV2[] | Массив карт . Только приложения чата могут создавать карточки. Если ваше приложение Chat авторизуется как пользователь , сообщения не могут содержать карточки. Чтобы узнать, как создать сообщение, содержащее карточки, см. раздел «Отправка сообщения» . Создавайте и просматривайте карты с помощью Card Builder. Откройте конструктор карточек |
annotations[] | Только вывод. Аннотации, связанные с |
thread | Поток, которому принадлежит сообщение. Пример использования см . в разделе «Начать цепочку сообщений или ответить на нее» . |
space | Если ваше приложение Chat авторизуется как пользователь , в выходных данных будет указано |
fallbackText | Простое текстовое описание карточек сообщения, используемое, когда фактические карточки невозможно отобразить, например мобильные уведомления. |
actionResponse | Только ввод. Параметры, которые приложение чата может использовать для настройки способа публикации ответа. |
argumentText | Только вывод. Текст сообщения, из которого удалены все упоминания приложения Chat. |
slashCommand | Только вывод. Слэш-команда, если применимо. |
attachment[] | Вложение, загруженное пользователем. |
matchedUrl | Только вывод. URL-адрес в |
threadReply | Только вывод. Если Если пространство не поддерживает ответ в цепочках, это поле всегда имеет |
clientAssignedMessageId | Необязательный. Пользовательский идентификатор сообщения. Вы можете использовать поле для идентификации сообщения или для получения, удаления или обновления сообщения. Чтобы установить собственный идентификатор, укажите поле |
emojiReactionSummaries[] | Только вывод. Список сводок реакций смайликов на сообщение. |
privateMessageViewer | Неизменяемый. Ввод для создания сообщения, в противном случае только вывод. Пользователь, который может просмотреть сообщение. Если этот параметр установлен, сообщение является личным и доступно только указанному пользователю и приложению Chat. Предварительный просмотр ссылок и вложения не поддерживаются для личных сообщений. Только приложения чата могут отправлять личные сообщения. Если ваше приложение чата проверяет подлинность пользователя для отправки сообщения, сообщение не может быть личным и должно опускать это поле. Подробную информацию см. в разделе Отправка сообщения лично . |
deletionMetadata | Только вывод. Информация об удаленном сообщении. Сообщение удаляется, если установлено |
quotedMessageMetadata | Только вывод. Информация о сообщении, цитируемом пользователем Google Chat в пространстве. Пользователи Google Chat могут цитировать сообщение, чтобы ответить на него. |
attachedGifs[] | Только вывод. GIF-изображения, прикрепленные к сообщению. |
accessoryWidgets[] | Один или несколько интерактивных виджетов, которые появляются внизу сообщения. Вы можете добавлять дополнительные виджеты к сообщениям, содержащим текст, карточки или и текст, и карточки. Не поддерживается для сообщений, содержащих диалоговые окна. Подробности см. в разделе Добавление интерактивных виджетов внизу сообщения . Для создания сообщения с дополнительными виджетами требуется аутентификация приложения . |
Картасид
Карточка в сообщении Google Chat.
Только приложения чата могут создавать карточки. Если ваше приложение Chat авторизуется как пользователь , сообщение не может содержать карточки.
Создавайте и просматривайте карты с помощью Card Builder.
Откройте конструктор карточекJSON-представление |
---|
{
"cardId": string,
"card": {
object ( |
Поля | |
---|---|
cardId | Требуется, если сообщение содержит несколько карточек. Уникальный идентификатор карты в сообщении. |
card | Карта. Максимальный размер — 32 КБ. |
Аннотация
Только вывод. Аннотации, связанные с текстовым телом сообщения. Чтобы добавить базовое форматирование к текстовому сообщению, см. раздел Форматирование текстовых сообщений .
Пример тела сообщения в виде обычного текста:
Hello @FooBot how are you!"
Соответствующие метаданные аннотаций:
"annotations":[{
"type":"USER_MENTION",
"startIndex":6,
"length":7,
"userMention": {
"user": {
"name":"users/{user}",
"displayName":"FooBot",
"avatarUrl":"https://goo.gl/aeDtrS",
"type":"BOT"
},
"type":"MENTION"
}
}]
JSON-представление |
---|
{ "type": enum ( |
Поля | |
---|---|
type | Тип этой аннотации. |
length | Длина подстроки в теле сообщения в виде обычного текста, которой соответствует эта аннотация. |
startIndex | Начальный индекс (от 0 включительно) в теле текстового сообщения, которому соответствует эта аннотация. |
metadata поля объединения. Дополнительные метаданные об аннотации. metadata могут быть только одним из следующих: | |
userMention | Метаданные упоминания пользователя. |
slashCommand | Метаданные для косой черты. |
richLinkMetadata | Метаданные для расширенной ссылки. |
Тип аннотации
Тип аннотации.
Перечисления | |
---|---|
ANNOTATION_TYPE_UNSPECIFIED | Значение по умолчанию для перечисления. Не используйте. |
USER_MENTION | Упоминается пользователь. |
SLASH_COMMAND | Вызывается команда косой черты. |
RICH_LINK | Богатая аннотация ссылок. |
UserMentionМетаданные
Метаданные аннотаций для упоминаний пользователей (@).
JSON-представление |
---|
{ "user": { object ( |
Поля | |
---|---|
user | Пользователь упомянул. |
type | Тип упоминания пользователя. |
Тип
Перечисления | |
---|---|
TYPE_UNSPECIFIED | Значение по умолчанию для перечисления. Не используйте. |
ADD | Добавьте пользователя в пространство. |
MENTION | Упомяните пользователя в космосе. |
СлэшКомандаМетаданные
Метаданные аннотаций для команд с косой чертой (/).
JSON-представление |
---|
{ "bot": { object ( |
Поля | |
---|---|
bot | Приложение чата, команда которого была вызвана. |
type | Тип косой черты. |
commandName | Имя вызванной команды слэша. |
commandId | Идентификатор вызванной команды с косой чертой. |
triggersDialog | Указывает, предназначена ли косая черта для диалога. |
Тип
Перечисления | |
---|---|
TYPE_UNSPECIFIED | Значение по умолчанию для перечисления. Не используйте. |
ADD | Добавьте приложение «Чат» в пространство. |
INVOKE | Вызовите команду косой черты в пространстве. |
РичЛинкМетаданные
Богатая ссылка на ресурс.
JSON-представление |
---|
{ "uri": string, "richLinkType": enum ( |
Поля | |
---|---|
uri | URI этой ссылки. |
richLinkType | Расширенный тип ссылки. |
data поля объединения. Данные для связанного ресурса. data могут быть только одним из следующих: | |
driveLinkData | Данные для ссылки на диск. |
chatSpaceLinkData | Данные для ссылки на чат. |
РичЛинкТип
Расширенный тип ссылки. В будущем могут быть добавлены и другие типы.
Перечисления | |
---|---|
RICH_LINK_TYPE_UNSPECIFIED | Значение по умолчанию для перечисления. Не используйте. |
DRIVE_FILE | Тип расширенной ссылки Google Диска. |
CHAT_SPACE | Тип расширенной ссылки в пространстве чата. Например, космический смарт-чип. |
DriveLinkData
Данные для ссылок на Google Диск.
JSON-представление |
---|
{
"driveDataRef": {
object ( |
Поля | |
---|---|
driveDataRef | DriveDataRef , который ссылается на файл Google Диска. |
mimeType | Тип MIME связанного ресурса Google Диска. |
ChatSpaceLinkData
Данные для ссылок в чате.
JSON-представление |
---|
{ "space": string, "thread": string, "message": string } |
Поля | |
---|---|
space | Пространство связанного ресурса пространства чата. Формат: |
thread | Ветка связанного ресурса чата. Формат: |
message | Сообщение связанного ресурса пространства чата. Формат: |
Нить
Обсуждение в чате Google. Пример использования см . в разделе «Начать цепочку сообщений или ответить на нее» .
Если вы указываете поток при создании сообщения, вы можете установить поле messageReplyOption
, чтобы определить, что произойдет, если соответствующий поток не найден.
JSON-представление |
---|
{ "name": string, "threadKey": string } |
Поля | |
---|---|
name | Имя ресурса потока. Пример: |
threadKey | Необязательный. Входные данные для создания или обновления потока. В противном случае только вывод. Идентификатор потока. Поддерживает до 4000 символов. Этот идентификатор уникален для приложения Chat, которое его устанавливает. Например, если несколько приложений чата создают сообщение, используя один и тот же ключ цепочки, сообщения публикуются в разных цепочках. Чтобы ответить в теме, созданной человеком или другим приложением чата, вместо этого укажите поле |
ДействиеОтвет
Параметры, которые приложение чата может использовать для настройки способа публикации ответа.
JSON-представление |
---|
{ "type": enum ( |
Поля | |
---|---|
type | Только ввод. Тип ответа приложения Chat. |
url | Только ввод. URL-адрес для пользователей для аутентификации или настройки. (Только для типов ответов |
dialogAction | Только ввод. Ответ на событие взаимодействия, связанное с диалогом . Должен сопровождаться |
updatedWidget | Только ввод. Ответ обновленного виджета. |
Тип ответа
Тип ответа приложения Chat.
Перечисления | |
---|---|
TYPE_UNSPECIFIED | Тип по умолчанию, который обрабатывается как NEW_MESSAGE . |
NEW_MESSAGE | Опубликовать как новое сообщение в теме. |
UPDATE_MESSAGE | Обновите сообщение приложения Chat. Это разрешено только для события CARD_CLICKED , где тип отправителя сообщения — BOT . |
UPDATE_USER_MESSAGE_CARDS | Обновите карточки в сообщении пользователя. Это разрешено только в качестве ответа на событие MESSAGE с совпадающим URL-адресом или событие CARD_CLICKED где тип отправителя сообщения — HUMAN . Текст игнорируется. |
REQUEST_CONFIG | В частном порядке запросите у пользователя дополнительную аутентификацию или настройку. |
DIALOG | Представляет диалог . |
UPDATE_WIDGET | Запрос параметров автозаполнения текста виджета. |
ДиалогДействие
Содержит диалоговое окно и код состояния запроса.
JSON-представление |
---|
{ "actionStatus": { object ( |
Поля | |
---|---|
actionStatus | Только ввод. Статус запроса на вызов или отправку диалога . Отображает статус и сообщение пользователям, если это необходимо. Например, в случае ошибки или успеха. |
Полевые action Союза. Действие, которое необходимо выполнить. action может быть только одним из следующих: | |
dialog | Только ввод. Диалог запроса. |
Диалог
Обертка вокруг тела карточки диалога.
JSON-представление |
---|
{
"body": {
object ( |
Поля | |
---|---|
body | Только ввод. Тело диалога, отображаемое в модальном режиме. Приложения Google Chat не поддерживают следующие объекты карточек: |
Статус действия
Представляет состояние запроса на вызов или отправку диалога .
JSON-представление |
---|
{
"statusCode": enum ( |
Поля | |
---|---|
statusCode | Код состояния. |
userFacingMessage | Сообщение для отправки пользователям о статусе их запроса. Если этот параметр не установлен, отправляется общее сообщение на основе |
Код
Канонические коды ошибок для API gRPC.
Иногда могут применяться несколько кодов ошибок. Службы должны возвращать наиболее конкретный код ошибки, который применим. Например, отдайте предпочтение OUT_OF_RANGE
вместо FAILED_PRECONDITION
, если применимы оба кода. Аналогичным образом отдайте предпочтение NOT_FOUND
или ALREADY_EXISTS
вместо FAILED_PRECONDITION
.
Перечисления | |
---|---|
OK | Это не ошибка; вернулся с успехом. HTTP-сопоставление: 200 ОК |
CANCELLED | Операция была отменена, как правило, вызывающей стороной. HTTP-сопоставление: закрытый запрос клиента 499 |
UNKNOWN | Неизвестная ошибка. Например, эта ошибка может быть возвращена, когда значение HTTP-сопоставление: 500 внутренняя ошибка сервера |
INVALID_ARGUMENT | Клиент указал недопустимый аргумент. Обратите внимание, что это отличается от HTTP-сопоставление: 400 неверных запросов |
DEADLINE_EXCEEDED | Срок истек до завершения операции. Для операций, изменяющих состояние системы, эта ошибка может возвращаться, даже если операция завершилась успешно. Например, успешный ответ от сервера мог быть отложен на время, достаточное для истечения крайнего срока. HTTP-сопоставление: тайм-аут шлюза 504 |
NOT_FOUND | Некоторый запрошенный объект (например, файл или каталог) не найден. Примечание для разработчиков серверов: если запрос отклонен для всего класса пользователей, например, при постепенном развертывании функции или недокументированном списке разрешенных, можно использовать HTTP-сопоставление: 404 не найден |
ALREADY_EXISTS | Объект, который клиент пытался создать (например, файл или каталог), уже существует. HTTP-сопоставление: конфликт 409 |
PERMISSION_DENIED | У вызывающего объекта нет разрешения на выполнение указанной операции. HTTP-сопоставление: 403 запрещено |
UNAUTHENTICATED | В запросе нет действительных учетных данных аутентификации для операции. HTTP-сопоставление: 401 Неавторизованный |
RESOURCE_EXHAUSTED | Какой-то ресурс исчерпан, возможно, квота на пользователя или, возможно, во всей файловой системе недостаточно места. HTTP-сопоставление: 429 слишком много запросов |
FAILED_PRECONDITION | Операция отклонена, поскольку система не находится в состоянии, необходимом для выполнения операции. Например, удаляемый каталог не пуст, операция rmdir применяется к некаталогу и т. д. Разработчики службы могут использовать следующие рекомендации для выбора между HTTP-сопоставление: 400 неверных запросов |
ABORTED | Операция была прервана, как правило, из-за проблемы параллелизма, например сбоя проверки секвенсора или прерывания транзакции. См. приведенные выше рекомендации по выбору между HTTP-сопоставление: конфликт 409 |
OUT_OF_RANGE | Была предпринята попытка выполнить операцию за пределами допустимого диапазона. Например, поиск или чтение конца файла. В отличие от Между HTTP-сопоставление: 400 неверных запросов |
UNIMPLEMENTED | Операция не реализована или не поддерживается/включена в этом сервисе. HTTP-сопоставление: 501 не реализовано |
INTERNAL | Внутренние ошибки. Это означает, что некоторые инварианты, ожидаемые базовой системой, были нарушены. Этот код ошибки зарезервирован для серьезных ошибок. HTTP-сопоставление: 500 внутренняя ошибка сервера |
UNAVAILABLE | В настоящее время услуга недоступна. Скорее всего, это временное состояние, которое можно исправить, повторив попытку с отсрочкой. Обратите внимание, что не всегда безопасно повторять неидемпотентные операции. См. приведенные выше рекомендации по выбору между HTTP-сопоставление: служба 503 недоступна |
DATA_LOSS | Невосстановимая потеря или повреждение данных. HTTP-сопоставление: 500 внутренняя ошибка сервера |
Обновленный виджет
Ответ обновленного виджета. Используется для предоставления параметров автозаполнения для виджета.
JSON-представление |
---|
{ "widget": string, // Union field |
Поля | |
---|---|
widget | Идентификатор обновленного виджета. Идентификатор должен совпадать с идентификатором виджета, который инициировал запрос на обновление. |
Поле объединения updated_widget . Виджет обновляется в ответ на действие пользователя. updated_widget может быть только одним из следующих: | |
suggestions | Список результатов автозаполнения виджета |
Элементы выбора
Список результатов автозаполнения виджета.
JSON-представление |
---|
{
"items": [
{
object ( |
Поля | |
---|---|
items[] | Массив объектов SelectionItem. |
СлэшКоманда
Косая черта в Google Chat.
JSON-представление |
---|
{ "commandId": string } |
Поля | |
---|---|
commandId | Идентификатор вызванной косой черты. |
Соответствующий URL
Соответствующий URL-адрес в сообщении чата. Приложения чата могут просматривать совпадающие URL-адреса. Дополнительную информацию см. в разделе Ссылки для предварительного просмотра .
JSON-представление |
---|
{ "url": string } |
Поля | |
---|---|
url | Только вывод. URL-адрес, который был сопоставлен. |
EmojiРеакцияСводка
Количество людей, которые отреагировали на сообщение определенным смайлом.
JSON-представление |
---|
{
"emoji": {
object ( |
Поля | |
---|---|
emoji | Эмодзи, связанные с реакциями. |
reactionCount | Общее количество реакций с использованием соответствующего смайла. |
Удаление метаданных
Информация об удаленном сообщении. Сообщение удаляется, если установлено deleteTime
.
JSON-представление |
---|
{
"deletionType": enum ( |
Поля | |
---|---|
deletionType | Указывает, кто удалил сообщение. |
Тип удаления
Кто удалил сообщение и как оно было удалено.
Перечисления | |
---|---|
DELETION_TYPE_UNSPECIFIED | Это значение не используется. |
CREATOR | Пользователь удалил собственное сообщение. |
SPACE_OWNER | Владелец темы удалил сообщение. |
ADMIN | Администратор Google Workspace удалил сообщение. |
APP_MESSAGE_EXPIRY | Приложение чата удалило собственное сообщение по истечении срока его действия. |
CREATOR_VIA_APP | Приложение чата удалило сообщение от имени пользователя. |
SPACE_OWNER_VIA_APP | Приложение чата удалило сообщение от имени владельца чат-группы. |
ЦитируемоеСообщениеМетаданные
Информация о цитируемом сообщении.
JSON-представление |
---|
{ "name": string, "lastUpdateTime": string } |
Поля | |
---|---|
name | Только вывод. Имя ресурса цитируемого сообщения. Формат: |
lastUpdateTime | Только вывод. Временная метка создания или последнего обновления цитируемого сообщения. |
ПрикрепленоGif
Изображение GIF, указанное URL-адресом.
JSON-представление |
---|
{ "uri": string } |
Поля | |
---|---|
uri | Только вывод. URL-адрес, на котором размещено изображение GIF. |
АксессуарВиджет
Один или несколько интерактивных виджетов, которые появляются внизу сообщения. Подробности см. в разделе Добавление интерактивных виджетов внизу сообщения .
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
Полевые action Союза. Тип действия. action может быть только одним из следующих: | |
buttonList | Список кнопок. |
Методы | |
---|---|
| Создает сообщение в чате Google. |
| Удаляет сообщение. |
| Возвращает сведения о сообщении. |
| Перечисляет сообщения в пространстве, участником которого является вызывающий абонент, включая сообщения от заблокированных участников и пространств. |
| Обновляет сообщение. |
| Обновляет сообщение. |