Package google.apps.card.v1

Индекс

• Action (сообщение)
• Action.ActionParameter (сообщение)
• Action.Interaction (перечисление)
• Action.LoadIndicator (перечисление)
• BorderStyle (сообщение)
• BorderStyle.BorderType (перечисление)
• Button (сообщение)
• ButtonList (сообщение)
• Card (сообщение)
• Card.CardAction (сообщение)
• Card.CardFixedFooter (сообщение)
• Card.CardHeader (сообщение)
• Card.DisplayStyle (перечисление)
• Card.DividerStyle (перечисление)
• Card.Section (сообщение)
• 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 (перечисление)
• RenderActions (сообщение)
• RenderActions.Action (сообщение)
• SelectionInput (сообщение)
• SelectionInput.PlatformDataSource (сообщение)
• SelectionInput.PlatformDataSource.CommonDataSource (перечисление)
• SelectionInput.SelectionItem (сообщение)
• SelectionInput.SelectionType (перечисление)
• SubmitFormResponse (сообщение)
• Suggestions (сообщение)
• Suggestions.SuggestionItem (сообщение)
• TextInput (сообщение)
• TextInput.Type (перечисление)
• TextParagraph (сообщение)
• Widget (сообщение)
• Widget.HorizontalAlignment (перечисление)
• Widget.ImageType (перечисление)

Действие

Действие, описывающее поведение при отправке формы. Например, вы можете вызвать сценарий Apps Script для обработки формы. Если действие срабатывает, значения формы отправляются на сервер.

Доступно для приложений Google Chat и дополнений Google Workspace.

Поля
function	string Пользовательская функция, вызываемая при щелчке по содержащему элементу или его активации иным образом. Пример использования см. в разделе Чтение данных формы .
parameters[]	ActionParameter Список параметров действия.
loadIndicator	LoadIndicator Указывает индикатор загрузки, который отображается при вызове действия.
persistValues	bool Указывает, сохраняются ли значения формы после действия. Значение по умолчанию false . Если true , значения формы сохраняются после запуска действия. Чтобы позволить пользователю вносить изменения во время обработки действия, установите для LoadIndicator значение NONE . Для сообщений с карточками в приложениях чата необходимо также установить для ResponseType действия значение UPDATE_MESSAGE и использовать тот же card_id из карточки, которая содержала действие. Если false , значения формы очищаются при запуске действия. Чтобы запретить пользователю вносить изменения во время обработки действия, установите для LoadIndicator значение SPINNER .
interaction	Interaction Необязательный. Требуется при открытии диалога . Что делать в ответ на взаимодействие с пользователем, например, когда пользователь нажимает кнопку в сообщении с карточкой. Если не указано, приложение отвечает, выполняя action , например открытие ссылки или запуск функции, как обычно. Указав interaction , приложение может реагировать особым интерактивным способом. Например, установив для interaction значение OPEN_DIALOG , приложение сможет открыть диалоговое окно . Если указано, индикатор загрузки не отображается. Если указано для надстройки, вся карта удаляется и в клиенте ничего не отображается. Доступно для приложений Google Chat и недоступно для дополнений Google Workspace.

Параметр действия

Список строковых параметров, которые необходимо указать при вызове метода действия. Например, рассмотрим три кнопки повтора: отложить сейчас, отложить один день или отложить на следующей неделе. Вы можете использовать action method = snooze() , передав тип и время повтора в списке строковых параметров.

Дополнительные сведения см. в CommonEventObject .

Доступно для приложений Google Chat и дополнений Google Workspace.

Поля
key	string Имя параметра сценария действия.
value	string Значение параметра.

Взаимодействие

Необязательный. Требуется при открытии диалога .

Что делать в ответ на взаимодействие с пользователем, например, когда пользователь нажимает кнопку в сообщении с карточкой.

Если не указано, приложение отвечает, выполняя 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	BorderType Тип границы.
strokeColor	Color Цвета, которые будут использоваться, если тип BORDER_TYPE_STROKE .
cornerRadius	int32 Угловой радиус границы.

Тип границы

Представляет типы границ, применяемые к виджетам.

Доступно для приложений Google Chat и дополнений Google Workspace.

Перечисления
BORDER_TYPE_UNSPECIFIED	Не используйте. Неопределенные.
NO_BORDER	Значение по умолчанию. Без границ.
STROKE	Контур.

Кнопка

Текст, значок или кнопка с текстом и значком, которую пользователи могут нажать. Пример использования приложений Google Chat см. в разделе « Добавление кнопки» .

Чтобы сделать изображение интерактивной кнопкой, укажите Image (а не ImageComponent ) и установите действие onClick .

Доступно для приложений Google Chat и дополнений Google Workspace.

Поля
text	string Текст, отображаемый внутри кнопки.
icon	Icon Изображение значка. Если установлены и icon , и text , то значок появляется перед текстом.
color	Color Если установлено, кнопка заполняется сплошным цветом фона, а цвет шрифта изменяется, чтобы сохранить контраст с цветом фона. Например, установка синего фона, скорее всего, приведет к появлению белого текста. Если параметр не установлен, фон изображения будет белым, а цвет шрифта — синим. Для красного, зеленого и синего значение каждого поля представляет собой число float , которое можно выразить двумя способами: как число от 0 до 255, разделенное на 255 (153/255), или как значение от 0 до 255. 1 (0,6). 0 представляет отсутствие цвета, а 1 или 255/255 представляет полное присутствие этого цвета по шкале RGB. При необходимости установите alpha , которая задает уровень прозрачности с помощью этого уравнения: pixel color = alpha * (this color) + (1.0 - alpha) * (background color) Для alpha значение 1 соответствует сплошному цвету, а значение 0 соответствует полностью прозрачному цвету. Например, следующий цвет представляет собой полупрозрачный красный: "color": { "red": 1, "green": 0, "blue": 0, "alpha": 0.5 }
onClick	OnClick Необходимый. Действие, которое необходимо выполнить, когда пользователь нажимает кнопку, например открытие гиперссылки или запуск пользовательской функции.
disabled	bool Если true , кнопка отображается в неактивном состоянии и не реагирует на действия пользователя.
altText	string Альтернативный текст, используемый для специальных возможностей. Установите описательный текст, который позволит пользователям узнать, что делает кнопка. Например, если кнопка открывает гиперссылку, вы можете написать: «Открывает новую вкладку браузера и переходит к документации для разработчиков Google Chat по адресу https://developers.google.com/workspace/chat» .

Список кнопок

Список кнопок, расположенных горизонтально. Пример использования приложений Google Chat см. в разделе « Добавление кнопки» .

Доступно для приложений Google Chat и дополнений Google Workspace.

Поля
buttons[]	Button Массив кнопок.

Карта

