Индекс
-
Action
(сообщение) -
Action.ActionParameter
(сообщение) -
Action.Interaction
(перечисление) -
Action.LoadIndicator
(перечисление) -
BorderStyle
(сообщение) -
BorderStyle.BorderType
(перечисление) -
Button
(сообщение) -
Button.Type
(перечисление) -
ButtonList
(сообщение) -
Card
(сообщение) -
Card.CardAction
(сообщение) -
Card.CardFixedFooter
(сообщение) -
Card.CardHeader
(сообщение) -
Card.DisplayStyle
(перечисление) -
Card.DividerStyle
(перечисление) -
Card.Section
(сообщение) -
Chip
(сообщение) -
ChipList
(сообщение) -
ChipList.Layout
(перечисление) -
CollapseControl
(сообщение) -
Columns
(сообщение) -
Columns.Column
(сообщение) -
Columns.Column.HorizontalSizeStyle
(перечисление) -
Columns.Column.VerticalAlignment
(перечисление) -
Columns.Column.Widgets
(сообщение) -
DateTimePicker
(сообщение) -
DateTimePicker.DateTimePickerType
(перечисление) -
DecoratedText
(сообщение) -
DecoratedText.SwitchControl
(сообщение) -
DecoratedText.SwitchControl.ControlType
(перечисление) -
Divider
(сообщение) -
EndNavigation
(сообщение) -
EndNavigation.Action
(перечисление) -
GetAutocompletionResponse
(сообщение) -
Grid
(сообщение) -
Grid.GridItem
(сообщение) -
Grid.GridItem.GridItemLayout
(перечисление) -
Icon
(сообщение) -
Image
(сообщение) -
ImageComponent
(сообщение) -
ImageCropStyle
(сообщение) -
ImageCropStyle.ImageCropType
(перечисление) -
Link
(сообщение) -
LinkPreview
(сообщение) -
MaterialIcon
(сообщение) -
Navigation
(сообщение) -
Notification
(сообщение) -
OnClick
(сообщение) -
OpenLink
(сообщение) -
OpenLink.OnClose
(перечисление) -
OpenLink.OpenAs
(перечисление) -
OverflowMenu
(сообщение) -
OverflowMenu.OverflowMenuItem
(сообщение) -
RenderActions
(сообщение) -
RenderActions.Action
(сообщение) -
SelectionInput
(сообщение) -
SelectionInput.PlatformDataSource
(сообщение) -
SelectionInput.PlatformDataSource.CommonDataSource
(перечисление) -
SelectionInput.SelectionItem
(сообщение) -
SelectionInput.SelectionType
(перечисление) -
SubmitFormResponse
(сообщение) -
Suggestions
(сообщение) -
Suggestions.SuggestionItem
(сообщение) -
TextInput
(сообщение) -
TextInput.Type
(перечисление) -
TextParagraph
(сообщение) -
Validation
(сообщение) -
Validation.InputType
(перечисление) -
Widget
(сообщение) -
Widget.HorizontalAlignment
(перечисление) -
Widget.ImageType
(перечисление)
Действие
Действие, описывающее поведение при отправке формы. Например, вы можете вызвать сценарий Apps Script для обработки формы. Если действие срабатывает, значения формы отправляются на сервер.
Доступно для приложений Google Chat и дополнений Google Workspace.
Поля | |
---|---|
function | Пользовательская функция, вызываемая при щелчке по содержащему элементу или его активации иным образом. Пример использования см. в разделе Чтение данных формы . |
parameters[] | Список параметров действия. |
loadIndicator | Указывает индикатор загрузки, который отображается при вызове действия. |
persistValues | Указывает, сохраняются ли значения формы после действия. Значение по умолчанию — Если Если |
interaction | Необязательный. Требуется при открытии диалога . Что делать в ответ на взаимодействие с пользователем, например, когда пользователь нажимает кнопку в сообщении с карточкой. Если не указано, приложение отвечает, выполняя Указав Доступно для приложений Google Chat и недоступно для дополнений Google Workspace. |
requiredWidgets[] | Необязательный. Заполните этот список именами виджетов, которые нужны этому Действию для действительной отправки. Если перечисленные здесь виджеты не имеют значения при вызове этого действия, отправка формы прерывается. Доступно для приложений Google Chat и дополнений Google Workspace. |
allWidgetsAreRequired | Необязательный. Если это правда, то все виджеты считаются необходимыми для этого действия. Доступно для приложений Google Chat и дополнений Google Workspace. |
Параметр действия
Список строковых параметров, которые необходимо указать при вызове метода действия. Например, рассмотрим три кнопки повтора: отложить сейчас, отложить один день или отложить на следующей неделе. Вы можете использовать action method = snooze()
, передав тип и время повтора в списке строковых параметров.
Дополнительные сведения см. в CommonEventObject
.
Доступно для приложений Google Chat и дополнений Google Workspace.
Поля | |
---|---|
key | Имя параметра сценария действия. |
value | Значение параметра. |
Взаимодействие
Необязательный. Требуется при открытии диалога .
Что делать в ответ на взаимодействие с пользователем, например, когда пользователь нажимает кнопку в сообщении с карточкой.
Если не указано, приложение отвечает, выполняя action
, например открытие ссылки или запуск функции, как обычно.
Указав interaction
, приложение может реагировать особым интерактивным способом. Например, установив для interaction
значение OPEN_DIALOG
, приложение сможет открыть диалоговое окно .
Если указано, индикатор загрузки не отображается. Если указано для надстройки, вся карта удаляется и в клиенте ничего не отображается.
Доступно для приложений Google Chat и недоступно для дополнений Google Workspace.
Перечисления | |
---|---|
INTERACTION_UNSPECIFIED | Значение по умолчанию. action выполняется как обычно. |
OPEN_DIALOG | Открывает диалоговое окно — оконный интерфейс на основе карточек, который приложения чата используют для взаимодействия с пользователями. Поддерживается только приложениями чата в ответ на нажатие кнопок в карточных сообщениях. Если указано для надстройки, вся карта удаляется и в клиенте ничего не отображается. Доступно для приложений Google Chat и недоступно для дополнений Google Workspace. |
Индикатор нагрузки
Указывает индикатор загрузки, который отображается при вызове действия.
Доступно для приложений Google Chat и дополнений Google Workspace.
Перечисления | |
---|---|
SPINNER | Отображает счетчик, указывающий на загрузку содержимого. |
NONE | Ничего не отображается. |
BorderStyle
Параметры стиля границы карточки или виджета, включая тип и цвет границы.
Доступно для приложений Google Chat и дополнений Google Workspace.
Поля | |
---|---|
type | Тип границы. |
strokeColor | Цвета, которые будут использоваться, если тип Чтобы задать цвет обводки, укажите значение для полей Например, следующий код устанавливает красный цвет с максимальной интенсивностью:
Поле |
cornerRadius | Угловой радиус границы. |
Тип границы
Представляет типы границ, применяемые к виджетам.
Доступно для приложений Google Chat и дополнений Google Workspace.
Перечисления | |
---|---|
BORDER_TYPE_UNSPECIFIED | Не используйте. Не указано. |
NO_BORDER | Значение по умолчанию. Нет границы. |
STROKE | Контур. |
Кнопка
Текст, значок или кнопка с текстом и значком, которую пользователи могут нажать. Пример использования приложений Google Chat см. в разделе « Добавление кнопки» .
Чтобы сделать изображение интерактивной кнопкой, укажите
(а не Image
) и установите действие ImageComponent
onClick
.
Доступно для приложений Google Chat и дополнений Google Workspace.
Поля | |
---|---|
text | Текст, отображаемый внутри кнопки. |
icon | Значок, отображаемый внутри кнопки. Если установлены и |
color | Необязательный. Цвет кнопки. Если этот параметр установлен, Чтобы задать цвет кнопки, укажите значение для полей Например, следующий код устанавливает красный цвет с максимальной интенсивностью:
Поле |
onClick | Необходимый. Действие, которое необходимо выполнить, когда пользователь нажимает кнопку, например открытие гиперссылки или запуск пользовательской функции. |
disabled | Если |
altText | Альтернативный текст, используемый для специальных возможностей. Установите описательный текст, который позволит пользователям узнать, что делает кнопка. Например, если кнопка открывает гиперссылку, вы можете написать: «Открывает новую вкладку браузера и переходит к документации для разработчиков Google Chat по адресу https://developers.google.com/workspace/chat» . |
type | Необязательный. Тип кнопки. Если этот параметр не установлен, тип кнопки по умолчанию — Доступно для приложений Google Chat и недоступно для дополнений Google Workspace. |
Тип
Необязательный. Тип кнопки. Если поле color
установлено, type
принудительно устанавливается FILLED
.
Доступно для приложений Google Chat и недоступно для дополнений Google Workspace.
Перечисления | |
---|---|
TYPE_UNSPECIFIED | Не используйте. Не указано. |
OUTLINED | Кнопки с контуром — это кнопки со средним выделением. Обычно они содержат важные действия, но не являются основным действием в приложении Chat или надстройке. |
FILLED | Заполненная кнопка имеет контейнер сплошного цвета. Он имеет наибольший визуальный эффект и рекомендуется для важных и основных действий в приложении чата или надстройке. |
FILLED_TONAL | Заполненная тональная кнопка — это альтернативный вариант между заполненными и обведенными кнопками. Они полезны в контекстах, где кнопка с более низким приоритетом требует немного большего внимания, чем кнопка с контуром. |
BORDERLESS | Кнопка не имеет невидимого контейнера в состоянии по умолчанию. Его часто используют для действий с самым низким приоритетом, особенно при представлении нескольких вариантов. |
Список кнопок
Список кнопок, расположенных горизонтально. Пример использования приложений Google Chat см. в разделе « Добавление кнопки» .
Доступно для приложений Google Chat и дополнений Google Workspace.
Поля | |
---|---|
buttons[] | Массив кнопок. |
Карта
Интерфейс карты, отображаемый в сообщении Google Chat или надстройке Google Workspace.
Карты поддерживают определенный макет, интерактивные элементы пользовательского интерфейса, такие как кнопки, и мультимедийные средства, такие как изображения. Используйте карточки, чтобы представить подробную информацию, собрать информацию от пользователей и помочь им сделать следующий шаг.
Создавайте и просматривайте карты с помощью Card Builder.
Откройте конструктор карточекЧтобы узнать, как создавать карты, см. следующую документацию:
- О приложениях Google Chat см. раздел Разработка компонентов карточки или диалогового окна .
- Информацию о надстройках Google Workspace см. в разделе Интерфейсы на основе карт .
Пример: карточное сообщение для приложения Google Chat.
Чтобы создать образец сообщения-карточки в Google Chat, используйте следующий JSON:
{
"cardsV2": [
{
"cardId": "unique-card-id",
"card": {
"header": {
"title": "Sasha",
"subtitle": "Software Engineer",
"imageUrl":
"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
"imageType": "CIRCLE",
"imageAltText": "Avatar for Sasha"
},
"sections": [
{
"header": "Contact Info",
"collapsible": true,
"uncollapsibleWidgetsCount": 1,
"widgets": [
{
"decoratedText": {
"startIcon": {
"knownIcon": "EMAIL"
},
"text": "sasha@example.com"
}
},
{
"decoratedText": {
"startIcon": {
"knownIcon": "PERSON"
},
"text": "<font color=\"#80e27e\">Online</font>"
}
},
{
"decoratedText": {
"startIcon": {
"knownIcon": "PHONE"
},
"text": "+1 (555) 555-1234"
}
},
{
"buttonList": {
"buttons": [
{
"text": "Share",
"onClick": {
"openLink": {
"url": "https://example.com/share"
}
}
},
{
"text": "Edit",
"onClick": {
"action": {
"function": "goToView",
"parameters": [
{
"key": "viewType",
"value": "EDIT"
}
]
}
}
}
]
}
}
]
}
]
}
}
]
}
Поля | |
---|---|
header | Заголовок карты. Заголовок обычно содержит ведущее изображение и заголовок. Заголовки всегда отображаются вверху карточки. |
sections[] | Содержит коллекцию виджетов. Каждый раздел имеет свой собственный необязательный заголовок. Разделы визуально разделены разделителем. Пример использования приложений Google Chat см. в разделе «Определение раздела карточки» . |
sectionDividerStyle | Стиль разделителя между разделами. |
cardActions[] | Действия карты. Действия добавляются в меню панели инструментов карточки. Доступно для дополнений Google Workspace и недоступно для приложений Google Chat. Например, следующий JSON создает меню действий карты с параметрами
|
name | Название карты. Используется в качестве идентификатора карты при карточной навигации. Доступно для дополнений Google Workspace и недоступно для приложений Google Chat. |
fixedFooter | Фиксированный нижний колонтитул, показанный внизу этой карточки. Установка Доступно для приложений Google Chat и дополнений Google Workspace. |
displayStyle | В надстройках Google Workspace задает свойства отображения Доступно для дополнений Google Workspace и недоступно для приложений Google Chat. |
peekCardHeader | При отображении контекстного контента заголовок карточки просмотра действует как заполнитель, позволяя пользователю перемещаться между карточками главной страницы и контекстными карточками. Доступно для дополнений Google Workspace и недоступно для приложений Google Chat. |
КартаДействие
Действие карты — это действие, связанное с картой. Например, карточка счета-фактуры может включать в себя такие действия, как удаление счета, отправка счета по электронной почте или открытие счета в браузере.
Доступно для дополнений Google Workspace и недоступно для приложений Google Chat.
Поля | |
---|---|
actionLabel | Метка, которая отображается как элемент меню действий. |
onClick | Действие |
Заголовок карты
Представляет заголовок карты. Пример использования приложений Google Chat см. в разделе Добавление заголовка .
Доступно для приложений Google Chat и дополнений Google Workspace.
Поля | |
---|---|
title | Необходимый. Название шапки карты. Заголовок имеет фиксированную высоту: если указаны и заголовок, и подзаголовок, каждый занимает одну строку. Если указан только заголовок, он занимает обе строки. |
subtitle | Подзаголовок шапки карты. Если указано, отображается на отдельной строке под |
imageType | Форма, используемая для обрезки изображения. Доступно для приложений Google Chat и дополнений Google Workspace. |
imageUrl | URL-адрес HTTPS изображения в заголовке карточки. |
imageAltText | Альтернативный текст этого изображения, используемый для специальных возможностей. |
Стиль отображения
В надстройках Google Workspace определяет способ отображения карточки.
Доступно для дополнений Google Workspace и недоступно для приложений Google Chat.
Перечисления | |
---|---|
DISPLAY_STYLE_UNSPECIFIED | Не используйте. Не указано. |
PEEK | Заголовок карты отображается внизу боковой панели, частично закрывая текущую верхнюю карту стопки. При нажатии на заголовок карточка помещается в стопку карточек. Если у карты нет заголовка, вместо него используется сгенерированный заголовок. |
REPLACE | Значение по умолчанию. Карта отображается путем замены вида верхней карты в стопке карт. |
РазделительСтиль
Стиль разделителя карты. В настоящее время используется только для разделителей между разделами карты.
Доступно для приложений Google Chat и дополнений Google Workspace.
Перечисления | |
---|---|
DIVIDER_STYLE_UNSPECIFIED | Не используйте. Не указано. |
SOLID_DIVIDER | Вариант по умолчанию. Создайте сплошной разделитель. |
NO_DIVIDER | Если установлено, разделитель не отображается. Этот стиль полностью удаляет разделитель из макета. Результат эквивалентен тому, что разделитель вообще не добавляется. |
Раздел
Раздел содержит коллекцию виджетов, которые отображаются вертикально в указанном порядке.
Доступно для приложений Google Chat и дополнений Google Workspace.
Поля | |
---|---|
header | Текст, который отображается вверху раздела. Поддерживает простой текст в формате HTML. Дополнительную информацию о форматировании текста см. в разделах «Форматирование текста в приложениях Google Chat» и «Форматирование текста в надстройках Google Workspace» . |
widgets[] | Все виджеты в разделе. Должен содержать хотя бы один виджет. |
collapsible | Указывает, является ли этот раздел сворачиваемым. Сворачиваемые разделы скрывают некоторые или все виджеты, но пользователи могут развернуть раздел, чтобы отобразить скрытые виджеты, нажав «Показать больше» . Пользователи могут снова скрыть виджеты, нажав «Показать меньше» . Чтобы определить, какие виджеты скрыты, укажите |
uncollapsibleWidgetsCount | Количество несворачиваемых виджетов, которые остаются видимыми, даже если раздел свернут. Например, если раздел содержит пять виджетов и для |
collapseControl | Необязательный. Определите кнопку развертывания и свертывания раздела. Эта кнопка будет отображаться только в том случае, если раздел сворачивается. Если это поле не задано, используется кнопка по умолчанию. Доступно для приложений Google Chat и недоступно для дополнений Google Workspace. |
Чип
Текст, значок или чип текста и значков, на который пользователи могут щелкнуть.
Доступно для приложений Google Chat и недоступно для дополнений Google Workspace.
Поля | |
---|---|
icon | Изображение значка. Если установлены и |
label | Текст, отображаемый внутри чипа. |
onClick | Необязательный. Действие, которое необходимо выполнить, когда пользователь щелкает чип, например открытие гиперссылки или запуск пользовательской функции. |
enabled | Находится ли чип в активном состоянии и реагирует ли на действия пользователя. По умолчанию |
disabled | Находится ли чип в неактивном состоянии и игнорирует действия пользователя. По умолчанию установлено значение |
altText | Альтернативный текст, используемый для специальных возможностей. Установите описательный текст, который позволит пользователям узнать, что делает чип. Например, если чип открывает гиперссылку, напишите: «Открывает новую вкладку браузера и переходит к документации для разработчиков Google Chat по адресу https://developers.google.com/workspace/chat» . |
Список чипов
Список фишек, расположенный горизонтально, который можно либо прокручивать по горизонтали, либо переносить на следующую строку.
Доступно для приложений Google Chat и недоступно для дополнений Google Workspace.
Поля | |
---|---|
layout | Указанный макет списка микросхем. |
chips[] | Массив фишек. |
Макет
Схема списка чипов.
Перечисления | |
---|---|
LAYOUT_UNSPECIFIED | Не используйте. Не указано. |
WRAPPED | Значение по умолчанию. Список чипов переносится на следующую строку, если недостаточно места по горизонтали. |
HORIZONTAL_SCROLLABLE | Фишки прокручиваются горизонтально, если не помещаются в доступное пространство. |
СвернутьControl
Представляет элемент управления развертыванием и свертыванием. Доступно для приложений Google Chat и недоступно для дополнений Google Workspace.
Поля | |
---|---|
horizontalAlignment | Горизонтальное выравнивание кнопки развернуть и свернуть. |
expandButton | Необязательный. Определите настраиваемую кнопку, чтобы развернуть раздел. Поле «expandButton» и «CrollButton» должно быть установлено. Только один набор полей не вступит в силу. Если это поле не задано, используется кнопка по умолчанию. |
collapseButton | Необязательный. Определите настраиваемую кнопку, чтобы свернуть раздел. Поле «expandButton» и «CrollButton» должно быть установлено. Только один набор полей не вступит в силу. Если это поле не задано, используется кнопка по умолчанию. |
Столбцы
Виджет Columns
отображает до двух столбцов на карточке или в диалоговом окне. Вы можете добавлять виджеты в каждый столбец; виджеты отображаются в том порядке, в котором они указаны. Пример использования приложений Google Chat см. в разделе Отображение карточек и диалоговых окон в столбцах .
Высота каждого столбца определяется более высоким столбцом. Например, если первый столбец выше второго, оба столбца будут иметь высоту первого столбца. Поскольку каждый столбец может содержать разное количество виджетов, вы не можете определять строки или выравнивать виджеты между столбцами.
Столбцы отображаются рядом. Вы можете настроить ширину каждого столбца, используя поле HorizontalSizeStyle
. Если ширина экрана пользователя слишком узкая, второй столбец переносится ниже первого:
- В Интернете второй столбец переносится, если ширина экрана меньше или равна 480 пикселям.
- На устройствах iOS второй столбец переносится, если ширина экрана меньше или равна 300 pt.
- На устройствах Android второй столбец переносится, если ширина экрана меньше или равна 320 dp.
Чтобы включить более двух столбцов или использовать строки, используйте виджет
. Grid
Доступно для приложений Google Chat и дополнений Google Workspace. Дополнительные пользовательские интерфейсы, поддерживающие столбцы, включают:
- Диалоговое окно отображается, когда пользователи открывают надстройку из черновика электронного письма.
- Диалоговое окно, отображаемое, когда пользователи открывают надстройку из меню «Добавить вложение» в событии Календаря Google.
Поля | |
---|---|
columnItems[] | Массив столбцов. Вы можете включить до двух столбцов в карточку или диалог. |
Столбец
Колонка.
Поля | |
---|---|
horizontalSizeStyle | Указывает, как столбец заполняет ширину карточки. |
horizontalAlignment | Указывает, выравниваются ли виджеты по левому, правому или центру столбца. |
verticalAlignment | Указывает, выравниваются ли виджеты по верху, низу или центру столбца. |
widgets[] | Массив виджетов, включенных в столбец. Виджеты отображаются в том порядке, в котором они указаны. |
Горизонтальныйразмерстиль
Указывает, как столбец заполняет ширину карточки. Ширина каждого столбца зависит как от HorizontalSizeStyle
, так и от ширины виджетов внутри столбца.
Перечисления | |
---|---|
HORIZONTAL_SIZE_STYLE_UNSPECIFIED | Не используйте. Не указано. |
FILL_AVAILABLE_SPACE | Значение по умолчанию. Столбец заполняет доступное пространство до 70 % ширины карты. Если для обоих столбцов установлено значение FILL_AVAILABLE_SPACE , каждый столбец заполняет 50 % пространства. |
FILL_MINIMUM_SPACE | Столбец занимает минимально возможное пространство и не более 30 % ширины карты. |
Вертикальное выравнивание
Указывает, выравниваются ли виджеты по верху, низу или центру столбца.
Перечисления | |
---|---|
VERTICAL_ALIGNMENT_UNSPECIFIED | Не используйте. Не указано. |
CENTER | Значение по умолчанию. Выравнивает виджеты по центру столбца. |
TOP | Выравнивает виджеты по верху столбца. |
BOTTOM | Выравнивает виджеты по нижней части столбца. |
Виджеты
Поддерживаемые виджеты, которые можно включить в столбец.
Поля | |
---|---|
| |
textParagraph | Виджет |
image | Виджет |
decoratedText | Виджет |
buttonList | Виджет |
textInput | Виджет |
selectionInput | Виджет |
dateTimePicker | Виджет |
chipList | Виджет |
DateTimePicker
Позволяет пользователям вводить дату, время или дату и время одновременно. Пример использования приложений Google Chat см. в разделе Разрешить пользователю выбирать дату и время .
Пользователи могут вводить текст или использовать средство выбора для выбора даты и времени. Если пользователи вводят неверную дату или время, средство выбора отображает ошибку, которая предлагает пользователям ввести информацию правильно.
Доступно для приложений Google Chat и дополнений Google Workspace.
Поля | |
---|---|
name | Имя, по которому Подробные сведения о работе с входными данными формы см. в разделе Получение данных формы . |
label | Текст, предлагающий пользователям ввести дату, время или дату и время. Например, если пользователи планируют встречу, используйте метку, например |
type | Поддерживает ли виджет ввод даты, времени или даты и времени. |
valueMsEpoch | Значение по умолчанию, отображаемое в виджете, в миллисекундах с момента эпохи Unix . Укажите значение в зависимости от типа средства выбора (
|
timezoneOffsetDate | Число, представляющее смещение часового пояса от UTC в минутах. Если установлено, |
onChangeAction | Срабатывает, когда пользователь нажимает кнопку «Сохранить» или «Очистить» в интерфейсе |
validation | Необязательный. Укажите проверку, необходимую для этого средства выбора даты и времени. Доступно для приложений Google Chat и дополнений Google Workspace. |
DateTimePickerType
Формат даты и времени в виджете DateTimePicker
. Определяет, могут ли пользователи вводить дату, время или дату и время одновременно.
Доступно для приложений Google Chat и дополнений Google Workspace.
Перечисления | |
---|---|
DATE_AND_TIME | Пользователи вводят дату и время. |
DATE_ONLY | Пользователи вводят дату. |
TIME_ONLY | Пользователи вводят время. |
УкрашенныйТекст
Виджет, отображающий текст с дополнительными украшениями, такими как метка над или под текстом, значок перед текстом, виджет выбора или кнопка после текста. Пример использования приложений Google Chat см. в разделе Отображение текста с декоративным текстом .
Доступно для приложений Google Chat и дополнений Google Workspace.
Поля | |
---|---|
icon | Устарело в пользу |
startIcon | Значок отображается перед текстом. |
topLabel | Текст, который появляется над |
text | Необходимый. Первичный текст. Поддерживает простое форматирование. Дополнительную информацию о форматировании текста см. в разделах «Форматирование текста в приложениях Google Chat» и «Форматирование текста в надстройках Google Workspace» . |
wrapText | Настройка переноса текста. Если Применяется только к |
bottomLabel | Текст, который отображается под |
onClick | Это действие запускается, когда пользователи нажимают |
Полевой control Союза. Кнопка, переключатель, флажок или изображение, которое отображается справа от текста в виджете decoratedText . control может быть только одним из следующих: | |
button | Кнопка, которую пользователь может нажать, чтобы вызвать действие. |
switchControl | Виджет переключения, по которому пользователь может щелкнуть, чтобы изменить его состояние и вызвать действие. |
endIcon | Значок, отображаемый после текста. Поддерживает встроенные и пользовательские значки. |
SwitchControl
Либо переключатель в стиле тумблера, либо флажок внутри виджета decoratedText
.
Доступно для приложений Google Chat и дополнений Google Workspace.
Поддерживается только в виджете decoratedText
.
Поля | |
---|---|
name | Имя, по которому виджет переключения идентифицируется в событии ввода формы. Подробные сведения о работе с входными данными формы см. в разделе Получение данных формы . |
value | Значение, введенное пользователем и возвращаемое как часть события ввода формы. Подробные сведения о работе с входными данными формы см. в разделе Получение данных формы . |
selected | Если |
onChangeAction | Действие, которое необходимо выполнить при изменении состояния переключателя, например, какую функцию запускать. |
controlType | Как переключатель отображается в пользовательском интерфейсе. Доступно для приложений Google Chat и дополнений Google Workspace. |
Тип управления
Как переключатель отображается в пользовательском интерфейсе.
Доступно для приложений Google Chat и дополнений Google Workspace.
Перечисления | |
---|---|
SWITCH | Тумблерный переключатель. |
CHECKBOX | Устарело в пользу CHECK_BOX . |
CHECK_BOX | Флажок. |
Разделитель
Этот тип не имеет полей.
Отображает разделитель между виджетами в виде горизонтальной линии. Пример использования приложений Google Chat см. в разделе «Добавление горизонтального разделителя между виджетами» .
Доступно для приложений Google Chat и дополнений Google Workspace.
Например, следующий JSON создает разделитель:
"divider": {}
Получитьавтодополнениеответ
Ответ на получение контейнера автозаполнения, который включает элементы, необходимые для отображения элементов автозаполнения для текстового поля.
Доступно для дополнений Google Workspace и недоступно для приложений Google Chat. Например:
{
"autoComplete": {
"items": [
{
"text": "C++"
},
{
"text": "Java"
},
{
"text": "JavaScript"
},
{
"text": "Python"
}
]
}
}
Поля | |
---|---|
autoComplete | |
schema | Это неиспользуемое поле схемы, которое может присутствовать в разметке для проверки синтаксиса. |
Сетка
Отображает сетку с коллекцией элементов. Элементы могут включать только текст или изображения. Для адаптивных столбцов или для включения большего количества текста или изображений используйте
. Пример использования приложений Google Chat см. в разделе Отображение сетки с коллекцией элементов .Columns
Сетка поддерживает любое количество столбцов и элементов. Количество строк определяется элементами, разделенными столбцами. Сетка с 10 элементами и 2 столбцами имеет 5 строк. Сетка с 11 элементами и 2 столбцами имеет 6 строк.
Доступно для приложений Google Chat и дополнений Google Workspace.
Например, следующий JSON создает сетку из двух столбцов с одним элементом:
"grid": {
"title": "A fine collection of items",
"columnCount": 2,
"borderStyle": {
"type": "STROKE",
"cornerRadius": 4
},
"items": [
{
"image": {
"imageUri": "https://www.example.com/image.png",
"cropStyle": {
"type": "SQUARE"
},
"borderStyle": {
"type": "STROKE"
}
},
"title": "An item",
"textAlignment": "CENTER"
}
],
"onClick": {
"openLink": {
"url": "https://www.example.com"
}
}
}
Поля | |
---|---|
title | Текст, который отображается в заголовке сетки. |
items[] | Элементы, отображаемые в сетке. |
borderStyle | Стиль границы, применяемый к каждому элементу сетки. |
columnCount | Количество столбцов, отображаемых в сетке. Значение по умолчанию используется, если это поле не указано, и это значение по умолчанию различается в зависимости от того, где отображается сетка (диалоговое окно или сопутствующий текст). |
onClick | Этот обратный вызов повторно используется каждым отдельным элементом сетки, но к параметрам обратного вызова добавляется идентификатор и индекс элемента в списке элементов. |
Гридитем
Представляет элемент в макете сетки. Элементы могут содержать текст, изображение или и текст, и изображение.
Доступно для приложений Google Chat и дополнений Google Workspace.
Поля | |
---|---|
id | Заданный пользователем идентификатор для этого элемента сетки. Этот идентификатор возвращается в параметрах обратного вызова |
image | Изображение, которое отображается в элементе сетки. |
title | Название элемента сетки. |
subtitle | Подзаголовок элемента сетки. |
layout | Макет, используемый для элемента сетки. |
GridItemLayout
Представляет различные параметры макета, доступные для элемента сетки.
Доступно для приложений Google Chat и дополнений Google Workspace.
Перечисления | |
---|---|
GRID_ITEM_LAYOUT_UNSPECIFIED | Не используйте. Не указано. |
TEXT_BELOW | Заголовок и подзаголовок отображаются под изображением элемента сетки. |
TEXT_ABOVE | Заголовок и подзаголовок отображаются над изображением элемента сетки. |
Икона
Значок, отображаемый в виджете на карточке. Пример использования приложений Google Chat см. в разделе Добавление значка .
Поддерживает встроенные и пользовательские значки.
Доступно для приложений Google Chat и дополнений Google Workspace.
Поля | |
---|---|
altText | Необязательный. Описание значка, используемого для специальных возможностей. Если не указано, предоставляется значение Если значок установлен в |
imageType | К изображению применен стиль обрезки. В некоторых случаях применение обрезки |
icons полей Союза. Значок, отображаемый в виджете на карте. icons могут быть только одним из следующих: | |
knownIcon | Отобразите один из встроенных значков Google Workspace. Например, чтобы отобразить значок самолета, укажите Полный список поддерживаемых значков см. в разделе «Встроенные значки» . |
iconUrl | Отображение пользовательского значка, размещенного по URL-адресу HTTPS. Например:
Поддерживаемые типы файлов: |
materialIcon | Отобразите один из значков материалов Google . Например, чтобы отобразить значок флажка , используйте
Доступно для приложений Google Chat и недоступно для дополнений Google Workspace. |
Изображение
Изображение, заданное URL-адресом и может иметь действие onClick
. Пример см. в разделе «Добавление изображения» .
Доступно для приложений Google Chat и дополнений Google Workspace.
Поля | |
---|---|
imageUrl | URL-адрес HTTPS, на котором размещено изображение. Например:
|
onClick | Когда пользователь щелкает изображение, щелчок запускает это действие. |
altText | Альтернативный текст этого изображения, используемый для специальных возможностей. |
Компонент изображения
Представляет изображение.
Доступно для приложений Google Chat и дополнений Google Workspace.
Поля | |
---|---|
imageUri | URL-адрес изображения. |
altText | Метка доступности изображения. |
cropStyle | Стиль обрезки, применяемый к изображению. |
borderStyle | Стиль границы, применяемый к изображению. |
СтильОбрезки Изображения
Представляет стиль обрезки, примененный к изображению.
Доступно для приложений Google Chat и дополнений Google Workspace.
Например, вот как применить соотношение сторон 16:9:
cropStyle {
"type": "RECTANGLE_CUSTOM",
"aspectRatio": 16/9
}
Поля | |
---|---|
type | Тип урожая. |
aspectRatio | Соотношение сторон, которое будет использоваться, если тип кадрирования — Например, вот как применить соотношение сторон 16:9:
|
ТипОбрезки Изображения
Представляет стиль обрезки, примененный к изображению.
Доступно для приложений Google Chat и дополнений Google Workspace.
Перечисления | |
---|---|
IMAGE_CROP_TYPE_UNSPECIFIED | Не используйте. Не указано. |
SQUARE | Значение по умолчанию. Применяет квадратную обрезку. |
CIRCLE | Применяет круговую обрезку. |
RECTANGLE_CUSTOM | Применяет прямоугольную обрезку с настраиваемым соотношением сторон. Установите пользовательское соотношение сторон с aspectRatio . |
RECTANGLE_4_3 | Применяет прямоугольную обрезку с соотношением сторон 4:3. |
Связь
Объект ссылки для стороннего ресурса, который возвращается в надстройку. Для получения дополнительной информации см. Создание сторонних ресурсов из меню @ .
Доступно для Google Workspace Adsons и недоступно для приложений Google Chat.
Поля | |
---|---|
url | URL ссылки, чтобы вернуться в дополнение. |
title | Название ссылки, чтобы вернуться в дополнение. |
LinkPreview
Действие карты, которое предварительно просмотрит стороннюю ссылку, отображая карту и интеллектуального чипа. Чтобы узнать больше, см. Предварительные ссылки с интеллектуальными чипсами .
Доступно для Google Workspace Adsons и недоступно для приложений Google Chat.
Например, следующий JSON возвращает уникальный заголовок для предварительного просмотра ссылки и его интеллектуального чипа, а также предварительного просмотра с описанием заголовка и текста:
{
"action": {
"linkPreview": {
"title": "Smart chip title",
"linkPreviewTitle": "Link preview title",
"previewCard": {
"header": {
"title": "Preview card header",
},
"sections": [
{
"widgets": [
{
"textParagraph": {
"text": "Description of the link."
}
}
]
}
]
}
}
}
}
Пример возвращает предварительный просмотр следующей ссылки:
Поля | |
---|---|
previewCard | Карта, которая отображает информацию о ссылке из сторонней службы. |
title | Заголовок, который отображается в Smart Chip для предварительного просмотра ссылки. Если нет, Smart Chip отображает заголовок |
linkPreviewTitle | Заголовок, который отображается в предварительном просмотре ссылки. Если USET, предварительный просмотр ссылки отображает заголовок |
Материал
Значок материала Google , который включает в себя более 2500 опций.
Например, чтобы отобразить значок флажки с индивидуальным весом и оценкой, напишите следующее:
{
"name": "check_box",
"fill": true,
"weight": 300,
"grade": -25
}
Доступно для приложений Google Chat и недоступно для надстройки Google Workspace.
Поля | |
---|---|
name | Имя значка, определенное в значке материала Google , например, |
fill | Будь то иконка заполненной. Значение по умолчанию неверно. Чтобы предварительно просмотреть различные настройки значка, перейдите на значки шрифта Google и настройте настройки настройки . |
weight | Вес инсульта иконы. Выберите из {100, 200, 300, 400, 500, 600, 700}. Если отсутствует значение по умолчанию 400. Если указано какое -либо другое значение, используется значение по умолчанию. Чтобы предварительно просмотреть различные настройки значка, перейдите на значки шрифта Google и настройте настройки настройки . |
grade | Вес и оценка влияют на толщину символа. Корректировки к оценке более детализируют, чем корректировки веса, и оказывают небольшое влияние на размер символа. Выберите из {-25, 0, 200}. Если отсутствие, значение по умолчанию равно 0. Если указано какое -либо другое значение, значение по умолчанию используется. Чтобы предварительно просмотреть различные настройки значка, перейдите на значки шрифта Google и настройте настройки настройки . |
Уведомление
Действие карты, которое отображает уведомление в приложении хоста.
Доступно для Google Workspace Adsons и недоступно для приложений Google Chat.
Поля | |
---|---|
text | Простой текст для отображения для уведомления, без тегов HTML. |
OnClick
Представляет, как ответить, когда пользователи нажимают интерактивный элемент на карте, такой как кнопка.
Доступно для приложений Google Chat и надстройки Google Workspace.
Поля | |
---|---|
Объединенные полевые | |
action | Если указано, действие запускается этим |
openLink | Если указано, этот |
openDynamicLinkAction | Дополнительное действие запускает это действие, когда действие должно открыть ссылку. Это отличается от Доступно для Google Workspace Adsons и недоступно для приложений Google Chat. |
card | Новая карта перемещается в стек карт после нажатия, если указано. Доступно для Google Workspace Adsons и недоступно для приложений Google Chat. |
overflowMenu | Если указано, этот |
OpenLink
Представляет собой событие onClick
, которое открывает гиперссылку.
Доступно для приложений Google Chat и надстройки Google Workspace.
Поля | |
---|---|
url | URL открыть. |
openAs | Как открыть ссылку. Доступно для Google Workspace Adsons и недоступно для приложений Google Chat. |
onClose | Забудет ли клиент о ссылке после ее открытия или наблюдает до тех пор, пока окно не закроется. Доступно для Google Workspace Adsons и недоступно для приложений Google Chat. |
Onclose
То, что делает клиент, когда ссылка, открываемая действием OnClick
, закрыта.
Реализация зависит от возможностей клиентской платформы. Например, веб-браузер может открыть ссылку во всплывающем окне с помощью обработчика OnClose
.
Если установлены как OnOpen
, так и OnClose
Handlers, и клиентская платформа не может поддерживать оба значения, OnClose
имеет приоритет.
Доступно для Google Workspace Adsons и недоступно для приложений Google Chat.
Перечисление | |
---|---|
NOTHING | Значение по умолчанию. Карта не перезагружается; ничего не происходит. |
RELOAD | Перезагружает карту после закрытия детского окна. При использовании в сочетании с |
OpenS
Когда действие OnClick
открывает ссылку, тогда клиент может либо открыть его как полноразмерное окно (если это кадр, используемый клиентом), либо наложением (например, всплывающее окно). Реализация зависит от возможностей клиентской платформы, и выбранное значение может быть проигнорировано, если клиент не поддерживает ее. FULL_SIZE
поддерживается всеми клиентами.
Доступно для Google Workspace Adsons и недоступно для приложений Google Chat.
Перечисление | |
---|---|
FULL_SIZE | Ссылка открывается как полноразмерное окно (если это кадр, используемый клиентом). |
OVERLAY | Ссылка открывается как наложение, например, всплывающее окно. |
Overflowmenu
Виджет, который представляет всплывающее меню с одним или несколькими действиями, которые могут вызвать пользователи. Например, показывая невидимые действия в карте. Вы можете использовать этот виджет, когда действия не вписываются в доступное пространство. Чтобы использовать, укажите этот виджет в OnClick
виджетов, которые его поддерживают. Например, в Button
.
Доступно для приложений Google Chat и недоступно для надстройки Google Workspace.
Поля | |
---|---|
items[] | Необходимый. Список вариантов меню. |
Overflowmenuitem
Вариант, который пользователи могут вызвать в меню переполнения.
Доступно для приложений Google Chat и недоступно для надстройки Google Workspace.
Поля | |
---|---|
startIcon | Значок отображается перед текстом. |
text | Необходимый. Текст, который идентифицирует или описывает элемент для пользователей. |
onClick | Необходимый. Действие вызвано, когда выбрана опция меню. Этот |
disabled | Отключен ли параметр меню. По умолчанию ложно. |
Рендеринги
Набор инструкций по рендерингу, который сообщает карте для выполнения действия или сообщает приложению Add-Host или приложению Chat для выполнения специфического приложения действий.
Доступно для приложений Google Chat и надстройки Google Workspace.
Поля | |
---|---|
action | |
hostAppAction | Действия, выполняемые отдельными приложениями хоста. |
schema | Это поле схемы NO-OP, которое может присутствовать в наценке для проверки синтаксиса. |
Действие
Поля | |
---|---|
navigations[] | Нажмите, всплывают или обновляют отображаемые карты. |
link | Немедленно откройте целевую ссылку на новой вкладке или всплывающее окно. |
notification | Отобразить уведомление для конечного пользователя. |
linkPreview | Отобразить предварительный просмотр ссылки на конечного пользователя. |
links[] | Ссылка для стороннего ресурса, созданного из приложения Google Workspace. Отформатируется как массив объектов с одним элементом. Для получения дополнительной информации см. Создание сторонних ресурсов из меню @ . |
SelectionInput
Виджет, который создает один или несколько элементов пользовательского интерфейса, которые могут выбрать пользователи. Например, выпадающее меню или флажки. Вы можете использовать этот виджет для сбора данных, которые могут быть предсказаны или перечислены. Для примера в приложениях Google Chat см. «Добавить выбранные элементы пользовательского интерфейса» .
Приложения чата могут обрабатывать значение элементов, которые пользователи выбирают или вводятся. Для получения подробной информации о работе с входами формы см. Данные формы приема .
Чтобы собрать неопределенные или абстрактные данные от пользователей, используйте виджет TextInput
.
Доступно для приложений Google Chat и надстройки Google Workspace.
Поля | |
---|---|
name | Необходимый. Имя, которое идентифицирует ввод выбора в событии ввода формы. Для получения подробной информации о работе с входами формы см. Данные формы приема . |
label | Текст, который появляется над полем ввода выбора в пользовательском интерфейсе. Укажите текст, который помогает пользователю ввести информацию, необходимую вашему приложению. Например, если пользователи выбирают срочность рабочего билета из раскрывающегося меню, этикетка может быть «срочно» или «выберите срочность». |
type | Тип элементов, которые отображаются пользователям в виджете |
items[] | Массив выбранных элементов. Например, массив радиопроизводств или флажок. Поддерживает до 100 предметов. |
onChangeAction | Если указано, форма отправляется при изменении выбора. Если не указано, вы должны указать отдельную кнопку, которая подчиняет форму. Для получения подробной информации о работе с входами формы см. Данные формы приема . |
multiSelectMaxSelectedItems | Для MultiSelect Menus максимальное количество элементов, которые пользователь может выбрать. Минимальное значение - 1 элемент. Если не указано, по умолчанию 3 пункта. |
multiSelectMinQueryLength | Для MultiSelect Menus количество текстовых символов, которые пользователь вводит перед приложением, запрашивает автозаполнение и отображает предлагаемые элементы в меню. Если не указано, по умолчанию до 0 символов для статических источников данных и 3 символов для внешних источников данных. |
validation | Для выпадающих меню проверку для этого поля ввода выбора. Доступно для приложений Google Chat и надстройки Google Workspace. |
Поле Союза Доступно для приложений Google Chat и недоступно для надстройки Google Workspace. | |
externalDataSource | Внешний источник данных, такой как реляционная база данных. |
platformDataSource | Источник данных из Google Workspace. |
PlatformDatasource
Для виджета
, в котором используется многоселекное меню, источник данных из Google Workspace. Используется для заполнения предметов в многосекционном меню. SelectionInput
Доступно для приложений Google Chat и недоступно для надстройки Google Workspace.
Поля | |
---|---|
Поле Союза data_source . Источник данных. data_source может быть только одним из следующих: | |
commonDataSource | Источник данных, разделяемый всеми приложениями Google Workspace, таких как пользователи в организации Google Workspace. |
hostAppDataSource | Источник данных, уникальный для хост-приложения Google Workspace, например пространства в Google Chat. Это поле поддерживает клиентские библиотеки Google API, но не доступно в библиотеках Cloud Client. Чтобы узнать больше, см. Установите клиентские библиотеки . |
Commondatasource
Источник данных, разделяемый всеми приложениями Google Workspace .
Доступно для приложений Google Chat и недоступно для надстройки Google Workspace.
Перечисление | |
---|---|
UNKNOWN | Значение по умолчанию. Не используйте. |
USER | Пользователи Google Workspace. Пользователь может просматривать и выбирать пользователей только из своей организации Google Workspace. |
SelectionItem
Элемент, который пользователи могут выбрать во входе выбора, например, флажок или коммутатор.
Доступно для приложений Google Chat и надстройки Google Workspace.
Поля | |
---|---|
text | Текст, который идентифицирует или описывает элемент для пользователей. |
value | Значение, связанное с этим элементом. Клиент должен использовать это в качестве входного значения формы. Для получения подробной информации о работе с входами формы см. Данные формы приема . |
selected | Будет ли элемент выбран по умолчанию. Если ввод выбора принимает только одно значение (например, для радиопроизводительных кнопок или раскрывающегося меню), установите это поле только для одного элемента. |
startIconUri | Для MultiSelect Menus URL -адрес для значка, отображаемого рядом с |
bottomText | Для MultiSelect Menus текстовое описание или этикетку, отображаемое ниже |
SelectionType
Формат для элементов, которые пользователи могут выбрать. Различные параметры поддерживают различные типы взаимодействий. Например, пользователи могут выбрать несколько флажков, но могут выбрать только один элемент из раскрывающегося меню.
Каждый ввод выбора поддерживает один тип выбора. Например, смешивание флажок и коммутаторов не поддерживается.
Доступно для приложений Google Chat и надстройки Google Workspace.
Перечисление | |
---|---|
CHECK_BOX | Набор флажок. Пользователи могут выбрать один или несколько флажков. |
RADIO_BUTTON | Набор радиопроизводств. Пользователи могут выбрать одну радиопроизводительную кнопку. |
SWITCH | Набор переключателей. Пользователи могут включать один или несколько коммутаторов. |
DROPDOWN | Выпадающее меню. Пользователи могут выбрать один элемент из меню. |
MULTI_SELECT | Многосекционное меню для статических или динамических данных. В строке меню пользователи выбирают один или несколько элементов. Пользователи также могут вводить значения для заполнения динамических данных. Например, пользователи могут начать набирать имя пространства чата Google, а виджет автоматически использует пространство. Чтобы заполнить элементы для многосекционного меню, вы можете использовать один из следующих типов источников данных:
Примеры того, как реализовать MultiSelect Menus, см. Добавьте меню MultiSelect . Доступно для приложений Google Chat и надстройки Google Workspace. |
Отправить формулируйте
Ответ на отправку формы, кроме получения контейнера с автозаполнением, который содержит действия, которые должна выполнять карту, и/или приложение Add-Host должно выполнять, и изменилось ли состояние карты.
Доступно для Google Workspace Adsons и недоступно для приложений Google Chat. Например:
{
"renderActions": {
"action": {
"notification": {
"text": "Email address is added: salam.heba@example.com"
}
},
"hostAppAction": {
"gmailAction": {
"openCreatedDraftAction": {
"draftId": "msg-a:r-79766936926021702",
"threadServerPermId": "thread-f:15700999851086004"
}
}
}
}
}
Поля | |
---|---|
renderActions | Набор инструкций по рендерингу, который сообщает карте выполнить действие и/или сообщает приложению Add-Host для выполнения специфического приложения действие. |
stateChanged | Изменилось ли состояние карт, и данные в существующих картах устареют. |
schema | Это поле схемы NO-OP, которое может присутствовать в наценке для проверки синтаксиса. |
Предложения
Предлагаемые значения, в которые пользователи могут ввести. Эти значения появляются, когда пользователи нажимают внутри поля ввода текста. Как вводит пользователи, предлагаемые значения динамически фильтровали, чтобы соответствовать тому, что напечатали пользователи.
Например, поле ввода текста для языка программирования может предложить Java, JavaScript, Python и C ++. Когда пользователи начнут печатать Jav
, список предложений фильтровал, чтобы показать Java
и JavaScript
.
Предлагаемые значения помогают пользователям вводить значения, которые может понять ваше приложение. При ссылке на JavaScript некоторые пользователи могут ввести javascript
, а другие java script
. Предложение JavaScript
может стандартизировать, как пользователи взаимодействуют с вашим приложением.
Когда указано, TextInput.type
всегда SINGLE_LINE
, даже если он устанавливается на MULTIPLE_LINE
.
Доступно для приложений Google Chat и надстройки Google Workspace.
Поля | |
---|---|
items[] | Список предложений, используемых для рекомендаций автозаполнения в полях ввода текста. |
Предложение
Одно предложенное значение, которое пользователи могут ввести в поле текстового ввода.
Доступно для приложений Google Chat и надстройки Google Workspace.
Поля | |
---|---|
Полевой | |
text | Значение предлагаемого ввода в поле ввода текста. Это эквивалентно тому, что пользователи вводят себя. |
TextInput
Поле, в которое пользователи могут вводить текст. Поддерживает предложения и действия по изменению. Для примера в приложениях Google Chat см. Добавьте поле, в которое пользователь может ввести текст .
Приложения чата получают и могут обрабатывать значение введенного текста во время событий ввода формы. Для получения подробной информации о работе с входами формы см. Данные формы приема .
Когда вам нужно собирать неопределенные или абстрактные данные от пользователей, используйте текстовый ввод. Для сбора определенных или перечисленных данных от пользователей используйте виджет SelectionInput
.
Доступно для приложений Google Chat и надстройки Google Workspace.
Поля | |
---|---|
name | Имя, с помощью которого текстовый ввод идентифицируется в событии ввода формы. Для получения подробной информации о работе с входами формы см. Данные формы приема . |
label | Текст, который появляется над полем ввода текста в пользовательском интерфейсе. Укажите текст, который помогает пользователю ввести информацию, необходимую вашему приложению. Например, если вы спрашиваете чье -то имя, но особенно нужна их фамилия, напишите Требуется, если |
hintText | Текст, который появляется под полем ввода текста, предназначенным для помощи пользователям, побуждая их ввести определенное значение. Этот текст всегда виден. Требуется, если |
value | Значение, введенное пользователем, возвращенное как часть события ввода формы. Для получения подробной информации о работе с входами формы см. Данные формы приема . |
type | Как ввод текстового ввода появляется в пользовательском интерфейсе. Например, является ли поле одиночным или многострочным. |
onChangeAction | Что делать, когда изменение происходит в поле ввода текста. Например, пользователь, добавляющий в поле или удаляет текст. Примеры действий, которые необходимо предпринять, включают запуск пользовательской функции или открытие диалога в чате Google. |
initialSuggestions | Предлагаемые значения, в которые пользователи могут ввести. Эти значения появляются, когда пользователи нажимают внутри поля ввода текста. Как вводит пользователи, предлагаемые значения динамически фильтровали, чтобы соответствовать тому, что напечатали пользователи. Например, поле ввода текста для языка программирования может предложить Java, JavaScript, Python и C ++. Когда пользователи начинают печатать Предлагаемые значения помогают пользователям вводить значения, которые может понять ваше приложение. При ссылке на JavaScript некоторые пользователи могут ввести Когда указано, Доступно для приложений Google Chat и надстройки Google Workspace. |
autoCompleteAction | Необязательный. Укажите, какое действие предпринять, когда поле Text Inpult предоставляет предложения пользователям, которые взаимодействуют с ним. В случае неопределенности предложения устанавливаются Если указано, приложение принимает указанное здесь действие, например, запуск пользовательской функции. Доступно для Google Workspace Adsons и недоступно для приложений Google Chat. |
validation | Укажите проверку, необходимую для этого поля ввода текста. Доступно для приложений Google Chat и надстройки Google Workspace. |
placeholderText | Текст, который появляется в поле ввода текста, когда поле пустое. Используйте этот текст, чтобы попросить пользователей ввести значение. Например, Доступно для приложений Google Chat и недоступно для надстройки Google Workspace. |
Тип
Как ввод текстового ввода появляется в пользовательском интерфейсе. Например, будь то поле ввода одной линии или многострочный вход. Если указаны initialSuggestions
, type
всегда является SINGLE_LINE
, даже если он установлен на MULTIPLE_LINE
.
Доступно для приложений Google Chat и надстройки Google Workspace.
Перечисление | |
---|---|
SINGLE_LINE | Поле ввода текста имеет фиксированную высоту одной линии. |
MULTIPLE_LINE | Поле ввода текста имеет фиксированную высоту нескольких линий. |
TextParagraph
Абзац текста, который поддерживает форматирование. Для примера в приложениях Google Chat см. Добавьте абзац форматированного текста . Для получения дополнительной информации о форматировании текста см. Форматирование текста в приложениях Google Chat и форматирование текста в надстройках Google Workspace .
Доступно для приложений Google Chat и надстройки Google Workspace.
Поля | |
---|---|
text | Текст, который показан в виджет. |
maxLines | Максимальное количество строк текста, которые отображаются в виджете. Если текст превышает указанное максимальное количество строк, избыточное содержание скрывается за кнопкой Show Better . Если текст одинаково или короче, чем указанное максимальное количество строк, кнопка «Показать больше» не отображается. Значение по умолчанию равно 0, и в этом случае отображается весь контекст. Отрицательные значения игнорируются. Доступно для приложений Google Chat и недоступно для надстройки Google Workspace. |
Валидация
Представляет необходимые данные для проверки виджета, к которому он прикреплен.
Доступно для приложений Google Chat и надстройки Google Workspace.
Поля | |
---|---|
characterLimit | Укажите ограничение символа для виджетов ввода текста. Обратите внимание, что это используется только для ввода текста и игнорируется для других виджетов. Доступно для приложений Google Chat и надстройки Google Workspace. |
inputType | Укажите тип входных виджетов. Доступно для приложений Google Chat и надстройки Google Workspace. |
Inputtype
Тип входного виджета.
Перечисление | |
---|---|
INPUT_TYPE_UNSPECIFIED | Неопределенный тип. Не используйте. |
TEXT | Регулярный текст, который принимает всех символов. |
INTEGER | Целочисленное значение. |
FLOAT | Значение поплавки. |
EMAIL | Адрес электронной почты. |
EMOJI_PICKER | Эмодзи, отобранный из предоставленного системой сборщика смайликов. |
Виджет
Каждая карта состоит из виджетов.
Виджет - это композитный объект, который может представлять один из текста, изображений, кнопок и других типов объектов.
Поля | |
---|---|
horizontalAlignment | Определяет, выровняются ли виджеты влево, справа или центр столбца. |
Объединенные полевые data . Виджет может иметь только один из следующих элементов. Вы можете использовать несколько полей виджетов для отображения большего количества элементов. data могут быть только одним из следующих: | |
textParagraph | Отображает текстовый абзац. Поддерживает простой HTML -форматированный текст. Для получения дополнительной информации о форматировании текста см. Форматирование текста в приложениях Google Chat и форматирование текста в надстройках Google Workspace . Например, следующий JSON создает жирный жирный текст:
|
image | Отображает изображение. Например, следующий JSON создает изображение с альтернативным текстом:
|
decoratedText | Отображает украшенный текстовый элемент. Например, следующий JSON создает украшенный виджет текста, показывающий адрес электронной почты:
|
buttonList | Список кнопок. Например, следующий JSON создает две кнопки. Первый - это синяя текстовая кнопка, а вторая - это кнопка изображения, которая открывает ссылку:
|
textInput | Отображает текстовое поле, в которое пользователи могут ввести. Например, следующий JSON создает текстовый ввод для адреса электронной почты:
В качестве другого примера, следующий JSON создает текстовый ввод для языка программирования со статическими предложениями:
|
selectionInput | Отображает элемент управления выбором, который позволяет пользователям выбирать элементы. Элементы управления выбором могут быть флажками, радионотоками, переключателями или раскрывающимися меню. Например, следующее JSON создает выпадающее меню, которое позволяет пользователям выбирать размер:
|
dateTimePicker | Отображает виджет, который позволяет пользователям вводить дату, время или дату и время. Например, следующий JSON создает сборщик даты, чтобы назначить встречу:
|
divider | Отображает горизонтальную линейную разделитель между виджетами. Например, следующий JSON создает делитель:
|
grid | Отображает сетку с коллекцией предметов. Сетка поддерживает любое количество столбцов и элементов. Количество строк определяется верхними границами числа элементов, деленных на количество столбцов. Сетка с 10 пунктами и 2 столбцами имеет 5 строк. Сетка с 11 элементами и 2 столбцами имеет 6 строк. Доступно для приложений Google Chat и надстройки Google Workspace. Например, следующий JSON создает сетку из 2 столбцов с одним элементом:
|
columns | Отображает до 2 столбцов. Чтобы включить более 2 столбцов или для использования строк, используйте виджет Например, следующий JSON создает по 2 столбца, каждый из которых содержит текстовые абзацы:
|
chipList | Список чипсов. Например, следующий JSON создает две фишки. Первый - это текстовый чип, а второй - это микросхема, который открывает ссылку:
Доступно для приложений Google Chat и недоступно для надстройки Google Workspace. |
Горизонталинг
Определяет, выровняются ли виджеты влево, справа или центр столбца.
Доступно для приложений Google Chat и недоступно для надстройки Google Workspace.
Перечисление | |
---|---|
HORIZONTAL_ALIGNMENT_UNSPECIFIED | Не используйте. Не указано. |
START | Значение по умолчанию. Выравнивает виджеты с начальной позицией столбца. Для макетов слева направо выровняется влево. Для макетов справа налево выровняется справа. |
CENTER | Выравнивает виджеты в центр колонны. |
END | Выравнивает виджеты с конечной позицией столбца. Для макетов слева направо выравнивает виджеты вправо. Для макетов справа налево выравнивает виджеты влево. |
ImageType
Форма, используемая для обрезания изображения.
Доступно для приложений Google Chat и надстройки Google Workspace.
Перечисление | |
---|---|
SQUARE | Значение по умолчанию. Применяет квадратную маску к изображению. Например, изображение 4x3 становится 3x3. |
CIRCLE | Применяет круговую маску к изображению. Например, изображение 4x3 становится кругом с диаметром 3. |