Индекс
-
ChatService
(интерфейс) -
AccessoryWidget
(сообщение) -
ActionResponse
(сообщение) -
ActionResponse.ResponseType
(перечисление) -
ActionResponse.SelectionItems
(сообщение) -
ActionResponse.UpdatedWidget
(сообщение) -
ActionStatus
(сообщение) -
Annotation
(сообщение) -
AnnotationType
(перечисление) -
AttachedGif
(сообщение) -
Attachment
(сообщение) -
Attachment.Source
(перечисление) -
AttachmentDataRef
(сообщение) -
CardWithId
(сообщение) -
ChatSpaceLinkData
(сообщение) -
CompleteImportSpaceRequest
(сообщение) -
CompleteImportSpaceResponse
(сообщение) -
ContextualAddOnMarkup
(сообщение) -
ContextualAddOnMarkup.Card
(сообщение) -
ContextualAddOnMarkup.Card.CardAction
(сообщение) -
ContextualAddOnMarkup.Card.CardHeader
(сообщение) -
ContextualAddOnMarkup.Card.CardHeader.ImageStyle
(перечисление) -
ContextualAddOnMarkup.Card.Section
(сообщение) -
CreateMembershipRequest
(сообщение) -
CreateMessageRequest
(сообщение) -
CreateMessageRequest.MessageReplyOption
(перечисление) -
CreateReactionRequest
(сообщение) -
CreateSpaceRequest
(сообщение) -
CustomEmoji
(сообщение) -
DeleteMembershipRequest
(сообщение) -
DeleteMessageRequest
(сообщение) -
DeleteReactionRequest
(сообщение) -
DeleteSpaceRequest
(сообщение) -
DeletionMetadata
(сообщение) -
DeletionMetadata.DeletionType
(перечисление) -
Dialog
(сообщение) -
DialogAction
(сообщение) -
DriveDataRef
(сообщение) -
DriveLinkData
(сообщение) -
Emoji
(сообщение) -
EmojiReactionSummary
(сообщение) -
FindDirectMessageRequest
(сообщение) -
GetAttachmentRequest
(сообщение) -
GetMembershipRequest
(сообщение) -
GetMessageRequest
(сообщение) -
GetSpaceEventRequest
(сообщение) -
GetSpaceReadStateRequest
(сообщение) -
GetSpaceRequest
(сообщение) -
GetThreadReadStateRequest
(сообщение) -
Group
(сообщение) -
HistoryState
(перечисление) -
ListMembershipsRequest
(сообщение) -
ListMembershipsResponse
(сообщение) -
ListMessagesRequest
(сообщение) -
ListMessagesResponse
(сообщение) -
ListReactionsRequest
(сообщение) -
ListReactionsResponse
(сообщение) -
ListSpaceEventsRequest
(сообщение) -
ListSpaceEventsResponse
(сообщение) -
ListSpacesRequest
(сообщение) -
ListSpacesResponse
(сообщение) -
MatchedUrl
(сообщение) -
Membership
(сообщение) -
Membership.MembershipRole
(перечисление) -
Membership.MembershipState
(перечисление) -
MembershipBatchCreatedEventData
(сообщение) -
MembershipBatchDeletedEventData
(сообщение) -
MembershipBatchUpdatedEventData
(сообщение) -
MembershipCreatedEventData
(сообщение) -
MembershipDeletedEventData
(сообщение) -
MembershipUpdatedEventData
(сообщение) -
Message
(сообщение) -
MessageBatchCreatedEventData
(сообщение) -
MessageBatchDeletedEventData
(сообщение) -
MessageBatchUpdatedEventData
(сообщение) -
MessageCreatedEventData
(сообщение) -
MessageDeletedEventData
(сообщение) -
MessageUpdatedEventData
(сообщение) -
QuotedMessageMetadata
(сообщение) -
Reaction
(сообщение) -
ReactionBatchCreatedEventData
(сообщение) -
ReactionBatchDeletedEventData
(сообщение) -
ReactionCreatedEventData
(сообщение) -
ReactionDeletedEventData
(сообщение) -
RichLinkMetadata
(сообщение) -
RichLinkMetadata.RichLinkType
(перечисление) -
SearchSpacesRequest
(сообщение) -
SearchSpacesResponse
(сообщение) -
SetUpSpaceRequest
(сообщение) -
SlashCommand
(сообщение) -
SlashCommandMetadata
(сообщение) -
SlashCommandMetadata.Type
(перечисление) -
Space
(сообщение) -
Space.AccessSettings
(сообщение) -
Space.AccessSettings.AccessState
(перечисление) -
Space.MembershipCount
(сообщение) -
Space.PermissionSetting
(сообщение) -
Space.PermissionSettings
(сообщение) -
Space.PredefinedPermissionSettings
(перечисление) -
Space.SpaceDetails
(сообщение) -
Space.SpaceThreadingState
(перечисление) -
Space.SpaceType
(перечисление) -
Space.Type
(перечисление) -
SpaceBatchUpdatedEventData
(сообщение) -
SpaceEvent
(сообщение) -
SpaceReadState
(сообщение) -
SpaceUpdatedEventData
(сообщение) -
Thread
(сообщение) -
ThreadReadState
(сообщение) -
UpdateMembershipRequest
(сообщение) -
UpdateMessageRequest
(сообщение) -
UpdateSpaceReadStateRequest
(сообщение) -
UpdateSpaceRequest
(сообщение) -
User
(сообщение) -
User.Type
(перечисление) -
UserMentionMetadata
(сообщение) -
UserMentionMetadata.Type
(перечисление) -
WidgetMarkup
(сообщение) -
WidgetMarkup.Button
(сообщение) -
WidgetMarkup.FormAction
(сообщение) -
WidgetMarkup.FormAction.ActionParameter
(сообщение) -
WidgetMarkup.Icon
(перечисление) -
WidgetMarkup.Image
(сообщение) -
WidgetMarkup.ImageButton
(сообщение) -
WidgetMarkup.KeyValue
(сообщение) -
WidgetMarkup.OnClick
(сообщение) -
WidgetMarkup.OpenLink
(сообщение) -
WidgetMarkup.TextButton
(сообщение) -
WidgetMarkup.TextParagraph
(сообщение)
ЧатСервис
Позволяет разработчикам создавать приложения Chat и их интеграцию на платформе Google Chat.
CompleteImportSpace |
---|
Завершает процесс импорта указанного пространства и делает его видимым для пользователей. Требуется аутентификация приложения и делегирование на уровне домена. Дополнительную информацию см. в разделе Разрешение приложениям Google Chat импортировать данные .
|
Создать членство |
---|
Создает членство для вызывающего приложения Chat, пользователя или группы Google. Создание членства для других приложений Chat не поддерживается. Если при создании членства у указанного участника отключена политика автоматического принятия, он будет приглашен и должен принять приглашение в пространство, прежде чем присоединиться. В противном случае при создании членства участник добавляется непосредственно в указанное пространство. Требует аутентификации пользователя . Пример использования см.:
|
Создать сообщение |
---|
Создает сообщение в чате Google. Пример см. в разделе «Отправить сообщение» . Метод На следующем изображении показано, как Chat атрибутирует сообщение при использовании аутентификации приложения. Chat отображает приложение Chat в качестве отправителя сообщения. Содержимое сообщения может содержать текст ( На следующем изображении показано, как Chat атрибутирует сообщение при использовании аутентификации пользователя. Chat отображает пользователя как отправителя сообщения и связывает приложение Chat с сообщением, отображая его имя. Содержимое сообщения может содержать только текст ( Максимальный размер сообщения, включая его содержимое, составляет 32 000 байт.
|
Создатьреакцию |
---|
Создает реакцию и добавляет ее в сообщение. Поддерживаются только смайлы Юникода. Пример см. в разделе Добавление реакции на сообщение . Требует аутентификации пользователя .
|
Создать пространство |
---|
Создает именованное пространство. Пространства, сгруппированные по темам, не поддерживаются. Пример см. в разделе Создание пространства . Если при создании пространства вы получаете сообщение об ошибке Требует аутентификации пользователя .
|
Удалить членство |
---|
Удаляет членство. Пример см. в статье Удаление пользователя или приложения Google Chat из пространства . Требует аутентификации пользователя .
|
Удалить сообщение |
---|
Удаляет сообщение. Пример см. в разделе Удаление сообщения . Требует аутентификации . Поддерживает аутентификацию приложений и аутентификацию пользователей . При использовании аутентификации приложения запросы могут удалять только сообщения, созданные вызывающим приложением чата.
|
Удалитьреакцию |
---|
Удаляет реакцию на сообщение. Поддерживаются только смайлы Юникода. Пример см. в разделе Удаление реакции . Требует аутентификации пользователя .
|
Удалить пространство |
---|
Удаляет именованное пространство. Всегда выполняет каскадное удаление, что означает, что дочерние ресурсы пространства, такие как сообщения, опубликованные в пространстве, и членство в пространстве, также удаляются. Пример см. в разделе Удаление пробела . Требуется аутентификация пользователя от пользователя, у которого есть разрешение на удаление пространства.
|
НайтиDirectMessage |
---|
Возвращает существующее прямое сообщение указанному пользователю. Если пространство для прямых сообщений не найдено, возвращается ошибка При аутентификации пользователя возвращает пространство прямого сообщения между указанным пользователем и пользователем, прошедшим проверку подлинности. При проверке подлинности приложения возвращает пространство прямого сообщения между указанным пользователем и вызывающим приложением чата. Требуется аутентификация пользователя или аутентификация приложения .
|
Получить вложение |
---|
Получает метаданные вложения сообщения. Данные вложения извлекаются с помощью медиа API . Пример см. в разделе Получение метаданных о вложении сообщения . Требуется аутентификация приложения .
|
Получить членство |
---|
Возвращает сведения о членстве. Пример см. в разделе Получение сведений о членстве пользователя или приложения Google Chat . Требует аутентификации . Поддерживает аутентификацию приложений и аутентификацию пользователей .
|
Получить сообщение |
---|
Возвращает сведения о сообщении. Пример см. в разделе Получение сведений о сообщении . Требует аутентификации . Поддерживает аутентификацию приложений и аутентификацию пользователей . Примечание. Может вернуть сообщение от заблокированного участника или пространства.
|
GetSpace |
---|
Возвращает подробную информацию о пространстве. Пример см. в разделе Получение сведений о пространстве . Требует аутентификации . Поддерживает аутентификацию приложений и аутентификацию пользователей .
|
GetSpaceEvent |
---|
Возвращает событие из пространства Google Chat. Полезные данные события содержат самую последнюю версию измененного ресурса. Например, если вы запрашиваете событие о новом сообщении, но позже оно было обновлено, сервер возвращает обновленный ресурс Требует аутентификации пользователя . Чтобы получить событие, аутентифицированный пользователь должен быть членом пространства. Пример см. в разделе Получение сведений о событии из чата Google .
|
GetSpaceReadState |
---|
Возвращает сведения о состоянии чтения пользователя в пространстве, используемые для идентификации прочитанных и непрочитанных сообщений. Пример см. в разделе Получение сведений о состоянии чтения пространства пользователя . Требует аутентификации пользователя .
|
GetThreadReadState |
---|
Возвращает сведения о состоянии чтения пользователя в потоке, используемые для идентификации прочитанных и непрочитанных сообщений. Пример см. в разделе Получение сведений о состоянии чтения потока пользователя . Требует аутентификации пользователя .
|
Список членства |
---|
Перечисляет членство в пространстве. Пример см. в разделе Список пользователей и приложений Google Chat в пространстве . В списке участников с аутентификацией приложения перечислены участники в пространствах, к которым у приложения Chat есть доступ, но исключаются членства в приложении Chat, включая собственное. В списке участников с аутентификацией пользователя перечислены членства в пространствах, к которым имеет доступ аутентифицированный пользователь. Требует аутентификации . Поддерживает аутентификацию приложений и аутентификацию пользователей .
|
Список сообщений |
---|
Перечисляет сообщения в пространстве, участником которого является вызывающий абонент, включая сообщения от заблокированных участников и пространств. Если вы перечислите сообщения из пространства, в котором нет сообщений, ответом будет пустой объект. При использовании интерфейса REST/HTTP ответ содержит пустой объект JSON
|
Список реакций |
---|
Перечисляет реакции на сообщение. Пример см. в разделе Список реакций на сообщение . Требует аутентификации пользователя .
|
ListSpaceEvents |
---|
Перечисляет события из пространства Google Chat. Для каждого события полезные данные содержат самую последнюю версию ресурса Chat. Например, если вы перечислите события о новых участниках пространства, сервер вернет ресурсы Требует аутентификации пользователя . Чтобы составить список событий, аутентифицированный пользователь должен быть участником пространства. Пример см. в разделе Список событий из чата Google .
|
Список пространств |
---|
Перечисляет пространства, членом которых является вызывающий абонент. Групповые чаты и личные сообщения не отображаются в списке до тех пор, пока не будет отправлено первое сообщение. Пример см. в разделе Пространства списков . Требует аутентификации . Поддерживает аутентификацию приложений и аутентификацию пользователей . Перечисляет пространства, видимые вызывающему абоненту или аутентифицированному пользователю. Групповые чаты и личные сообщения не отображаются в списке до тех пор, пока не будет отправлено первое сообщение. Чтобы получить список всех именованных пространств по организациям Google Workspace, используйте вместо этого метод
|
Поиск пространств |
---|
Возвращает список пространств на основе поиска пользователя. Требует аутентификации пользователя . Пользователь должен быть администратором организации Google Workspace. В запросе установите для
|
SetUpSpace |
---|
Создает пространство и добавляет в него указанных пользователей. Вызывающий пользователь автоматически добавляется в пространство и не должен указываться как член в запросе. Пример см. в разделе «Настройка пространства с первоначальными участниками» . Чтобы указать добавляемых членов-людей, добавьте членство с соответствующим Чтобы указать группы Google для добавления, добавьте членство с соответствующим Если для именованного пространства или группового чата вызывающий абонент блокируется или заблокирован некоторыми участниками или не имеет разрешения на добавление некоторых участников, то эти участники не добавляются в созданное пространство. Чтобы создать прямое сообщение (DM) между вызывающим пользователем и другим пользователем-человеком, укажите ровно одно членство, которое будет представлять пользователя-человека. Если один пользователь блокирует другого, запрос не выполняется и DM не создается. Чтобы создать DM между вызывающим пользователем и вызывающим приложением, установите для Если DM уже существует между двумя пользователями, даже если один пользователь блокирует другого во время запроса, тогда возвращается существующая DM. Темы с цепочками ответов не поддерживаются. Если при настройке пространства вы получаете сообщение об ошибке Требует аутентификации пользователя .
|
Обновление членства |
---|
Обновляет членство. Пример см. в разделе Обновление членства пользователя в пространстве . Требует аутентификации пользователя .
|
Обновление сообщения |
---|
Обновляет сообщение. Существует разница между методами Требует аутентификации . Поддерживает аутентификацию приложений и аутентификацию пользователей . При использовании аутентификации приложения запросы могут обновлять только сообщения, созданные вызывающим приложением чата.
|
ОбновлениеПространство |
---|
Обновляет пространство. Пример см. в разделе Обновление пространства . Если вы обновляете поле Требует аутентификации пользователя .
|
UpdateSpaceReadState |
---|
Обновляет состояние чтения пользователя в пространстве, используемое для идентификации прочитанных и непрочитанных сообщений. Пример см . в разделе Обновление состояния чтения пространства пользователя . Требует аутентификации пользователя .
|
АксессуарВиджет
Один или несколько интерактивных виджетов, которые появляются внизу сообщения. Подробности см. в разделе Добавление интерактивных виджетов внизу сообщения .
Поля | |
---|---|
Полевые action Союза. Тип действия. action может быть только одним из следующих: | |
button_list | Список кнопок. |
ДействиеОтвет
Параметры, которые приложение Chat может использовать для настройки способа публикации ответа.
Поля | |
---|---|
type | Только ввод. Тип ответа приложения Chat. |
url | Только ввод. URL-адрес для пользователей для аутентификации или настройки. (Только для типов ответов |
dialog_action | Только ввод. Ответ на событие взаимодействия, связанное с диалогом . Должен сопровождаться |
updated_widget | Только ввод. Ответ обновленного виджета. |
Тип ответа
Тип ответа приложения 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 | Запрос параметров автозаполнения текста виджета. |
Элементы выбора
Список результатов автозаполнения виджета.
Поля | |
---|---|
items[] | Массив объектов SelectionItem. |
Обновленный виджет
Ответ обновленного виджета. Используется для предоставления параметров автозаполнения для виджета.
Поля | |
---|---|
widget | Идентификатор обновленного виджета. Идентификатор должен совпадать с идентификатором виджета, который инициировал запрос на обновление. |
Поле объединения updated_widget . Виджет обновляется в ответ на действие пользователя. updated_widget может быть только одним из следующих: | |
suggestions | Список результатов автозаполнения виджета |
Статус действия
Представляет состояние запроса на вызов или отправку диалога .
Поля | |
---|---|
status_code | Код состояния. |
user_facing_message | Сообщение для отправки пользователям о статусе их запроса. Если значение не установлено, отправляется общее сообщение на основе |
Аннотация
Только вывод. Аннотации, связанные с текстовым телом сообщения. Чтобы добавить базовое форматирование к текстовому сообщению, см. раздел Форматирование текстовых сообщений .
Пример тела сообщения в виде обычного текста:
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"
}
}]
Поля | |
---|---|
type | Тип этой аннотации. |
length | Длина подстроки в теле сообщения в виде обычного текста, которой соответствует эта аннотация. |
start_index | Начальный индекс (отсчитываемый от 0 включительно) в теле текстового сообщения, которому соответствует эта аннотация. |
metadata поля объединения. Дополнительные метаданные об аннотации. metadata могут быть только одним из следующих: | |
user_mention | Метаданные упоминания пользователя. |
slash_command | Метаданные для косой черты. |
rich_link_metadata | Метаданные для расширенной ссылки. |
Тип аннотации
Тип аннотации.
Перечисления | |
---|---|
ANNOTATION_TYPE_UNSPECIFIED | Значение по умолчанию для перечисления. Не используйте. |
USER_MENTION | Упоминается пользователь. |
SLASH_COMMAND | Вызывается команда косой черты. |
RICH_LINK | Богатая аннотация ссылок. |
ПрикрепленоGif
Изображение GIF, заданное URL-адресом.
Поля | |
---|---|
uri | Только вывод. URL-адрес, на котором размещено изображение GIF. |
Вложение
Вложение в Google Chat.
Поля | |
---|---|
name | Имя ресурса вложения в форме |
content_name | Только вывод. Исходное имя файла содержимого, а не полный путь. |
content_type | Только вывод. Тип содержимого (тип MIME) файла. |
thumbnail_uri | Только вывод. URL-адрес миниатюры, который следует использовать для предварительного просмотра вложения пользователю-человеку. Приложения чата не должны использовать этот URL-адрес для загрузки содержимого вложений. |
download_uri | Только вывод. URL-адрес загрузки, который следует использовать, чтобы позволить пользователю-человеку загрузить вложение. Приложения чата не должны использовать этот URL-адрес для загрузки содержимого вложений. |
source | Только вывод. Источник вложения. |
Поле объединения data_ref . Ссылка на данные во вложении. data_ref может быть только одним из следующих: | |
attachment_data_ref | Ссылка на данные вложения. Это поле используется с медиа-API для загрузки данных вложения. |
drive_data_ref | Только вывод. Ссылка на вложение Google Диска. Это поле используется с API Google Диска. |
Источник
Источник вложения.
Перечисления | |
---|---|
SOURCE_UNSPECIFIED | Сдержанный. |
DRIVE_FILE | Это файл Google Диска. |
UPLOADED_CONTENT | Файл будет загружен в чат. |
ссылка на вложение данных
Ссылка на данные вложения.
Поля | |
---|---|
resource_name | Имя ресурса данных вложения. Это поле используется с медиа-API для загрузки данных вложения. |
attachment_upload_token | Непрозрачный токен, содержащий ссылку на загруженный вложение. Рассматривается клиентами как непрозрачная строка и используется для создания или обновления сообщений чата с вложениями. |
Картасид
Карточка в сообщении Google Chat.
Только приложения чата могут создавать карточки. Если ваше приложение Chat авторизуется как пользователь , сообщение не может содержать карточки.
Создавайте и просматривайте карты с помощью Card Builder.
Откройте конструктор карточекПоля | |
---|---|
card_id | Требуется, если сообщение содержит несколько карточек. Уникальный идентификатор карты в сообщении. |
card | Карта. Максимальный размер — 32 КБ. |
ChatSpaceLinkData
Данные для ссылок в чате.
Поля | |
---|---|
space | Пространство связанного ресурса пространства чата. Формат: |
thread | Ветка связанного ресурса чата. Формат: |
message | Сообщение связанного ресурса пространства чата. Формат: |
Завершить импорт пространства запрос
Сообщение с запросом о завершении процесса импорта пространства.
Поля | |
---|---|
name | Необходимый. Имя ресурса пространства режима импорта. Формат: |
Комплеимпортспейсереспонс
Ответное сообщение о завершении процесса импорта пространства.
Поля | |
---|---|
space | Пространство режима импорта. |
Контекстная надстройкаразметка
Этот тип не имеет полей.
Разметка, позволяющая разработчикам указывать содержимое контекстной надстройки.
Карта
Карточка — это элемент пользовательского интерфейса, который может содержать виджеты пользовательского интерфейса, такие как текст и изображения.
Поля | |
---|---|
header | Заголовок карты. Заголовок обычно содержит заголовок и изображение. |
sections[] | Разделы разделены разделителем строк. |
card_actions[] | Действия этой карты. |
name | Название карты. |
КартаДействие
Действие карты — это действие, связанное с картой. Для карточки счета-фактуры типичным действием будет: удалить счет, отправить счет по электронной почте или открыть счет в браузере.
Не поддерживается приложениями Google Chat.
Поля | |
---|---|
action_label | Метка раньше отображалась в пункте меню действий. |
on_click | Действие onclick для этого элемента действия. |
Заголовок карты
Поля | |
---|---|
title | Должно быть указано название. Заголовок имеет фиксированную высоту: если указаны и заголовок, и подзаголовок, каждый занимает одну строку. Если указан только заголовок, он занимает обе строки. |
subtitle | Подзаголовок шапки карты. |
image_style | Тип изображения (например, квадратная или круглая рамка). |
image_url | URL-адрес изображения в заголовке карты. |
Стиль изображения
Перечисления | |
---|---|
IMAGE_STYLE_UNSPECIFIED | |
IMAGE | Квадратная граница. |
AVATAR | Круглая граница. |
Раздел
Раздел содержит коллекцию виджетов, которые отображаются (вертикально) в том порядке, в котором они указаны. На всех платформах карточки имеют узкую фиксированную ширину, поэтому в настоящее время нет необходимости в свойствах макета (например, float).
Поля | |
---|---|
header | Заголовок раздела. Поддерживается форматированный текст. Дополнительную информацию о форматировании текста см. в разделах «Форматирование текста в приложениях Google Chat» и «Форматирование текста в надстройках Google Workspace» . |
widgets[] | Раздел должен содержать хотя бы один виджет. |
Создать запрос на членство
Сообщение с запросом на создание членства.
Поля | |
---|---|
parent | Необходимый. Имя ресурса пространства, для которого необходимо создать членство. Формат: пробелы/{пробел} |
membership | Необходимый. Отношение членства для создания. |
use_admin_access | Если Вызывающий пользователь должен быть администратором Google Workspace с правом управления чатом и беседами в чат-группах . Требуется область действия OAuth 2.0 Создание членства в приложении или создание членства для пользователей за пределами организации Google Workspace, принадлежащей администратору, не поддерживается с использованием доступа администратора. |
Создать запрос сообщения
Создает сообщение.
Поля | |
---|---|
parent | Необходимый. Имя ресурса пространства, в котором создается сообщение. Формат: |
message | Необходимый. Тело сообщения. |
thread_key | Необязательный. Устарело: вместо этого используйте |
request_id | Необязательный. Уникальный идентификатор запроса для этого сообщения. Указание существующего идентификатора запроса возвращает сообщение, созданное с этим идентификатором, вместо создания нового сообщения. |
message_reply_option | Необязательный. Указывает, запускает ли сообщение цепочку или отвечает на нее. Поддерживается только в именованных пространствах. |
message_id | Необязательный. Пользовательский идентификатор сообщения. Позволяет приложениям чата получать, обновлять или удалять сообщения без необходимости сохранять назначенный системой идентификатор в имени ресурса сообщения (представленном в поле Значение этого поля должно соответствовать следующим требованиям:
Подробности см. в разделе Назовите сообщение . |
Опция ответа сообщения
Указывает, как ответить на сообщение. В будущем могут быть добавлены и другие штаты.
Перечисления | |
---|---|
MESSAGE_REPLY_OPTION_UNSPECIFIED | По умолчанию. Начинает новую тему. Использование этой опции игнорирует любой включенный thread ID или . |
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD | Создает сообщение как ответ на поток, указанный thread ID или . Если это не удается, вместо этого сообщение запускает новый поток. |
REPLY_MESSAGE_OR_FAIL | Создает сообщение как ответ на поток, указанный thread ID или . Если используется новый thread_key , создается новый поток. Если создать сообщение не удалось, вместо этого возвращается ошибка NOT_FOUND . |
CreateReactionRequest
Создает реакцию на сообщение.
Поля | |
---|---|
parent | Необходимый. Сообщение, в котором создается реакция. Формат: |
reaction | Необходимый. Реакция на создание. |
CreateSpaceRequest
Запрос на создание именованного пространства.
Поля | |
---|---|
space | Необходимый. Поля Если вы получили сообщение об ошибке |
request_id | Необязательный. Уникальный идентификатор этого запроса. Рекомендуется использовать случайный UUID. Указание существующего идентификатора запроса возвращает пространство, созданное с этим идентификатором, вместо создания нового пространства. Указание существующего идентификатора запроса из того же приложения чата с другим пользователем, прошедшим проверку подлинности, возвращает ошибку. |
ПользовательскиеEmoji
Представляет пользовательский эмодзи.
Поля | |
---|---|
uid | Только вывод. Уникальный ключ для пользовательского ресурса смайлов. |
Удалить запрос на членство
Запрос на удаление членства в пространстве.
Поля | |
---|---|
name | Необходимый. Имя ресурса членства, которое требуется удалить. Приложения чата могут удалять пользователей-людей или их собственные членства. Приложения чата не могут удалять членство других приложений. При удалении человеческого членства требуется область действия При удалении членства в приложении требуется область действия Формат: |
use_admin_access | Если Вызывающий пользователь должен быть администратором Google Workspace с правом управления чатом и беседами в чат-группах . Требуется область действия OAuth 2.0 Удаление членства в приложении в пространстве не поддерживается с использованием доступа администратора. |
Удалить сообщениезапрос
Просьба удалить сообщение.
Поля | |
---|---|
name | Необходимый. Имя ресурса сообщения. Формат: Если вы установили собственный идентификатор для своего сообщения, вы можете использовать значение из поля |
force | Если Применяется только при аутентификации пользователя . Не имеет эффекта при аутентификации в приложении чата . |
Удалитьреакционрекуест
Удаляет реакцию на сообщение.
Поля | |
---|---|
name | Необходимый. Название реакции, которую нужно удалить. Формат: |
Удалить спейсрекуест
Запрос на удаление пространства.
Поля | |
---|---|
name | Необходимый. Имя ресурса пространства, которое требуется удалить. Формат: |
use_admin_access | Если Вызывающий пользователь должен быть администратором Google Workspace с правом управления чатом и беседами в чат-группах . Требуется область действия OAuth 2.0 |
Удаление метаданных
Информация об удаленном сообщении. Сообщение удаляется, если установлено delete_time
.
Поля | |
---|---|
deletion_type | Указывает, кто удалил сообщение. |
Тип удаления
Кто удалил сообщение и как оно было удалено.
Перечисления | |
---|---|
DELETION_TYPE_UNSPECIFIED | Это значение не используется. |
CREATOR | Пользователь удалил собственное сообщение. |
SPACE_OWNER | Владелец темы удалил сообщение. |
ADMIN | Администратор Google Workspace удалил сообщение. |
APP_MESSAGE_EXPIRY | Приложение чата удалило собственное сообщение по истечении срока его действия. |
CREATOR_VIA_APP | Приложение чата удалило сообщение от имени пользователя. |
SPACE_OWNER_VIA_APP | Приложение чата удалило сообщение от имени владельца чат-группы. |
Диалог
Обертка вокруг тела карточки диалога.
Поля | |
---|---|
body | Только ввод. Тело диалога, отображаемое в модальном режиме. Приложения Google Chat не поддерживают следующие объекты карточек: |
ДиалогДействие
Содержит диалоговое окно и код состояния запроса.
Поля | |
---|---|
action_status | Только ввод. Статус запроса на вызов или отправку диалога . Отображает статус и сообщение пользователям, если это необходимо. Например, в случае ошибки или успеха. |
Полевые action Союза. Действие, которое необходимо выполнить. action может быть только одним из следующих: | |
dialog | Только ввод. Диалог запроса. |
DriveDataRef
Ссылка на данные о подключении диска.
Поля | |
---|---|
drive_file_id | Идентификатор файла диска. Используйте с API Диска. |
DriveLinkData
Данные для ссылок на Google Диск.
Поля | |
---|---|
drive_data_ref | DriveDataRef , который ссылается на файл Google Диска. |
mime_type | Тип MIME связанного ресурса Google Диска. |
Эмодзи
Эмодзи, который используется как реакция на сообщение.
Поля | |
---|---|
content поля объединения. Содержание смайлика. content может быть только одним из следующих: | |
unicode | Базовый смайлик, представленный строкой Юникода. |
custom_emoji | Только вывод. Пользовательский смайлик. |
EmojiРеакцияСводка
Количество людей, которые отреагировали на сообщение определенным смайлом.
Поля | |
---|---|
emoji | Эмодзи, связанные с реакциями. |
reaction_count | Общее количество реакций с использованием соответствующего смайла. |
FindDirectMessageRequest
Запрос на получение места для прямых сообщений на основе пользовательского ресурса.
Поля | |
---|---|
name | Необходимый. Имя ресурса пользователя, с которым можно найти прямое сообщение. Формат: |
GetAttachmentRequest
Запрос на получение вложения.
Поля | |
---|---|
name | Необходимый. Имя ресурса вложения в форме |
Получить запрос на членство
Запрос на членство в пространстве.
Поля | |
---|---|
name | Необходимый. Имя ресурса членства, которое требуется получить. Чтобы получить собственное членство приложения с помощью аутентификации пользователя , вы можете дополнительно использовать Формат: После аутентификации пользователя вы можете использовать адрес электронной почты пользователя в качестве псевдонима для |
use_admin_access | Если Вызывающий пользователь должен быть администратором Google Workspace с правом управления чатом и беседами в чат-группах . Требуются области действия OAuth 2.0 Получение членства приложений в пространстве не поддерживается при использовании доступа администратора. |
Получить запрос сообщения
Запрос на получение сообщения.
Поля | |
---|---|
name | Необходимый. Имя ресурса сообщения. Формат: Если вы установили собственный идентификатор для своего сообщения, вы можете использовать значение из поля |
GetSpaceEventRequest
Сообщение запроса на получение космического события.
Поля | |
---|---|
name | Необходимый. Имя ресурса космического события. Формат: |
GetSpaceReadStateRequest
Сообщение запроса для API GetSpaceReadState.
Поля | |
---|---|
name | Необходимый. Имя ресурса состояния чтения пространства, которое требуется получить. Поддерживается получение состояния чтения только для вызывающего пользователя. Чтобы обратиться к вызывающему пользователю, установите одно из следующих значений:
Формат: пользователи/{user}/spaces/{space}/spaceReadState |
GetSpaceRequest
Запрос на возврат одного пробела.
Поля | |
---|---|
name | Необходимый. Имя ресурса пространства в форме Формат: |
use_admin_access | Если Вызывающий пользователь должен быть администратором Google Workspace с правом управления чатом и беседами в чат-группах . Требуются области действия |
GetThreadReadStateRequest
Сообщение запроса для API GetThreadReadStateRequest.
Поля | |
---|---|
name | Необходимый. Имя ресурса состояния чтения потока, которое требуется получить. Поддерживается получение состояния чтения только для вызывающего пользователя. Чтобы обратиться к вызывающему пользователю, установите одно из следующих значений:
Формат: пользователи/{user}/spaces/{space}/threads/{thread}/threadReadState |
Группа
Группа Google в Google Chat.
Поля | |
---|---|
name | Название ресурса для группы Google. Представляет группу в Cloud Identity Groups API. Формат: группы/{группа} |
Состояние истории
Состояние истории сообщений и пространств. Указывает, как долго сообщения и цепочки разговоров хранятся после создания.
Перечисления | |
---|---|
HISTORY_STATE_UNSPECIFIED | Значение по умолчанию. Не используйте. |
HISTORY_OFF | История отключена. Сообщения и темы хранятся 24 часа . |
HISTORY_ON | История включена. Правила хранения Сейфа организации определяют, как долго хранятся сообщения и цепочки. |
СписокЧленствоЗапрос
Сообщение с запросом о включении в список участников.
Поля | |
---|---|
parent | Необходимый. Имя ресурса пространства, для которого требуется получить список участников. Формат: пробелы/{пробел} |
page_size | Необязательный. Максимальное количество членств для возврата. Служба может вернуть меньше этого значения. Если не указано, возвращается не более 100 членств. Максимальное значение — 1000. Если вы используете значение больше 1000, оно автоматически изменится на 1000. Отрицательные значения возвращают ошибку |
page_token | Необязательный. Токен страницы, полученный в результате предыдущего вызова списка участников. Укажите этот параметр, чтобы получить следующую страницу. При разбиении на страницы все остальные предоставленные параметры должны соответствовать вызову, который предоставил токен страницы. Передача других значений другим параметрам может привести к неожиданным результатам. |
filter | Необязательный. Фильтр запроса. Вы можете фильтровать членство по роли участника ( Чтобы фильтровать по роли, установите для Чтобы фильтровать по типу, установите Для фильтрации по роли и типу используйте оператор Если для Например, допустимы следующие запросы:
Следующие запросы недействительны:
Недействительные запросы отклоняются сервером с ошибкой |
show_groups | Необязательный. Если |
show_invited | Необязательный. Если В настоящее время требуется аутентификация пользователя . |
use_admin_access | Если Вызывающий пользователь должен быть администратором Google Workspace с правом управления чатом и беседами в чат-группах . Требуется область действия OAuth 2.0 Перечисление участников приложений в пространстве не поддерживается при использовании доступа администратора. |
ListMembershipsResponse
Ответ на список участников пространства.
Поля | |
---|---|
memberships[] | Неупорядоченный список. Список участников на запрошенной (или первой) странице. |
next_page_token | Токен, который вы можете отправить как |
Список сообщенийЗапрос
Перечисляет сообщения в указанном пространстве, членом которого является пользователь.
Поля | |
---|---|
parent | Необходимый. Имя ресурса пространства, из которого выводится список сообщений. Формат: |
page_size | Максимальное количество возвращенных сообщений. Служба может возвращать меньше сообщений, чем это значение. Если не указано, возвращается не более 25. Максимальное значение — 1000. Если вы используете значение больше 1000, оно автоматически изменится на 1000. Отрицательные значения возвращают ошибку |
page_token | Необязательно, если возобновляется предыдущий запрос. Токен страницы, полученный в результате предыдущего вызова сообщений списка. Укажите этот параметр, чтобы получить следующую страницу. При разбиении на страницы все остальные предоставленные параметры должны соответствовать вызову, который предоставил токен страницы. Передача других значений другим параметрам может привести к неожиданным результатам. |
filter | Фильтр запроса. Вы можете фильтровать сообщения по дате ( Чтобы фильтровать сообщения по дате их создания, укажите Чтобы фильтровать по потоку, укажите Чтобы фильтровать как по цепочке, так и по дате, используйте в запросе оператор Например, допустимы следующие запросы:
Недействительные запросы отклоняются сервером с ошибкой |
order_by | Необязательно, если возобновляется предыдущий запрос. Как упорядочивается список сообщений. Укажите значение для заказа с помощью операции упорядочивания. Действительные значения операции заказа следующие:
Порядок по умолчанию — |
show_deleted | Включать ли удаленные сообщения. Удаленные сообщения включают время удаления и метаданные об их удалении, но содержимое сообщения недоступно. |
ListMessagesResponse
Ответное сообщение для перечисления сообщений.
Поля | |
---|---|
messages[] | Список сообщений. |
next_page_token | Вы можете отправить токен как |
Список реакцийЗапрос
Перечисляет реакции на сообщение.
Поля | |
---|---|
parent | Необходимый. На сообщение отреагировали пользователи. Формат: |
page_size | Необязательный. Максимальное количество возвращенных реакций. Служба может вернуть меньше реакций, чем это значение. Если не указано, значение по умолчанию — 25. Максимальное значение — 200; значения выше 200 изменяются на 200. |
page_token | Необязательный. (При возобновлении предыдущего запроса.) Токен страницы, полученный в результате предыдущего вызова реакций списка. Предоставьте это, чтобы получить следующую страницу. При разбиении на страницы значение фильтра должно соответствовать вызову, который предоставил токен страницы. Передача другого значения может привести к неожиданным результатам. |
filter | Необязательный. Фильтр запроса. Вы можете фильтровать реакции по смайликам ( Чтобы отфильтровать реакции для нескольких смайлов или пользователей, объедините похожие поля с помощью оператора Чтобы фильтровать реакции по смайликам и пользователю, используйте оператор Если в вашем запросе используются как Например, допустимы следующие запросы:
Следующие запросы недействительны:
Недействительные запросы отклоняются сервером с ошибкой |
СписокРеакцийОтвет
Ответ на запрос списка реакций.
Поля | |
---|---|
reactions[] | Список реакций на запрошенной (или первой) странице. |
next_page_token | Токен продолжения для получения следующей страницы результатов. Последняя страница результатов пуста. |
ListSpaceEventsRequest
Сообщение запроса на перечисление космических событий.
Поля | |
---|---|
parent | Необходимый. Название ресурса пространства Google Chat , в котором произошли события. Формат: |
page_size | Необязательный. Возвращено максимальное количество космических событий. Служба может вернуть меньше этого значения. Отрицательные значения возвращают ошибку |
page_token | Токен страницы, полученный в результате предыдущего вызова событий пространства списка. Предоставьте это, чтобы получить следующую страницу. При разбиении на страницы все остальные параметры, предоставляемые для перечисления событий пространства, должны соответствовать вызову, который предоставил токен страницы. Передача других значений другим параметрам может привести к неожиданным результатам. |
filter | Необходимый. Фильтр запроса. Вы должны указать хотя бы один тип события ( При желании вы также можете фильтровать по времени начала (
Чтобы указать время начала или окончания, используйте оператор равенства Например, допустимы следующие запросы:
Следующие запросы недействительны:
Недействительные запросы отклоняются сервером с ошибкой |
ListSpaceEventsResponse
Ответное сообщение для перечисления космических событий.
Поля | |
---|---|
space_events[] | Результаты возвращаются в хронологическом порядке (сначала самое старое событие). |
next_page_token | Токен продолжения, используемый для получения дополнительных событий. Если это поле опущено, последующие страницы отсутствуют. |
Запрос ListSpacesRequest
Запрос на перечисление пространств, членом которых является вызывающий абонент.
Поля | |
---|---|
page_size | Необязательный. Максимальное количество возвращаемых пробелов. Служба может вернуть меньше этого значения. Если не указано, возвращается не более 100 пробелов. Максимальное значение — 1000. Если вы используете значение больше 1000, оно автоматически изменится на 1000. Отрицательные значения возвращают ошибку |
page_token | Необязательный. Токен страницы, полученный в результате предыдущего вызова пространств списка. Укажите этот параметр, чтобы получить следующую страницу. При разбиении на страницы значение фильтра должно соответствовать вызову, который предоставил токен страницы. Передача другого значения может привести к неожиданным результатам. |
filter | Необязательный. Фильтр запроса. Вы можете фильтровать пространства по типу пространства ( Для фильтрации по типу пространства необходимо указать допустимое значение перечисления, например Например, допустимы следующие запросы:
Недействительные запросы отклоняются сервером с ошибкой |
ListSpacesResponse
Ответ на запрос пространства списка.
Поля | |
---|---|
spaces[] | Список мест на запрошенной (или первой) странице. |
next_page_token | Вы можете отправить токен как |
Соответствующий URL
Соответствующий URL-адрес в сообщении чата. Приложения чата могут просматривать совпадающие URL-адреса. Дополнительную информацию см. в разделе Ссылки для предварительного просмотра .
Поля | |
---|---|
url | Только вывод. URL-адрес, который был сопоставлен. |
Членство
Представляет отношение членства в Google Chat, например, приглашен ли пользователь или приложение Chat в пространство, участвует в нем или отсутствует в нем.
Поля | |
---|---|
name | Имя ресурса членства, назначенное сервером. Формат: |
state | Только вывод. Состояние членства. |
role | Необязательный. Роль пользователя в чат-группе, определяющая разрешенные ему действия в этой области. Это поле можно использовать только в качестве входных данных в |
create_time | Необязательный. Неизменяемый. Время создания членства, например, когда участник присоединился или был приглашен присоединиться к пространству. Это поле предназначено только для вывода, за исключением случаев, когда оно используется для импорта исторического членства в пространствах режима импорта. |
delete_time | Необязательный. Неизменяемый. Время удаления членства, например, когда участник покинул пространство или был удален из него. Это поле предназначено только для вывода, за исключением случаев, когда оно используется для импорта исторического членства в пространствах режима импорта. |
Поле memberType . Участник, связанный с этим членством. Другие типы членов могут поддерживаться в будущем. memberType может быть только одним из следующих: | |
member | Пользователь или приложение Google Chat, которому соответствует членство. Если ваше приложение Chat авторизуется как пользователь , в выходных данных будут указаны |
group_member | Группа Google, которой соответствует членство. |
ЧленствоРоль
Представляет разрешенные действия пользователя в пространстве чата. В будущем могут быть добавлены дополнительные значения перечисления.
Перечисления | |
---|---|
MEMBERSHIP_ROLE_UNSPECIFIED | Значение по умолчанию. Для users : они не являются участниками сообщества, но их можно пригласить. Для Google Groups : им всегда назначается эта роль (в будущем могут использоваться другие значения перечисления). |
ROLE_MEMBER | Член космоса. У пользователя есть базовые разрешения, такие как отправка сообщений в пространство. В беседах 1:1 и неназванных групповых беседах эта роль есть у каждого. |
ROLE_MANAGER | Космический менеджер. Пользователь имеет все основные разрешения, а также административные разрешения, которые позволяют ему управлять пространством, например добавлять или удалять участников. Поддерживается только в SpaceType.SPACE . |
Государство Членства
Определяет связь члена с пробелом. Другие государства-члены могут получить поддержку в будущем.
Перечисления | |
---|---|
MEMBERSHIP_STATE_UNSPECIFIED | Значение по умолчанию. Не используйте. |
JOINED | Пользователь добавляется в пространство и может участвовать в нем. |
INVITED | Пользователя пригласили присоединиться к пространству, но он не присоединился к нему. |
NOT_A_MEMBER | Пользователь не принадлежит к пространству и не имеет ожидающего приглашения присоединиться к пространству. |
ЧленствоBatchCreatedEventData
Полезная нагрузка события для нескольких новых участников.
Тип события: google.workspace.chat.membership.v1.batchCreated
Поля | |
---|---|
memberships[] | Список новых участников. |
Членствобатчделетедэвентдата
Полезная нагрузка события для нескольких удаленных членств.
Тип события: google.workspace.chat.membership.v1.batchDeleted
Поля | |
---|---|
memberships[] | Список удаленных участников. |
Членствобатчупдатевентдата
Полезная нагрузка события для нескольких обновленных участников.
Тип события: google.workspace.chat.membership.v1.batchUpdated
Поля | |
---|---|
memberships[] | Список обновленных участников. |
Членствокреатедевентдата
Полезная нагрузка события для нового членства.
Тип события: google.workspace.chat.membership.v1.created
.
Поля | |
---|---|
membership | Новое членство. |
ЧленствоDeletedEventData
Полезная нагрузка события для удаленного членства.
Тип события: google.workspace.chat.membership.v1.deleted
Поля | |
---|---|
membership | Удаленное членство. Заполняются только поля |
ЧленствоUpdatedEventData
Полезная нагрузка события для обновленного членства.
Тип события: google.workspace.chat.membership.v1.updated
Поля | |
---|---|
membership | Обновленное членство. |
Сообщение
Сообщение в чате Google.
Поля | |
---|---|
name | Имя ресурса сообщения. Формат: Где Если вы задали собственный идентификатор при создании сообщения, вы можете использовать этот идентификатор для указания сообщения в запросе, заменив |
sender | Только вывод. Пользователь, создавший сообщение. Если ваше приложение Chat авторизуется как пользователь , в выходных данных будут указаны |
create_time | Необязательный. Неизменяемый. Для групп, созданных в Chat, — время создания сообщения. Это поле предназначено только для вывода, за исключением случаев, когда оно используется в пространствах режима импорта. Для пространств режима импорта установите в этом поле историческую временную метку создания сообщения в источнике, чтобы сохранить исходное время создания. |
last_update_time | Только вывод. Время, когда сообщение в последний раз редактировалось пользователем. Если сообщение ни разу не редактировалось, это поле пусто. |
delete_time | Только вывод. Время удаления сообщения в Google Chat. Если сообщение никогда не удаляется, это поле пусто. |
text | Простое текстовое тело сообщения. Первая ссылка на изображение, видео или веб-страницу генерирует чип предварительного просмотра . Вы также можете @упомянуть пользователя Google Chat или всех, кто находится в группе. Дополнительную информацию о создании текстовых сообщений см. в разделе «Отправка сообщения» . |
formatted_text | Только вывод. Содержит
Дополнительные сведения см. в разделе Просмотр форматирования текста, отправленного в сообщении. |
cards[] | Устарело: вместо этого используйте Насыщенные, форматированные и интерактивные карты, которые можно использовать для отображения элементов пользовательского интерфейса, таких как форматированный текст, кнопки и интерактивные изображения. Карточки обычно отображаются под текстовым текстом сообщения. |
cards_v2[] | Массив карт . Только приложения чата могут создавать карточки. Если ваше приложение Chat выполняет аутентификацию пользователя , сообщения не могут содержать карточки. Чтобы узнать, как создать сообщение, содержащее карточки, см. раздел «Отправка сообщения» . Создавайте и просматривайте карты с помощью Card Builder. Откройте конструктор карточек |
annotations[] | Только вывод. Аннотации, связанные с |
thread | Поток, которому принадлежит сообщение. Пример использования см . в разделе «Начать ветку сообщений или ответить на нее» . |
space | Если ваше приложение Chat авторизуется как пользователь , в выходных данных будет указано |
fallback_text | Простое текстовое описание карточек сообщения, используемое, когда фактические карточки невозможно отобразить, например мобильные уведомления. |
action_response | Только ввод. Параметры, которые приложение Chat может использовать для настройки способа публикации ответа. |
argument_text | Только вывод. Текст сообщения, из которого удалены все упоминания приложения Chat. |
slash_command | Только вывод. Слэш-команда, если применимо. |
attachment[] | Вложение, загруженное пользователем. |
matched_url | Только вывод. URL-адрес в |
thread_reply | Только вывод. Если Если пространство не поддерживает ответ в цепочках, это поле всегда имеет |
client_assigned_message_id | Необязательный. Пользовательский идентификатор сообщения. Вы можете использовать поле для идентификации сообщения или для получения, удаления или обновления сообщения. Чтобы установить собственный идентификатор, укажите поле |
emoji_reaction_summaries[] | Только вывод. Список сводок реакций смайликов на сообщение. |
private_message_viewer | Неизменяемый. Ввод для создания сообщения, в противном случае только вывод. Пользователь, который может просмотреть сообщение. Если этот параметр установлен, сообщение является личным и доступно только указанному пользователю и приложению Chat. Чтобы включить это поле в свой запрос, вам необходимо вызвать Chat API с использованием аутентификации приложения и опустить следующее: Подробную информацию см. в разделе Отправка сообщения лично . |
deletion_metadata | Только вывод. Информация об удаленном сообщении. Сообщение удаляется, если установлено |
quoted_message_metadata | Только вывод. Информация о сообщении, цитируемом пользователем Google Chat в пространстве. Пользователи Google Chat могут цитировать сообщение, чтобы ответить на него. |
attached_gifs[] | Только вывод. GIF-изображения, прикрепленные к сообщению. |
accessory_widgets[] | Один или несколько интерактивных виджетов, которые появляются внизу сообщения. Вы можете добавлять дополнительные виджеты к сообщениям, содержащим текст, карточки или и текст, и карточки. Не поддерживается для сообщений, содержащих диалоговые окна. Подробности см. в разделе Добавление интерактивных виджетов внизу сообщения . Для создания сообщения с дополнительными виджетами требуется аутентификация приложения . |
MessageBatchCreatedEventData
Полезная нагрузка события для нескольких новых сообщений.
Тип события: google.workspace.chat.message.v1.batchCreated
Поля | |
---|---|
messages[] | Список новых сообщений. |
MessageBatchDeletedEventData
Полезная нагрузка события для нескольких удаленных сообщений.
Тип события: google.workspace.chat.message.v1.batchDeleted
Поля | |
---|---|
messages[] | Список удаленных сообщений. |
MessageBatchUpdatedEventData
Полезная нагрузка события для нескольких обновленных сообщений.
Тип события: google.workspace.chat.message.v1.batchUpdated
Поля | |
---|---|
messages[] | Список обновленных сообщений. |
MessageCreatedEventData
Полезная нагрузка события для нового сообщения.
Тип события: google.workspace.chat.message.v1.created
Поля | |
---|---|
message | Новое сообщение. |
СообщениеDeletedEventData
Полезная нагрузка события для удаленного сообщения.
Тип события: google.workspace.chat.message.v1.deleted
Поля | |
---|---|
message | Удаленное сообщение. Заполняются только поля |
СообщениеUpdatedEventData
Полезная нагрузка события для обновленного сообщения.
Тип события: google.workspace.chat.message.v1.updated
Поля | |
---|---|
message | Обновленное сообщение. |
ЦитируемоеСообщениеМетаданные
Информация о цитируемом сообщении.
Поля | |
---|---|
name | Только вывод. Имя ресурса цитируемого сообщения. Формат: |
last_update_time | Только вывод. Временная метка создания или последнего обновления цитируемого сообщения. |
Реакция
Реакция на сообщение.
Поля | |
---|---|
name | Имя ресурса реакции. Формат: |
user | Только вывод. Пользователь, создавший реакцию. |
emoji | Смайлик, использованный в реакции. |
Реакциябатчкреатедевентдата
Полезная нагрузка события для нескольких новых реакций.
Тип события: google.workspace.chat.reaction.v1.batchCreated
Поля | |
---|---|
reactions[] | Список новых реакций. |
Реакциябатчделетедэвентдата
Полезная нагрузка события для нескольких удаленных реакций.
Тип события: google.workspace.chat.reaction.v1.batchDeleted
Поля | |
---|---|
reactions[] | Список удаленных реакций. |
Реакциякреатедевентдата
Полезная нагрузка события для новой реакции.
Тип события: google.workspace.chat.reaction.v1.created
Поля | |
---|---|
reaction | Новая реакция. |
РеакцияDeletedEventData
Полезная нагрузка события для удаленной реакции.
Введите: google.workspace.chat.reaction.v1.deleted
Поля | |
---|---|
reaction | Удаленная реакция. |
РичЛинкМетаданные
Богатая ссылка на ресурс.
Поля | |
---|---|
uri | URI этой ссылки. |
rich_link_type | Расширенный тип ссылки. |
data поля объединения. Данные для связанного ресурса. data могут быть только одним из следующих: | |
drive_link_data | Данные для ссылки на диск. |
chat_space_link_data | Данные для ссылки на чат. |
РичЛинкТип
Расширенный тип ссылки. В будущем могут быть добавлены и другие типы.
Перечисления | |
---|---|
RICH_LINK_TYPE_UNSPECIFIED | Значение по умолчанию для перечисления. Не используйте. |
DRIVE_FILE | Тип расширенной ссылки Google Диска. |
CHAT_SPACE | Тип расширенной ссылки в пространстве чата. Например, космический смарт-чип. |
ПоискПространстваЗапрос
Запрос на поиск списка пространств по запросу.
Поля | |
---|---|
use_admin_access | Если Вызывающий пользователь должен быть администратором Google Workspace с правом управления чатом и беседами в чат-группах . Требуется область OAuth 2.0 В настоящее время этот метод поддерживает только доступ администратора, поэтому для этого поля принимается только |
page_size | Максимальное количество возвращаемых пробелов. Служба может вернуть меньшее значение, чем это значение. Если не указано, возвращается не более 100 пробелов. Максимальное значение — 1000. Если вы используете значение больше 1000, оно автоматически изменится на 1000. |
page_token | Токен, полученный от предыдущего вызова пространств поиска. Укажите этот параметр, чтобы получить следующую страницу. При разбиении на страницы все остальные предоставленные параметры должны соответствовать вызову, который предоставил токен страницы. Передача других значений другим параметрам может привести к неожиданным результатам. |
query | Необходимый. Поисковый запрос. Вы можете осуществлять поиск по следующим параметрам:
В разных полях поддерживаются только операторы В том же поле Следующие примеры запросов действительны:
|
order_by | Необязательный. Как упорядочивается список пространств. Поддерживаемые атрибуты для заказа:
Допустимые значения операции заказа:
Поддерживаемый синтаксис:
|
SearchSpacesResponse
Ответ со списком пространств, соответствующих запросу пространств поиска.
Поля | |
---|---|
spaces[] | Страница запрошенных мест. |
next_page_token | Токен, который можно использовать для получения следующей страницы. Если это поле пустое, последующих страниц нет. |
total_size | Общее количество пробелов, соответствующих запросу, на всех страницах. Если результат превышает 10 000 пробелов, это значение является приблизительным. |
SetUpSpaceRequest
Запрос на создание пространства и добавление в него указанных пользователей.
Поля | |
---|---|
space | Необходимый. Поле Чтобы создать пространство, установите для Чтобы создать групповой чат, установите для Чтобы создать диалог 1:1 между людьми, установите для Чтобы создать разговор 1:1 между человеком и вызывающим приложением чата, установите для Если пространство |
request_id | Необязательный. Уникальный идентификатор этого запроса. Рекомендуется использовать случайный UUID. Указание существующего идентификатора запроса возвращает пространство, созданное с этим идентификатором, вместо создания нового пространства. Указание существующего идентификатора запроса из того же приложения чата с другим пользователем, прошедшим проверку подлинности, возвращает ошибку. |
memberships[] | Необязательный. Пользователи или группы Google Chat, которых можно пригласить присоединиться к группе. Опустите вызывающего пользователя, поскольку он добавляется автоматически. В настоящее время набор допускает до 20 участников (помимо вызывающего абонента). Для человеческого членства поле Для членства в группах Google поле Необязательно, если для Требуется при установке для Требуется при установке для Должно быть пустым при создании разговора 1:1 между человеком и вызывающим приложением чата (при установке для |
СлэшКоманда
Косая черта в Google Chat.
Поля | |
---|---|
command_id | Идентификатор вызванной косой черты. |
СлэшКомандаМетаданные
Метаданные аннотаций для команд с косой чертой (/).
Поля | |
---|---|
bot | Приложение чата, команда которого была вызвана. |
type | Тип косой черты. |
command_name | Имя вызванной команды слэша. |
command_id | Идентификатор вызванной команды с косой чертой. |
triggers_dialog | Указывает, предназначена ли косая черта для диалога. |
Тип
Перечисления | |
---|---|
TYPE_UNSPECIFIED | Значение по умолчанию для перечисления. Не используйте. |
ADD | Добавьте приложение «Чат» в пространство. |
INVOKE | Вызовите команду косой черты в пространстве. |
Космос
Место в Google Chat. Пространства — это разговоры между двумя или более пользователями или сообщения один на один между пользователем и приложением чата.
Поля | |
---|---|
name | Имя ресурса пространства. Формат: Где |
type | Только вывод. Устарело: вместо этого используйте |
space_type | Тип помещения. Требуется при создании пространства или обновлении типа пространства. Вывод только для другого использования. |
single_user_bot_dm | Необязательный. Является ли пространство личным сообщением между приложением чата и одним человеком. |
threaded | Только вывод. Устарело: вместо этого используйте |
display_name | Отображаемое имя пространства. Требуется при создании пространства . Если вы получаете сообщение об ошибке Для прямых сообщений это поле может быть пустым. Поддерживает до 128 символов. |
external_user_allowed | Неизменяемый. Разрешается ли в этом пространстве любому пользователю Google Chat быть участником. Ввод при создании пространства в организации Google Workspace. Пропустите это поле при создании пространств в следующих условиях:
Для существующих пространств это поле предназначено только для вывода. |
space_threading_state | Только вывод. Состояние потока в пространстве чата. |
space_details | Подробная информация о пространстве, включая описание и правила. |
space_history_state | Состояние истории сообщений и потоков в этом пространстве. |
import_mode | Необязательный. Создано ли это пространство в |
create_time | Необязательный. Неизменяемый. Для пространств, созданных в Chat, — время создания пространства. Это поле предназначено только для вывода, за исключением случаев, когда оно используется в пространствах режима импорта. Для пространств режима импорта установите в этом поле историческую временную метку создания пространства в источнике, чтобы сохранить исходное время создания. Заполняется в выходных данных только в том случае, если |
last_active_time | Только вывод. Временная метка последнего сообщения в пространстве. |
admin_installed | Только вывод. Для пространств прямого обмена сообщениями (DM) с приложением Chat: было ли пространство создано администратором Google Workspace. Администраторы могут установить и настроить прямое сообщение с помощью приложения Chat от имени пользователей в своей организации. Чтобы поддерживать установку администратора, ваше приложение Chat должно поддерживать прямой обмен сообщениями. |
membership_count | Только вывод. Количество присоединившихся участников, сгруппированных по типу участников. Заполняется, когда |
access_settings | Необязательный. Указывает настройки доступа к пространству. Заполняется только в том случае, если |
space_uri | Только вывод. URI для доступа пользователя к пространству. |
Поле объединения space_permission_settings . Представляет настройки разрешений пространства. Заполняется только в том случае, если space_type равен SPACE . space_permission_settings может быть только одним из следующих: | |
predefined_permission_settings | Необязательный. Только ввод. Настройки разрешения пространства. Входные данные для создания пространства. Если это поле не задано, создается пространство для совместной работы. После создания пространства параметры заполняются в поле |
permission_settings | Необязательный. Точные настройки разрешений, которые можно установить для обновления пространства. Вход для обновления пространства. В противном случае только вывод. Вместо этого для создания пространства используйте |
Доступ к настройкам
Представляет настройки доступа к пространству.
Поля | |
---|---|
access_state | Только вывод. Указывает состояние доступа к пространству. |
audience | Необязательный. Имя ресурса целевой аудитории , которая может обнаружить пространство, присоединиться к нему и просмотреть сообщения в пространстве. Если этот параметр не установлен, доступ к нему смогут получить только пользователи или группы Google, которые были индивидуально приглашены или добавлены в пространство. Подробную информацию см. в разделе «Как сделать пространство доступным для обнаружения целевой аудиторией» . Формат: Чтобы использовать целевую аудиторию по умолчанию для организации Google Workspace, установите |
Аксессстате
Представляет состояние доступа к пространству.
Перечисления | |
---|---|
ACCESS_STATE_UNSPECIFIED | Состояние доступа неизвестно или не поддерживается в этом API. |
PRIVATE | Только пользователи или группы Google, которые были индивидуально добавлены или приглашены другими пользователями или администраторами Google Workspace, могут находить пространство и получать к нему доступ. |
DISCOVERABLE | Менеджер пространства предоставил целевой аудитории доступ к пространству. Пользователи или группы Google, которые были индивидуально добавлены или приглашены в пространство, также могут находить его и получать к нему доступ. Дополнительные сведения см. в разделе Как сделать пространство доступным для просмотра определенным пользователям . |
ЧленствоКаунт
Представляет количество участников пространства, сгруппированных по категориям.
Поля | |
---|---|
joined_direct_human_user_count | Подсчет пользователей-людей, которые напрямую присоединились к пространству, не считая пользователей, присоединившихся путем членства в присоединенной группе. |
joined_group_count | Подсчет всех групп, которые напрямую присоединились к пространству. |
Настройка разрешений
Представляет параметр разрешения пространства.
Поля | |
---|---|
managers_allowed | Есть ли у менеджеров пространств это разрешение. |
members_allowed | Имеют ли участники, не являющиеся менеджерами, это разрешение. |
Настройки разрешений
Настройки разрешений для именованного пространства. Чтобы задать настройки разрешений при создании пространства, укажите в запросе поле PredefinedPermissionSettings
.
Поля | |
---|---|
manage_members_and_groups | Настройка управления участниками и группами в пространстве. |
modify_space_details | Настройка обновления названия пространства, аватара, описания и рекомендаций. |
toggle_history | Настройка включения и выключения истории пространства. |
use_at_mention_all | Настройка использования @all в пространстве. |
manage_apps | Настройка управления приложениями в пространстве. |
manage_webhooks | Настройка управления веб-перехватчиками в пространстве. |
post_messages | Только вывод. Настройка публикации сообщений в пространстве. |
reply_messages | Настройка ответа на сообщения в пространстве. |
Предопределенные параметры разрешений
Параметры разрешений пространства, которые можно указать при создании именованного пространства. В будущем могут быть добавлены дополнительные настройки. Подробные сведения о настройках разрешений для именованных пространств см. в разделе Дополнительные сведения о пространствах .
Перечисления | |
---|---|
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED | Не указано. Не используйте. |
COLLABORATION_SPACE | Настройка, позволяющая сделать это пространство пространством для совместной работы, где все участники могут публиковать сообщения. |
ANNOUNCEMENT_SPACE | Настройка, позволяющая сделать пространство пространством объявлений, где только менеджеры пространства могут публиковать сообщения. |
ПространствоДетали
Подробная информация о пространстве, включая описание и правила.
Поля | |
---|---|
description | Необязательный. Описание помещения. Например, опишите тему обсуждения, функциональное назначение или участников пространства. Поддерживает до 150 символов. |
guidelines | Необязательный. Правила, ожидания и этикет этого места. Поддерживает до 5000 символов. |
SpaceThreadingState
Указывает тип состояния потока в пространстве чата.
Перечисления | |
---|---|
SPACE_THREADING_STATE_UNSPECIFIED | Сдержанный. |
THREADED_MESSAGES | Именованные пространства, поддерживающие потоки сообщений. Когда пользователи отвечают на сообщение, они могут ответить в цепочке, что сохраняет их ответ в контексте исходного сообщения. |
GROUPED_MESSAGES | Именованные пространства, где беседа организована по темам. Темы и ответы на них сгруппированы вместе. |
UNTHREADED_MESSAGES | Прямые сообщения (DM) между двумя людьми и групповые беседы между 3 или более людьми. |
Тип пространства
Тип помещения. Требуется при создании или обновлении пространства. Вывод только для другого использования.
Перечисления | |
---|---|
SPACE_TYPE_UNSPECIFIED | Сдержанный. |
SPACE | Место, где люди отправляют сообщения, обмениваются файлами и сотрудничают. SPACE может включать в себя приложения чата. |
GROUP_CHAT | Групповые беседы между 3 и более людьми. GROUP_CHAT может включать приложения чата. |
DIRECT_MESSAGE | Сообщения 1:1 между двумя людьми или человеком и приложением чата. |
Тип
Устарело: вместо этого используйте SpaceType
.
Перечисления | |
---|---|
TYPE_UNSPECIFIED | Сдержанный. |
ROOM | Разговоры между двумя и более людьми. |
DM | 1:1 Прямое сообщение между человеком и приложением чата, где все сообщения однородны. Обратите внимание, что сюда не входят прямые сообщения между двумя людьми. |
Спейсбатчупдатедевентдата
Полезная нагрузка события для нескольких обновлений пространства.
Тип события: google.workspace.chat.space.v1.batchUpdated
Поля | |
---|---|
spaces[] | Список обновленных пространств. |
SpaceEvent
Событие, которое представляет собой изменение или действие в пространстве Google Chat. Дополнительную информацию см. в разделе Работа с событиями из Google Chat .
Поля | |
---|---|
name | Имя ресурса космического события. Формат: |
event_time | Время, когда произошло событие. |
event_type | Тип космического события. У каждого типа события есть пакетная версия, которая представляет несколько экземпляров события типа, происходящих за короткий период времени. Для запросов Поддерживаемые типы событий для сообщений :
Поддерживаемые типы событий для членства :
Поддерживаемые типы событий для реакций :
Поддерживаемые типы событий о пространстве :
|
| |
message_created_event_data | Полезная нагрузка события для нового сообщения. Тип события: |
message_updated_event_data | Полезная нагрузка события для обновленного сообщения. Тип события: |
message_deleted_event_data | Полезная нагрузка события для удаленного сообщения. Тип события: |
message_batch_created_event_data | Полезная нагрузка события для нескольких новых сообщений. Тип события: |
message_batch_updated_event_data | Полезная нагрузка события для нескольких обновленных сообщений. Тип события: |
message_batch_deleted_event_data | Полезная нагрузка события для нескольких удаленных сообщений. Тип события: |
space_updated_event_data | Полезная нагрузка события для космического обновления. Тип события: |
space_batch_updated_event_data | Полезная нагрузка события для нескольких обновлений пространства. Тип события: |
membership_created_event_data | Полезная нагрузка события для нового членства. Тип события: |
membership_updated_event_data | Полезная нагрузка события для обновленного членства. Тип события: |
membership_deleted_event_data | Полезная нагрузка события для удаленного членства. Тип события: |
membership_batch_created_event_data | Полезная нагрузка события для нескольких новых участников. Тип события: |
membership_batch_updated_event_data | Полезная нагрузка события для нескольких обновленных участников. Тип события: |
membership_batch_deleted_event_data | Полезная нагрузка события для нескольких удаленных членств. Тип события: |
reaction_created_event_data | Полезная нагрузка события для новой реакции. Тип события: |
reaction_deleted_event_data | Полезная нагрузка события для удаленной реакции. Тип события: |
reaction_batch_created_event_data | Полезная нагрузка события для нескольких новых реакций. Тип события: |
reaction_batch_deleted_event_data | Полезная нагрузка события для нескольких удаленных реакций. Тип события: |
Пространствочтениестате
Состояние чтения пользователя в пространстве, используемое для идентификации прочитанных и непрочитанных сообщений.
Поля | |
---|---|
name | Имя ресурса состояния чтения пространства. Формат: |
last_read_time | Необязательный. Время обновления состояния чтения пространства пользователя. Обычно это соответствует либо временной метке последнего прочитанного сообщения, либо временной метке, указанной пользователем для обозначения последней прочитанной позиции в пробеле. |
Спейсупдатедевентдата
Полезная нагрузка события для обновленного пространства.
Тип события: google.workspace.chat.space.v1.updated
Поля | |
---|---|
space | Обновленное пространство. |
Нить
Обсуждение в чате Google. Пример использования см . в разделе «Начать ветку сообщений или ответить на нее» .
Если вы указываете поток при создании сообщения, вы можете установить поле messageReplyOption
, чтобы определить, что произойдет, если соответствующий поток не найден.
Поля | |
---|---|
name | Имя ресурса потока. Пример: |
thread_key | Необязательный. Входные данные для создания или обновления потока. В противном случае только вывод. Идентификатор потока. Поддерживает до 4000 символов. Этот идентификатор уникален для приложения Chat, которое его устанавливает. Например, если несколько приложений чата создают сообщение, используя один и тот же ключ цепочки, сообщения публикуются в разных цепочках. Чтобы ответить в теме, созданной человеком или другим приложением чата, вместо этого укажите поле |
ThreadReadState
Состояние чтения пользователя в потоке, используемое для идентификации прочитанных и непрочитанных сообщений.
Поля | |
---|---|
name | Имя ресурса состояния чтения потока. Формат: |
last_read_time | Время обновления состояния чтения пользовательского потока. Обычно это соответствует временной метке последнего прочитанного сообщения в потоке. |
Обновление запроса на членство
Сообщение с запросом на обновление членства.
Поля | |
---|---|
membership | Необходимый. Членство для обновления. Обновляются только поля, указанные в |
update_mask | Необходимый. Пути к полям для обновления. Разделяйте несколько значений запятыми или используйте В настоящее время поддерживаются пути к полям:
|
use_admin_access | Если Вызывающий пользователь должен быть администратором Google Workspace с правом управления чатом и беседами в чат-группах . Требуется область действия OAuth 2.0 |
Запрос обновления сообщения
Запрос на обновление сообщения.
Поля | |
---|---|
message | Необходимый. Сообщение с обновленными полями. |
update_mask | Необходимый. Пути к полям для обновления. Разделяйте несколько значений запятыми или используйте В настоящее время поддерживаются пути к полям:
|
allow_missing | Необязательный. Если |
UpdateSpaceReadStateRequest
Сообщение запроса для API UpdateSpaceReadState.
Поля | |
---|---|
space_read_state | Необходимый. Состояние чтения пространства и поля для обновления. Поддерживается обновление состояния чтения только для вызывающего пользователя. Чтобы обратиться к вызывающему пользователю, установите одно из следующих значений:
Формат: пользователи/{user}/spaces/{space}/spaceReadState |
update_mask | Необходимый. Пути к полям для обновления. В настоящее время поддерживаются пути к полям:
Если значение Чтобы пометить пространство как прочитанное, установите для параметра |
Обновление пространства запрос
Запрос на обновление отдельного пространства.
Поля | |
---|---|
space | Необходимый. Пространство с полями для обновления. |
update_mask | Необходимый. Обновленные пути к полям, разделенные запятыми, если их несколько. Вы можете обновить следующие поля для пространства:
|
use_admin_access | Если Вызывающий пользователь должен быть администратором Google Workspace с правом управления чатом и беседами в чат-группах . Требуется область действия OAuth 2.0 Некоторые значения |
Пользователь
Пользователь в Google Chat. При возврате в качестве выходных данных запроса, если ваше приложение Chat проходит аутентификацию как пользователь , выходные данные для ресурса User
содержат только name
и type
пользователя.
Поля | |
---|---|
name | Название ресурса для Формат: Для
|
display_name | Только вывод. Отображаемое имя пользователя. |
domain_id | Уникальный идентификатор домена Google Workspace пользователя. |
type | Тип пользователя. |
is_anonymous | Только вывод. Если |
Тип
Перечисления | |
---|---|
TYPE_UNSPECIFIED | Значение по умолчанию для перечисления. НЕ ИСПОЛЬЗУЙТЕ. |
HUMAN | Пользователь-человек. |
BOT | Пользователь приложения чата. |
UserMentionМетаданные
Метаданные аннотаций для упоминаний пользователей (@).
Поля | |
---|---|
user | Пользователь упомянул. |
type | Тип упоминания пользователя. |
Тип
Перечисления | |
---|---|
TYPE_UNSPECIFIED | Значение по умолчанию для перечисления. Не используйте. |
ADD | Добавьте пользователя в пространство. |
MENTION | Упомяните пользователя в космосе. |
Разметка виджета
Виджет — это элемент пользовательского интерфейса, который представляет текст и изображения.
Поля | |
---|---|
buttons[] | Список кнопок. Кнопки также являются |
data поля объединения. WidgetMarkup может содержать только один из следующих элементов. Вы можете использовать несколько полей WidgetMarkup для отображения большего количества элементов. data могут быть только одним из следующих: | |
text_paragraph | Отобразите текстовый абзац в этом виджете. |
image | Отобразите изображение в этом виджете. |
key_value | Отобразите элемент ключевого значения в этом виджете. |
Кнопка
Кнопка. Это может быть текстовая кнопка или кнопка изображения.
Поля | |
---|---|
| |
text_button | Кнопка с текстом и действием |
image_button | Кнопка с изображением и действием |
ФормаДействие
Действие формы описывает поведение при отправке формы. Например, вы можете вызвать Apps Script для обработки формы.
Поля | |
---|---|
action_method_name | Имя метода используется для определения того, какая часть формы вызвала отправку формы. Эта информация возвращается в приложение Chat как часть события щелчка карты. Вы можете использовать одно и то же имя метода для нескольких элементов, которые вызывают общее поведение. |
parameters[] | Список параметров действия. |
Параметр действия
Список строковых параметров, которые необходимо указать при вызове метода действия. Например, рассмотрим три кнопки повтора: отложить сейчас, отложить один день, отложить на следующей неделе. Вы можете использовать action method = snooze()
, передав тип и время повтора в списке строковых параметров.
Поля | |
---|---|
key | Имя параметра сценария действия. |
value | Значение параметра. |
Икона
Набор поддерживаемых иконок.
Перечисления | |
---|---|
ICON_UNSPECIFIED | |
AIRPLANE | |
BOOKMARK | |
BUS | |
CAR | |
CLOCK | |
CONFIRMATION_NUMBER_ICON | |
DOLLAR | |
DESCRIPTION | |
EMAIL | |
EVENT_PERFORMER | |
EVENT_SEAT | |
FLIGHT_ARRIVAL | |
FLIGHT_DEPARTURE | |
HOTEL | |
HOTEL_ROOM_TYPE | |
INVITE | |
MAP_PIN | |
MEMBERSHIP | |
MULTIPLE_PEOPLE | |
OFFER | |
PERSON | |
PHONE | |
RESTAURANT_ICON | |
SHOPPING_CART | |
STAR | |
STORE | |
TICKET | |
TRAIN | |
VIDEO_CAMERA | |
VIDEO_PLAY |
Изображение
Изображение, заданное URL-адресом и может иметь действие onclick
.
Поля | |
---|---|
image_url | URL-адрес изображения. |
on_click | Действие |
aspect_ratio | Соотношение сторон этого изображения (ширина и высота). Это поле позволяет вам зарезервировать нужную высоту изображения во время ожидания его загрузки. Он не предназначен для переопределения встроенного соотношения сторон изображения. Если этот параметр не установлен, сервер заполняет его, предварительно загружая изображение. |
Кнопка изображения
Кнопка изображения с действием onclick
.
Поля | |
---|---|
on_click | Действие |
name | Имя этой |
icons полей Союза. Значок можно указать с помощью enum Icon или URL-адреса. icons могут быть только одним из следующих: | |
icon | Значок, заданный |
icon_url | Значок, заданный URL-адресом. |
КлючЗначение
Элемент пользовательского интерфейса содержит ключ (метку) и значение (содержимое). Этот элемент также может содержать некоторые действия, такие как кнопка onclick
.
Поля | |
---|---|
top_label | Текст верхней метки. Поддерживается форматированный текст. Дополнительную информацию о форматировании текста см. в разделах «Форматирование текста в приложениях Google Chat» и «Форматирование текста в надстройках Google Workspace» . |
content | Текст контента. Форматированный текст поддерживается и всегда требуется. Дополнительную информацию о форматировании текста см. в разделах «Форматирование текста в приложениях Google Chat» и «Форматирование текста в надстройках Google Workspace» . |
content_multiline | Если контент должен быть многострочным. |
bottom_label | Текст нижней метки. Поддерживается форматированный текст. Дополнительную информацию о форматировании текста см. в разделах «Форматирование текста в приложениях Google Chat» и «Форматирование текста в надстройках Google Workspace» . |
on_click | Действие |
icons полей Союза. Должен быть определен хотя бы один из значков: top_label и bottom_label . icons могут быть только одним из следующих: | |
icon | Значение перечисления, которое API Chat заменяет соответствующим изображением значка. |
icon_url | Значок, заданный URL-адресом. |
Полевой control Союза. Виджет управления. Вы можете установить либо button , либо switch_widget , но не оба сразу. control может быть только одним из следующих: | |
button | Кнопка, по которой можно нажать, чтобы вызвать действие. |
OnClick
Действие onclick
(например, открытие ссылки).
Поля | |
---|---|
| |
action | Действие формы запускается этим действием |
open_link | Это действие |
ОпенЛинк
Ссылка, открывающая новое окно.
Поля | |
---|---|
url | URL-адрес для открытия. |
ТекстКнопка
Кнопка с текстом и действием onclick
.
Поля | |
---|---|
text | Текст кнопки. |
on_click | Действие |
ТекстАбзац
Абзац текста. Поддерживается форматированный текст. Дополнительную информацию о форматировании текста см. в разделах «Форматирование текста в приложениях Google Chat» и «Форматирование текста в надстройках Google Workspace» .
Поля | |
---|---|
text | |