Интерфейс карты, отображаемый в сообщении 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": "[e-mail]"
                 }
               },
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "PERSON"
                   },
                   "text": "<font color=\"#80e27e\">Online</font>"
                 }
               },
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "PHONE"
                   },
                   "text": "[phone]"
                 }
               },
               {
                 "buttonList": {
                   "buttons": [
                     {
                       "text": "Share",
                       "onClick": {
                        "openLink": {
                           "url": "https://example.com/share"
                         }
                       }
                     },
                     {
                       "text": "Edit",
                       "onClick": {
                         "action": {
                           "function": "goToView",
                           "parameters": [
                             {
                               "key": "viewType",
                               "value": "EDIT"
                             }
                           ]
                         }
                       }
                     }
                   ]
                 }
               }
             ]
           }
         ]
       }
    }
  ]
}

Поля
header	CardHeader Заголовок карты. Заголовок обычно содержит ведущее изображение и заголовок. Заголовки всегда отображаются вверху карточки.
sections[]	Section Содержит коллекцию виджетов. Каждый раздел имеет свой собственный необязательный заголовок. Разделы визуально разделены разделителем. Пример использования приложений Google Chat см. в разделе «Определение раздела карточки» .
sectionDividerStyle	DividerStyle Стиль разделителя между разделами.
cardActions[]	CardAction Действия карты. Действия добавляются в меню панели инструментов карточки. Доступно для дополнений Google Workspace и недоступно для приложений Google Chat. Например, следующий JSON создает меню действий карты с параметрами Settings и Send Feedback : "cardActions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ]
name	string Название карты. Используется в качестве идентификатора карты при карточной навигации. Доступно для дополнений Google Workspace и недоступно для приложений Google Chat.
fixedFooter	CardFixedFooter Фиксированный нижний колонтитул, показанный внизу этой карточки. Установка fixedFooter без указания primaryButton или secondaryButton вызывает ошибку. В приложениях чата вы можете использовать фиксированные нижние колонтитулы в диалогах , но не в сообщениях-карточках . Доступно для приложений Google Chat и дополнений Google Workspace.
displayStyle	DisplayStyle В надстройках Google Workspace задает свойства отображения peekCardHeader . Доступно для дополнений Google Workspace и недоступно для приложений Google Chat.
peekCardHeader	CardHeader При отображении контекстного контента заголовок карточки просмотра действует как заполнитель, позволяя пользователю перемещаться между карточками главной страницы и контекстными карточками. Доступно для дополнений Google Workspace и недоступно для приложений Google Chat.

КартаДействие

Действие карты — это действие, связанное с картой. Например, карточка счета-фактуры может включать в себя такие действия, как удаление счета, отправка счета по электронной почте или открытие счета в браузере.

Доступно для дополнений Google Workspace и недоступно для приложений Google Chat.

Поля
actionLabel	string Метка, которая отображается как элемент меню действий.
onClick	OnClick Действие onClick для этого элемента действия.

КартаFixedFooter

Постоянный (прикрепленный) нижний колонтитул, который появляется внизу карточки.

Установка fixedFooter без указания primaryButton или secondaryButton вызывает ошибку.

В приложениях чата вы можете использовать фиксированные нижние колонтитулы в диалогах , но не в сообщениях-карточках . Пример использования приложений Google Chat см. в разделе Добавление постоянного нижнего колонтитула .

Доступно для приложений Google Chat и дополнений Google Workspace.

Поля
primaryButton	Button Основная кнопка фиксированного нижнего колонтитула. Кнопка должна быть текстовой с заданным текстом и цветом.
secondaryButton	Button Вторичная кнопка фиксированного нижнего колонтитула. Кнопка должна быть текстовой с заданным текстом и цветом. Если установлен secondaryButton , вы также должны установить primaryButton .

Заголовок карты

Представляет заголовок карты. Пример использования приложений Google Chat см. в разделе Добавление заголовка .

Доступно для приложений Google Chat и дополнений Google Workspace.

Поля
title	string Необходимый. Название шапки карты. Заголовок имеет фиксированную высоту: если указаны и заголовок, и подзаголовок, каждый занимает одну строку. Если указан только заголовок, он занимает обе строки.
subtitle	string Подзаголовок шапки карты. Если указано, отображается на отдельной строке под title .
imageType	ImageType Форма, используемая для обрезки изображения. Доступно для приложений Google Chat и дополнений Google Workspace.
imageUrl	string URL-адрес HTTPS изображения в заголовке карты.
imageAltText	string Альтернативный текст этого изображения, используемый для специальных возможностей.

Стиль отображения

В надстройках 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	string Текст, который отображается вверху раздела. Поддерживает простой текст в формате HTML. Дополнительную информацию о форматировании текста см. в разделах «Форматирование текста в приложениях Google Chat» и «Форматирование текста в надстройках Google Workspace» .
widgets[]	Widget Все виджеты в разделе. Должен содержать хотя бы один виджет.
collapsible	bool Указывает, является ли этот раздел сворачиваемым. Сворачиваемые разделы скрывают некоторые или все виджеты, но пользователи могут развернуть раздел, чтобы отобразить скрытые виджеты, нажав «Показать больше» . Пользователи могут снова скрыть виджеты, нажав «Показать меньше» . Чтобы определить, какие виджеты скрыты, укажите uncollapsibleWidgetsCount .
uncollapsibleWidgetsCount	int32 Количество несворачиваемых виджетов, которые остаются видимыми, даже если раздел свернут. Например, если раздел содержит пять виджетов и для uncollapsibleWidgetsCount установлено значение 2 , первые два виджета всегда отображаются, а последние три сворачиваются по умолчанию. uncollapsibleWidgetsCount учитывается только в том случае, если collapsible равно true .

Столбцы

Виджет Columns отображает до двух столбцов на карточке или в диалоговом окне. Вы можете добавлять виджеты в каждый столбец; виджеты отображаются в том порядке, в котором они указаны. Пример использования приложений Google Chat см. в разделе Отображение карточек и диалоговых окон в столбцах .

Высота каждого столбца определяется более высоким столбцом. Например, если первый столбец выше второго, оба столбца будут иметь высоту первого столбца. Поскольку каждый столбец может содержать разное количество виджетов, вы не можете определять строки или выравнивать виджеты между столбцами.

Столбцы отображаются рядом. Вы можете настроить ширину каждого столбца, используя поле HorizontalSizeStyle . Если ширина экрана пользователя слишком узкая, второй столбец переносится ниже первого:

• В Интернете второй столбец переносится, если ширина экрана меньше или равна 480 пикселям.
• На устройствах iOS второй столбец переносится, если ширина экрана меньше или равна 300 pt.
• На устройствах Android второй столбец переносится, если ширина экрана меньше или равна 320 dp.

Чтобы включить более двух столбцов или использовать строки, используйте виджет Grid .

Доступно для приложений Google Chat и дополнений Google Workspace. Столбцы для дополнений Google Workspace доступны в предварительной версии для разработчиков.

Поля
columnItems[]	Column Массив столбцов. Вы можете включить до двух столбцов в карточку или диалог.

Столбец

Колонка.

Доступно для приложений Google Chat и дополнений Google Workspace. Столбцы для дополнений Google Workspace доступны в предварительной версии для разработчиков.

Поля
horizontalSizeStyle	HorizontalSizeStyle Указывает, как столбец заполняет ширину карточки.
horizontalAlignment	HorizontalAlignment Указывает, выравниваются ли виджеты по левому, правому или центру столбца.
verticalAlignment	VerticalAlignment Указывает, выравниваются ли виджеты по верху, низу или центру столбца.
widgets[]	Widgets Массив виджетов, включенных в столбец. Виджеты отображаются в том порядке, в котором они указаны.

Горизонтальныйразмерстиль

Указывает, как столбец заполняет ширину карточки. Ширина каждого столбца зависит как от HorizontalSizeStyle , так и от ширины виджетов внутри столбца.

Доступно для приложений Google Chat и дополнений Google Workspace. Столбцы для дополнений Google Workspace доступны в предварительной версии для разработчиков.

Перечисления
HORIZONTAL_SIZE_STYLE_UNSPECIFIED	Не используйте. Неопределенные.
FILL_AVAILABLE_SPACE	Значение по умолчанию. Столбец заполняет доступное пространство до 70 % ширины карты. Если для обоих столбцов установлено значение FILL_AVAILABLE_SPACE , каждый столбец заполняет 50 % пространства.
FILL_MINIMUM_SPACE	Столбец занимает минимально возможное пространство и не более 30 % ширины карты.

Вертикальное выравнивание

Указывает, выравниваются ли виджеты по верху, низу или центру столбца.

Доступно для приложений Google Chat и дополнений Google Workspace. Столбцы для дополнений Google Workspace доступны в предварительной версии для разработчиков.

Перечисления
VERTICAL_ALIGNMENT_UNSPECIFIED	Не используйте. Неопределенные.
CENTER	Значение по умолчанию. Выравнивает виджеты по центру столбца.
TOP	Выравнивает виджеты по верху столбца.
BOTTOM	Выравнивает виджеты по нижней части столбца.

Виджеты

Поддерживаемые виджеты, которые можно включить в столбец.

Доступно для приложений Google Chat и дополнений Google Workspace. Столбцы для дополнений Google Workspace доступны в предварительной версии для разработчиков.

Поля
data поля объединения. data могут быть только одним из следующих:
textParagraph	TextParagraph Виджет TextParagraph .
image	Image Виджет Image .
decoratedText	DecoratedText Виджет DecoratedText .
buttonList	ButtonList Виджет ButtonList .
textInput	TextInput Виджет TextInput .
selectionInput	SelectionInput Виджет SelectionInput .
dateTimePicker	DateTimePicker Виджет DateTimePicker .

DateTimePicker

Позволяет пользователям вводить дату, время или дату и время одновременно. Пример использования приложений Google Chat см. в разделе Разрешить пользователю выбирать дату и время .

Пользователи могут вводить текст или использовать средство выбора для выбора даты и времени. Если пользователи вводят неверную дату или время, средство выбора отображает ошибку, которая предлагает пользователям ввести информацию правильно.

Доступно для приложений Google Chat и дополнений Google Workspace.

Поля
name	string Имя, по которому DateTimePicker идентифицируется в событии ввода формы. Подробные сведения о работе с входными данными формы см. в разделе Получение данных формы .
label	string Текст, предлагающий пользователям ввести дату, время или дату и время. Например, если пользователи планируют встречу, используйте метку, например Appointment date или Appointment date and time .
type	DateTimePickerType Поддерживает ли виджет ввод даты, времени или даты и времени.
valueMsEpoch	int64 Значение по умолчанию, отображаемое в виджете, в миллисекундах с момента эпохи Unix . Укажите значение в зависимости от типа средства выбора ( DateTimePickerType ): DATE_AND_TIME : календарная дата и время в формате UTC. Например, чтобы представить 1 января 2023 года в 12:00 по всемирному координированному времени, используйте 1672574400000 . DATE_ONLY : календарная дата в 00:00:00 UTC. Например, чтобы представить 1 января 2023 года, используйте 1672531200000 . TIME_ONLY : время в формате UTC. Например, чтобы представить 12:00, используйте 43200000 (или 12 * 60 * 60 * 1000 ).
timezoneOffsetDate	int32 Число, представляющее смещение часового пояса от UTC в минутах. Если установлено, value_ms_epoch отображается в указанном часовом поясе. Если этот параметр не установлен, значение по умолчанию соответствует настройке часового пояса пользователя.
onChangeAction	Action Срабатывает, когда пользователь нажимает кнопку «Сохранить» или «Очистить» в интерфейсе DateTimePicker .

DateTimePickerType

Формат даты и времени в виджете DateTimePicker . Определяет, могут ли пользователи вводить дату, время или дату и время одновременно.

Доступно для приложений Google Chat и дополнений Google Workspace.

Перечисления
DATE_AND_TIME	Пользователи вводят дату и время.
DATE_ONLY	Пользователи вводят дату.
TIME_ONLY	Пользователи вводят время.

УкрашенныйТекст

Виджет, отображающий текст с дополнительными украшениями, такими как метка над или под текстом, значок перед текстом, виджет выбора или кнопка после текста. Пример использования приложений Google Chat см. в разделе Отображение текста с декоративным текстом .

Доступно для приложений Google Chat и дополнений Google Workspace.

Поля
icon (deprecated)	Icon Этот товар устарел! Устарело в пользу startIcon .
startIcon	Icon Значок отображается перед текстом.
topLabel	string Текст, который появляется над text . Всегда обрезает.
text	string Необходимый. Первичный текст. Поддерживает простое форматирование. Дополнительную информацию о форматировании текста см. в разделах «Форматирование текста в приложениях Google Chat» и «Форматирование текста в надстройках Google Workspace» .
wrapText	bool Настройка переноса текста. Если true , текст переносится и отображается в нескольких строках. В противном случае текст обрезается. Применяется только к text , а не topLabel и bottomLabel .
bottomLabel	string Текст, который отображается под text . Всегда заворачивается.
onClick	OnClick Это действие запускается, когда пользователи нажимают topLabel или bottomLabel .
Полевой control Союза. Кнопка, переключатель, флажок или изображение, которое отображается справа от текста в виджете decoratedText . control может быть только одним из следующих:
button	Button Кнопка, которую пользователь может нажать, чтобы вызвать действие.
switchControl	SwitchControl Виджет переключения, по которому пользователь может щелкнуть, чтобы изменить его состояние и вызвать действие.
endIcon	Icon Значок, отображаемый после текста. Поддерживает встроенные и пользовательские значки.

SwitchControl

Либо переключатель в стиле тумблера, либо флажок внутри виджета decoratedText .

Доступно для приложений Google Chat и дополнений Google Workspace.

Поддерживается только в виджете decoratedText .

Поля
name	string Имя, по которому виджет переключения идентифицируется в событии ввода формы. Подробные сведения о работе с входными данными формы см. в разделе Получение данных формы .
value	string Значение, введенное пользователем и возвращаемое как часть события ввода формы. Подробные сведения о работе с входными данными формы см. в разделе Получение данных формы .
selected	bool Если true , переключатель выбран.
onChangeAction	Action Действие, которое необходимо выполнить при изменении состояния переключателя, например, какую функцию запускать.
controlType	ControlType Как переключатель отображается в пользовательском интерфейсе. Доступно для приложений Google Chat и дополнений Google Workspace.

Тип управления

Как переключатель отображается в пользовательском интерфейсе.

Доступно для приложений Google Chat и дополнений Google Workspace.

Перечисления
SWITCH	Тумблерный переключатель.
CHECKBOX	Устарело в пользу CHECK_BOX .
CHECK_BOX	Флажок.

Разделитель

Этот тип не имеет полей.

Отображает разделитель между виджетами в виде горизонтальной линии. Пример использования приложений Google Chat см. в разделе «Добавление горизонтального разделителя между виджетами» .

Доступно для приложений Google Chat и дополнений Google Workspace.

Например, следующий JSON создает разделитель:

"divider": {}

КонецНавигации

Действие потока диалога.

Доступно для приложений Google Chat и недоступно для дополнений Google Workspace.

Поля
action	Action Действие рендеринга для клиента, завершающее поток диалога. Доступно для приложений Google Chat и недоступно для дополнений Google Workspace.

Действие

Типы действий рендеринга, позволяющие клиенту завершить поток диалога.

Доступно для приложений Google Chat и недоступно для дополнений Google Workspace.

Перечисления
ACTION_UNSPECIFIED	Действие не указано.
CLOSE_DIALOG	Закройте поток диалога.
CLOSE_DIALOG_AND_EXECUTE	Закройте поток диалога и обновите карточку, открывшую поток диалога.

Получитьавтодополнениеответ

Ответ на получение контейнера автозаполнения, который включает элементы, необходимые для отображения элементов автозаполнения для текстового поля.

Доступно для дополнений Google Workspace и недоступно для приложений Google Chat. Например:

{
  "autoComplete": {
    "items": [
      {
        "text": "C++"
      },
      {
        "text": "Java"
      },
      {
        "text": "JavaScript"
      },
      {
        "text": "Python"
      }
    ]
  }
}

Поля
autoComplete	Suggestions
schema	string Это неиспользуемое поле схемы, которое может присутствовать в разметке для проверки синтаксиса.

Сетка

Отображает сетку с коллекцией элементов. Элементы могут включать только текст или изображения. Для адаптивных столбцов или для включения большего количества текста или изображений используйте Columns . Пример использования приложений Google Chat см. в разделе Отображение сетки с коллекцией элементов .

Сетка поддерживает любое количество столбцов и элементов. Количество строк определяется элементами, разделенными столбцами. Сетка с 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	string Текст, который отображается в заголовке сетки.
items[]	GridItem Элементы, отображаемые в сетке.
borderStyle	BorderStyle Стиль границы, применяемый к каждому элементу сетки.
columnCount	int32 Количество столбцов, отображаемых в сетке. Значение по умолчанию используется, если это поле не указано, и это значение по умолчанию различается в зависимости от того, где отображается сетка (диалоговое окно или сопутствующий текст).
onClick	OnClick Этот обратный вызов повторно используется каждым отдельным элементом сетки, но к параметрам обратного вызова добавляется идентификатор и индекс элемента в списке элементов.

Гридитем

Представляет элемент в макете сетки. Элементы могут содержать текст, изображение или и текст, и изображение.

Доступно для приложений Google Chat и дополнений Google Workspace.

Поля
id	string Заданный пользователем идентификатор для этого элемента сетки. Этот идентификатор возвращается в параметрах обратного вызова onClick родительской сетки.
image	ImageComponent Изображение, которое отображается в элементе сетки.
title	string Название элемента сетки.
subtitle	string Подзаголовок элемента сетки.
layout	GridItemLayout Макет, используемый для элемента сетки.

GridItemLayout

Представляет различные параметры макета, доступные для элемента сетки.

Доступно для приложений Google Chat и дополнений Google Workspace.

Перечисления
GRID_ITEM_LAYOUT_UNSPECIFIED	Не используйте. Неопределенные.
TEXT_BELOW	Заголовок и подзаголовок отображаются под изображением элемента сетки.
TEXT_ABOVE	Заголовок и подзаголовок отображаются над изображением элемента сетки.

Икона

Значок, отображаемый в виджете на карточке. Пример использования приложений Google Chat см. в разделе Добавление значка .

Поддерживает встроенные и пользовательские значки.

Доступно для приложений Google Chat и дополнений Google Workspace.

Поля
altText	string Необязательный. Описание значка, используемого для специальных возможностей. Если не указано, предоставляется значение Button по умолчанию. Рекомендуется установить полезное описание того, что отображает значок, и, если применимо, что он делает. Например, A user's account portrait или Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat . Если значок установлен в Button , altText отображается как вспомогательный текст, когда пользователь наводит курсор на кнопку. Однако если кнопка также устанавливает text , altText значка игнорируется.
imageType	ImageType К изображению применен стиль обрезки. В некоторых случаях применение обрезки CIRCLE приводит к тому, что изображение становится больше встроенного значка.
icons полей Союза. Значок, отображаемый в виджете на карте. icons могут быть только одним из следующих:
knownIcon	string Отобразите один из встроенных значков Google Workspace. Например, чтобы отобразить значок самолета, укажите AIRPLANE . Для автобуса укажите BUS . Полный список поддерживаемых значков см. в разделе «Встроенные значки» .
iconUrl	string Отображение пользовательского значка, размещенного по URL-адресу HTTPS. Например: "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" Поддерживаемые типы файлов: .png и .jpg .
materialIcon	MaterialIcon Отобразите один из значков материалов Google . Например, чтобы отобразить значок флажка , используйте "materialIcon": { "name": "check_box" } Доступно для приложений Google Chat и недоступно для дополнений Google Workspace.

Изображение

Изображение, заданное URL-адресом и может иметь действие onClick . Пример см. в разделе «Добавление изображения» .

Доступно для приложений Google Chat и дополнений Google Workspace.

Поля
imageUrl	string URL-адрес HTTPS, на котором размещено изображение. Например: https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png
onClick	OnClick Когда пользователь щелкает изображение, щелчок запускает это действие.
altText	string Альтернативный текст этого изображения, используемый для специальных возможностей.

Компонент изображения

Представляет изображение.

Доступно для приложений Google Chat и дополнений Google Workspace.

Поля
imageUri	string URL-адрес изображения.
altText	string Метка доступности изображения.
cropStyle	ImageCropStyle Стиль обрезки, применяемый к изображению.
borderStyle	BorderStyle Стиль границы, применяемый к изображению.

СтильОбрезки Изображения

Представляет стиль обрезки, примененный к изображению.

Доступно для приложений Google Chat и дополнений Google Workspace.

Например, вот как применить соотношение сторон 16:9:

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 16/9
}

Поля
type	ImageCropType Тип урожая.
aspectRatio	double Соотношение сторон, которое будет использоваться, если тип кадрирования — RECTANGLE_CUSTOM . Например, вот как применить соотношение сторон 16:9: cropStyle { "type": "RECTANGLE_CUSTOM", "aspectRatio": 16/9 }

ТипОбрезки Изображения

Представляет стиль обрезки, примененный к изображению.

Доступно для приложений Google Chat и дополнений Google Workspace.

Перечисления
IMAGE_CROP_TYPE_UNSPECIFIED	Не используйте. Неопределенные.
SQUARE	Значение по умолчанию. Применяет квадратную обрезку.
CIRCLE	Применяет круговую обрезку.
RECTANGLE_CUSTOM	Применяет прямоугольную обрезку с настраиваемым соотношением сторон. Установите пользовательское соотношение сторон с aspectRatio .
RECTANGLE_4_3	Применяет прямоугольную обрезку с соотношением сторон 4:3.

Связь

Объект ссылки для стороннего ресурса, который возвращается в надстройку. Дополнительные сведения см. в разделе Создание сторонних ресурсов из меню @ .

Доступно для дополнений Google Workspace и недоступно для приложений Google Chat.

Поля
url	string URL ссылки для возврата в дополнение.
title	string Название ссылки для возврата в дополнение.

СсылкаПредварительный просмотр

Действие карты, которое позволяет предварительно просмотреть стороннюю ссылку, отображая карту и смарт-чип. Дополнительные сведения см. в разделе Предварительный просмотр ссылок со смарт-чипами .

Доступно для дополнений Google Workspace и недоступно для приложений 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	Card Карточка, отображающая информацию о ссылке со стороннего сервиса.
title	string Заголовок, который отображается на смарт-чипе для предварительного просмотра ссылки. Если значение не установлено, смарт-чип отображает заголовок preview_card .
linkPreviewTitle	string Заголовок, который отображается при предварительном просмотре ссылки. Если этот параметр не установлен, при предварительном просмотре ссылки отображается заголовок preview_card .

МатериалИконка

Значок Google Material , включающий более 2500+ вариантов.

Например, чтобы отобразить значок флажка с настроенным весом и оценкой, напишите следующее:

{
  "name": "check_box",
  "fill": true,
  "weight": 300,
  "grade": -25
}

Доступно для приложений Google Chat и недоступно для дополнений Google Workspace.

Поля
name	string Имя значка, определенное в Google Material Icon , например, check_box . Любые недопустимые имена удаляются и заменяются пустой строкой, в результате чего значок не отображается.
fill	bool Будет ли значок отображаться заполненным. Значение по умолчанию — ложь. Чтобы просмотреть различные настройки значков, перейдите в раздел «Значки шрифтов Google» и настройте параметры в разделе «Настройка» .
weight	int32 Толщина штриха значка. Выберите {100, 200, 300, 400, 500, 600, 700}. Если оно отсутствует, значение по умолчанию — 400. Если указано любое другое значение, используется значение по умолчанию. Чтобы просмотреть различные настройки значков, перейдите в раздел «Значки шрифтов Google» и настройте параметры в разделе «Настроить» .
grade	int32 Вес и класс влияют на толщину символа. Корректировки класса являются более детальными, чем корректировки веса, и оказывают небольшое влияние на размер символа. Выберите {-25, 0, 200}. Если оно отсутствует, значение по умолчанию равно 0. Если указано любое другое значение, используется значение по умолчанию. Чтобы просмотреть различные настройки значков, перейдите в раздел «Значки шрифтов Google» и настройте параметры в разделе «Настроить» .

Навигация

Действие карты, управляющее стопкой карт.

Доступно для дополнений Google Workspace и недоступно для приложений Google Chat.

Например:

1) Добавьте в стопку новую карту (перейдите вперед).

 navigations : {
    pushCard : CARD
  }

2) Обновить карту поверх стека (обновить по месту).

  navigations : {
    popCard : true,
  }, {
    pushCard : CARD
  }

3) Вернитесь на один шаг назад без обновления.

  navigations : {
    popCard : true,
  }

4) Вернитесь на несколько шагов назад и обновите эту карту.

  navigations : {
    popCard : true,
  }, ... {
    pushCard : CARD
  }

5) Вернитесь на несколько шагов назад к определенному CARD_NAME .

  navigations : {
    popToCardName : CARD_NAME,
  }, {
    pushCard : CARD
  }

6) Вернитесь в корень и обновите эту карту.

  navigations : {
    popToRoot : true
  }, {
    pushCard : CARD
  }

7) Перейдите к указанной карте и вставьте и ее.

navigations : { popToCardName : CARD_NAME }, { popCard : true, }

8) Замените верхнюю карту новой картой.

  navigations : {
    updateCard : CARD
  }

Поля
Поле объединения navigate_action . navigate_action может быть только одним из следующих:
popToRoot	bool Из стопки карт вынимаются все карты, кроме корневой.
pop	bool Стопка карт выталкивает одну карту.
popToCard	string Стек карт извлекает все карты выше указанной карты с заданным именем карты.
pushCard	Card Стек карт помещает карту в стопку карт.
updateCard	Card Стек карточек обновляет верхнюю карточку новой карточкой и сохраняет значения заполненных полей формы. Для неэквивалентного поля значение удаляется.
endNavigation	EndNavigation Поток диалога завершает действие навигации. Дополнительные сведения см. в разделе «Ответ на диалоговое окно для сообщений домашней карточки приложения». Доступно для приложений Google Chat и недоступно для дополнений Google Workspace.

Уведомление

Действие карты, которое отображает уведомление в главном приложении.

Доступно для дополнений Google Workspace и недоступно для приложений Google Chat.

Поля
text	string Обычный текст для отображения уведомления без HTML-тегов.

По щелчку

Представляет, как реагировать, когда пользователи нажимают интерактивный элемент на карточке, например кнопку.

Доступно для приложений Google Chat и дополнений Google Workspace.

Поля
data поля объединения. data могут быть только одним из следующих:
action	Action Если указано, действие запускается этим onClick .
openLink	OpenLink Если указано, этот onClick запускает действие открытия ссылки.
openDynamicLinkAction	Action Надстройка запускает это действие, когда действию необходимо открыть ссылку. Это отличается от приведенного выше open_link тем, что для получения ссылки необходимо обратиться к серверу. Таким образом, веб-клиенту необходимо выполнить некоторую подготовительную работу, прежде чем вернется ответ на действие по открытию ссылки. Доступно для дополнений Google Workspace и недоступно для приложений Google Chat.
card	Card Новая карта помещается в стопку карточек после щелчка, если это указано. Доступно для дополнений Google Workspace и недоступно для приложений Google Chat.

Открыть ссылку

Представляет событие onClick , открывающее гиперссылку.

Доступно для приложений Google Chat и дополнений Google Workspace.

Поля
url	string URL-адрес для открытия.
openAs	OpenAs Как открыть ссылку. Доступно для дополнений Google Workspace и недоступно для приложений Google Chat.
onClose	OnClose Забывает ли клиент о ссылке после ее открытия или наблюдает за ней до закрытия окна. Доступно для дополнений Google Workspace и недоступно для приложений Google Chat.

При Закрытии

Что делает клиент, когда ссылка, открытая действием OnClick закрывается.

Реализация зависит от возможностей клиентской платформы. Например, веб-браузер может открыть ссылку во всплывающем окне с обработчиком OnClose .

Если установлены оба обработчика OnOpen и OnClose , а клиентская платформа не может поддерживать оба значения, OnClose имеет приоритет.

Доступно для дополнений Google Workspace и недоступно для приложений Google Chat.

Перечисления
NOTHING	Значение по умолчанию. Карта не перезагружается; Ничего не произошло.
RELOAD	Перезагружает карту после закрытия дочернего окна. При использовании в сочетании с OpenAs.OVERLAY дочернее окно действует как модальное диалоговое окно, а родительская карточка блокируется до тех пор, пока дочернее окно не закроется.

ОпенАс

Когда действие OnClick открывает ссылку, клиент может открыть ее либо как полноразмерное окно (если это фрейм, используемый клиентом), либо как наложение (например, всплывающее окно). Реализация зависит от возможностей клиентской платформы, и выбранное значение может быть проигнорировано, если клиент его не поддерживает. FULL_SIZE поддерживается всеми клиентами.

Доступно для дополнений Google Workspace и недоступно для приложений Google Chat.

Перечисления
FULL_SIZE	Ссылка открывается в полноразмерном окне (если клиент использует именно этот фрейм).
OVERLAY	Ссылка открывается в виде наложения, например всплывающего окна.

Действия рендеринга

Набор инструкций по рендерингу, который сообщает карте для выполнения действия или сообщает приложению Add-Host или приложению Chat для выполнения специфического приложения действий.

Доступно для приложений Google Chat и надстройки Google Workspace.

Поля
action	Action
hostAppAction	HostAppActionMarkup Действия, выполняемые отдельными приложениями хоста.
schema	string Это поле схемы NO-OP, которое может присутствовать в наценке для проверки синтаксиса.

Действие

Поля
navigations[]	Navigation Нажмите, всплывают или обновляют отображаемые карты.
link	OpenLink Немедленно откройте целевую ссылку на новой вкладке или всплывающее окно.
notification	Notification Отобразить уведомление для конечного пользователя.
linkPreview	LinkPreview Отобразить предварительный просмотр ссылки на конечного пользователя.
links[]	Link Ссылка для стороннего ресурса, созданного из приложения Google Workspace. Отформатируется как массив объектов с одним элементом. Для получения дополнительной информации см. Создание сторонних ресурсов из меню @ .

ВыборВвод

Виджет, который создает один или несколько элементов пользовательского интерфейса, которые могут выбрать пользователи. Например, выпадающее меню или флажки. Вы можете использовать этот виджет для сбора данных, которые могут быть предсказаны или перечислены. Для примера в приложениях Google Chat см. «Добавить выбранные элементы пользовательского интерфейса» .

Приложения чата могут обрабатывать значение элементов, которые пользователи выбирают или вводятся. Для получения подробной информации о работе с входами формы см. Данные формы приема .

Чтобы собрать неопределенные или абстрактные данные от пользователей, используйте виджет TextInput .

Доступно для приложений Google Chat и надстройки Google Workspace.

Поля
name	string Имя, которое идентифицирует ввод выбора в событии ввода формы. Для получения подробной информации о работе с входами формы см. Данные формы приема .
label	string Текст, который появляется над полем ввода выбора в пользовательском интерфейсе. Укажите текст, который помогает пользователю ввести информацию, необходимую вашему приложению. Например, если пользователи выбирают срочность рабочего билета из раскрывающегося меню, этикетка может быть «срочно» или «выберите срочность».
type	SelectionType Тип элементов, которые отображаются пользователям в виджете SelectionInput . Типы выбора поддерживают различные типы взаимодействий. Например, пользователи могут выбрать один или несколько флажков, но они могут выбрать только одно значение в раскрывающемся меню.
items[]	SelectionItem Массив выбранных элементов. Например, массив радиопроизводств или флажок. Поддерживает до 100 предметов.
onChangeAction	Action Если указано, форма отправляется при изменении выбора. Если не указано, вы должны указать отдельную кнопку, которая подчиняет форму. Для получения подробной информации о работе с входами формы см. Данные формы приема .
multiSelectMaxSelectedItems	int32 Для MultiSelect Menus максимальное количество элементов, которые пользователь может выбрать. Минимальное значение - 1 элемент. Если не указано, по умолчанию 3 пункта.
multiSelectMinQueryLength	int32 Для MultiSelect Menus количество текстовых символов, которые пользователь вводит перед приложением, запрашивает автозаполнение и отображает предлагаемые элементы в меню. Если не указано, по умолчанию до 0 символов для статических источников данных и 3 символов для внешних источников данных.
Поле Союза multi_select_data_source . Для многосекционного меню источник данных, который населяет элементы выбора. Доступно для приложений Google Chat и недоступно для надстройки Google Workspace. multi_select_data_source может быть только одним из следующих:
externalDataSource	Action Внешний источник данных, такой как реляционная база данных.
platformDataSource	PlatformDataSource Источник данных из Google Workspace.

ПлатформаИсточник данных

Для виджета SelectionInput , в котором используется многоселекное меню, источник данных из Google Workspace. Используется для заполнения предметов в многосекционном меню.

Доступно для приложений Google Chat и недоступно для надстройки Google Workspace.

Поля
Поле Союза data_source . Источник данных. data_source может быть только одним из следующих:
commonDataSource	CommonDataSource Источник данных, разделяемый всеми приложениями Google Workspace, таких как пользователи в организации Google Workspace.
hostAppDataSource	HostAppDataSourceMarkup Источник данных, уникальный для приложения Google Workspace Host, таких пространств в Google Chat.

Общий источник данных

Источник данных, разделяемый всеми приложениями Google Workspace .

Доступно для приложений Google Chat и недоступно для надстройки Google Workspace.

Перечисления
UNKNOWN	Значение по умолчанию. Не используйте.
USER	Пользователи Google Workspace. Пользователь может просматривать и выбирать пользователей только из своей организации Google Workspace.

SelectionItem

Элемент, который пользователи могут выбрать во входе выбора, например, флажок или коммутатор.

Доступно для приложений Google Chat и надстройки Google Workspace.

Поля
text	string Текст, который идентифицирует или описывает элемент для пользователей.
value	string Значение, связанное с этим элементом. Клиент должен использовать это в качестве входного значения формы. Для получения подробной информации о работе с входами формы см. Данные формы приема .
selected	bool Будет ли элемент выбран по умолчанию. Если ввод выбора принимает только одно значение (например, для радиопроизводительных кнопок или раскрывающегося меню), установите это поле только для одного элемента.
startIconUri	string Для MultiSelect Menus URL -адрес для значка, отображаемого рядом с text полем элемента. Поддерживает файлы PNG и JPEG. Должен быть HTTPS URL. Например, https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png .
bottomText	string Для MultiSelect Menus текстовое описание или этикетку, отображаемое ниже text поля элемента.

Тип выбора

Формат для элементов, которые пользователи могут выбрать. Различные параметры поддерживают различные типы взаимодействий. Например, пользователи могут выбрать несколько флажков, но могут выбрать только один элемент из раскрывающегося меню.

Каждый ввод выбора поддерживает один тип выбора. Например, смешивание флажок и коммутаторов не поддерживается.

Доступно для приложений Google Chat и надстройки Google Workspace.

Перечисления
CHECK_BOX	Набор флажок. Пользователи могут выбрать один или несколько флажков.
RADIO_BUTTON	Набор радиокнопок. Пользователи могут выбрать одну радиопроизводительную кнопку.
SWITCH	Набор переключателей. Пользователи могут включать один или несколько коммутаторов.
DROPDOWN	Выпадающее меню. Пользователи могут выбрать один элемент из меню.
MULTI_SELECT	Многосекционное меню для статических или динамических данных. В строке меню пользователи выбирают один или несколько элементов. Пользователи также могут вводить значения для заполнения динамических данных. Например, пользователи могут начать набирать имя пространства чата Google, а виджет автоматически использует пространство. Чтобы заполнить элементы для многосекционного меню, вы можете использовать один из следующих типов источников данных: Статические данные: элементы указаны как объекты SelectionItem в виджете. До 100 предметов. Данные Google Workspace: элементы заполняются с использованием данных из Google Workspace, таких как пользователи Google Workspace или Google Chat Spaces. Внешние данные: элементы заполняются из внешнего источника данных за пределами Google Workspace. Примеры того, как реализовать MultiSelect Menus, см. Добавьте меню MultiSelect . Доступно для приложений Google Chat и надстройки Google Workspace. MultiSelect для Google Workspace надстройки находятся в предварительном просмотре разработчика.

Отправить формулируйте

Ответ на отправку формы, кроме получения контейнера для автозаполнения, который содержит действия, которые должна выполнять карту, и/или приложение для хоста, и изменилось ли состояние карты.

Доступно для Google Workspace Adsons и недоступно для приложений Google Chat. Например:

{
  "renderActions": {
    "action": {
      "notification": {
        "text": "Email address is added: [e-mail]"
      }
    },
    "hostAppAction": {
      "gmailAction": {
        "openCreatedDraftAction": {
          "draftId": "msg-a:r-79766936926021702",
          "threadServerPermId": "thread-f:15700999851086004"
        }
      }
    }
  }
}

Поля
renderActions	RenderActions Набор инструкций по рендерингу, который сообщает карте выполнить действие и/или сообщает приложению Add-Host для выполнения специфического приложения действие.
stateChanged	bool Изменилось ли состояние карт, и данные в существующих картах устареют.
schema	string Это поле схемы 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[]	SuggestionItem Список предложений, используемых для рекомендаций автозаполнения в полях ввода текста.

Предложение

Одно предложенное значение, которое пользователи могут ввести в поле текстового ввода.

Доступно для приложений Google Chat и надстройки Google Workspace.

Поля
Полевой content союза. content может быть только одним из следующих:
text	string Значение предлагаемого ввода в поле ввода текста. Это эквивалентно тому, что пользователи вводят себя.

Ввод текста

Поле, в которое пользователи могут вводить текст. Поддерживает предложения и действия по изменению. Для примера в приложениях Google Chat см. Добавьте поле, в которое пользователь может ввести текст .

Приложения чата получают и могут обрабатывать значение введенного текста во время событий ввода формы. Для получения подробной информации о работе с входами формы см. Данные формы приема .

Когда вам нужно собирать неопределенные или абстрактные данные от пользователей, используйте текстовый ввод. Для сбора определенных или перечисленных данных от пользователей используйте виджет SelectionInput .

Доступно для приложений Google Chat и надстройки Google Workspace.

Поля
name	string Имя, с помощью которого текстовый ввод идентифицируется в событии ввода формы. Для получения подробной информации о работе с входами формы см. Данные формы приема .
label	string Текст, который появляется над полем ввода текста в пользовательском интерфейсе. Укажите текст, который помогает пользователю ввести информацию, необходимую вашему приложению. Например, если вы спрашиваете чье -то имя, но особенно нужна их фамилия, напишите surname вместо name . Требуется, если hintText не определен. В противном случае, необязательно.
hintText	string Текст, который появляется под полем ввода текста, предназначенным для помощи пользователям, побуждая их ввести определенное значение. Этот текст всегда виден. Требуется, если label не определен. В противном случае, необязательно.
value	string Значение, введенное пользователем, возвращенное как часть события ввода формы. Для получения подробной информации о работе с входами формы см. Данные формы приема .
type	Type Как ввод текстового ввода появляется в пользовательском интерфейсе. Например, является ли поле одиночным или многострочным.
onChangeAction	Action Что делать, когда изменение происходит в поле ввода текста. Например, пользователь, добавляющий в поле или удаляет текст. Примеры действий, которые необходимо предпринять, включают запуск пользовательской функции или открытие диалога в чате Google.
initialSuggestions	Suggestions Предлагаемые значения, в которые пользователи могут ввести. Эти значения появляются, когда пользователи нажимают внутри поля ввода текста. Как вводит пользователи, предлагаемые значения динамически фильтровали, чтобы соответствовать тому, что напечатали пользователи. Например, поле ввода текста для языка программирования может предложить Java, JavaScript, Python и C ++. Когда пользователи начинают печатать Jav , список предложений фильтровал, чтобы показать Java и JavaScript . Предлагаемые значения помогают пользователям вводить значения, которые может понять ваше приложение. При ссылке на JavaScript некоторые пользователи могут ввести javascript , а другие java script . Предложение JavaScript может стандартизировать, как пользователи взаимодействуют с вашим приложением. Когда указано, TextInput.type всегда SINGLE_LINE , даже если он устанавливается на MULTIPLE_LINE . Доступно для приложений Google Chat и надстройки Google Workspace.
autoCompleteAction	Action Необязательный. Укажите, какое действие предпринять, когда поле Text Inpult предоставляет предложения пользователям, которые взаимодействуют с ним. В случае неопределенности предложения устанавливаются initialSuggestions и обрабатываются клиентом. Если указано, приложение принимает указанное здесь действие, например, запуск пользовательской функции. Доступно для Google Workspace Adsons и недоступно для приложений Google Chat.
placeholderText	string Текст, который появляется в поле ввода текста, когда поле пустое. Используйте этот текст, чтобы попросить пользователей ввести значение. Например, Enter a number from 0 to 100 . Доступно для приложений Google Chat и недоступно для надстройки Google Workspace.

Тип

Как ввод текстового ввода появляется в пользовательском интерфейсе. Например, будь то поле ввода одной линии или многострочный вход. Если указаны initialSuggestions , type всегда является SINGLE_LINE , даже если он установлен на MULTIPLE_LINE .

Доступно для приложений Google Chat и надстройки Google Workspace.

Перечисления
SINGLE_LINE	Поле ввода текста имеет фиксированную высоту одной линии.
MULTIPLE_LINE	Поле ввода текста имеет фиксированную высоту нескольких линий.

Текстовый абзац

Абзац текста, который поддерживает форматирование. Для примера в приложениях Google Chat см. Добавьте абзац форматированного текста . Для получения дополнительной информации о форматировании текста см. Форматирование текста в приложениях Google Chat и форматирование текста в надстройках Google Workspace .

Доступно для приложений Google Chat и надстройки Google Workspace.

Поля
text	string Текст, который показан в виджет.

Виджет

Каждая карта состоит из виджетов.

Виджет - это композитный объект, который может представлять один из текста, изображений, кнопок и других типов объектов.

Поля
horizontalAlignment	HorizontalAlignment Определяет, выровняются ли виджеты влево, справа или центр столбца.
Объединенные полевые data . Виджет может иметь только один из следующих элементов. Вы можете использовать несколько полей виджетов для отображения большего количества элементов. data могут быть только одним из следующих:
textParagraph	TextParagraph Отображает текстовый абзац. Поддерживает простой HTML -форматированный текст. Для получения дополнительной информации о форматировании текста см. Форматирование текста в приложениях Google Chat и форматирование текста в надстройках Google Workspace . Например, следующий JSON создает жирный жирный текст: "textParagraph": { "text": " <b>bold text</b>" }
image	Image Отображает изображение. Например, следующий JSON создает изображение с альтернативным текстом: "image": { "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "altText": "Chat app avatar" }
decoratedText	DecoratedText Отображает украшенный текстовый элемент. Например, следующий JSON создает украшенный виджет текста, показывающий адрес электронной почты: "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "[e-mail]", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } }
buttonList	ButtonList Список кнопок. Например, следующий JSON создает две кнопки. Первый - это синяя текстовая кнопка, а вторая - это кнопка изображения, которая открывает ссылку: "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, "alpha": 1 }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] }
textInput	TextInput Отображает текстовое поле, в которое пользователи могут ввести. Например, следующий JSON создает текстовый ввод для адреса электронной почты: "textInput": { "name": "mailing_address", "label": "Mailing Address" } В качестве другого примера, следующий JSON создает текстовый ввод для языка программирования со статическими предложениями: "textInput": { "name": "preferred_programing_language", "label": "Preferred Language", "initialSuggestions": { "items": [ { "text": "C++" }, { "text": "Java" }, { "text": "JavaScript" }, { "text": "Python" } ] } }
selectionInput	SelectionInput Отображает элемент управления выбором, который позволяет пользователям выбирать элементы. Элементы управления выбором могут быть флажками, радионотоками, переключателями или раскрывающимися меню. Например, следующее JSON создает выпадающее меню, которое позволяет пользователям выбирать размер: "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] }
dateTimePicker	DateTimePicker Отображает виджет, который позволяет пользователям вводить дату, время или дату и время. Например, следующий JSON создает сборщик даты, чтобы назначить встречу: "dateTimePicker": { "name": "appointment_time", "label": "Book your appointment at:", "type": "DATE_AND_TIME", "valueMsEpoch": "796435200000" }
divider	Divider Отображает горизонтальную линейную разделитель между виджетами. Например, следующий JSON создает делитель: "divider": { }
grid	Grid Отображает сетку с коллекцией предметов. Сетка поддерживает любое количество столбцов и элементов. Количество строк определяется верхними границами числа элементов, деленных на количество столбцов. Сетка с 10 пунктами и 2 столбцами имеет 5 строк. Сетка с 11 элементами и 2 столбцами имеет 6 строк. Доступно для приложений Google Chat и надстройки Google Workspace. Например, следующий JSON создает сетку из 2 столбцов с одним элементом: "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" } } }
columns	Columns Отображает до 2 столбцов. Чтобы включить более 2 столбцов или для использования строк, используйте виджет Grid . Например, следующий JSON создает по 2 столбца, каждый из которых содержит текстовые абзацы: "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] }

Горизонтальное выравнивание

Определяет, выровняются ли виджеты влево, справа или центр столбца.

Доступно для приложений Google Chat и недоступно для надстройки Google Workspace.

Перечисления
HORIZONTAL_ALIGNMENT_UNSPECIFIED	Не используйте. Неопределенные.
START	Значение по умолчанию. Выравнивает виджеты с начальной позицией столбца. Для макетов слева направо выровняется влево. Для макетов справа налево выровняется справа.
CENTER	Выравнивает виджеты в центр колонны.
END	Выравнивает виджеты с конечной позицией столбца. Для макетов слева направо выравнивает виджеты вправо. Для макетов справа налево выравнивает виджеты влево.

Тип изображения

Форма, используемая для обрезания изображения.

Доступно для приложений Google Chat и надстройки Google Workspace.

Перечисления
SQUARE	Значение по умолчанию. Применяет квадратную маску к изображению. Например, изображение 4x3 становится 3x3.
CIRCLE	Применяет круговую маску к изображению. Например, изображение 4x3 становится кругом с диаметром 3.