Package google.apps.card.v1

string

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

Пример использования см. в разделе Чтение данных формы .

ActionParameter

Список параметров действия.

LoadIndicator

Указывает индикатор загрузки, который отображается при вызове действия.

bool

Указывает, сохраняются ли значения формы после действия. Значение по умолчанию — false .

Если true , значения формы сохраняются после запуска действия. Чтобы позволить пользователю вносить изменения во время обработки действия, установите для LoadIndicator значение NONE . Для сообщений с карточками в приложениях чата необходимо также установить для ResponseType действия значение UPDATE_MESSAGE и использовать тот же card_id из карточки, которая содержала действие.

Если false , значения формы очищаются при запуске действия. Чтобы запретить пользователю вносить изменения во время обработки действия, установите для LoadIndicator SPINNER .

Interaction

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

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

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

Указав interaction , приложение может реагировать особым интерактивным способом. Например, установив для interaction значение OPEN_DIALOG , приложение сможет открыть диалоговое окно . Если указано, индикатор загрузки не отображается. Если указано для надстройки, вся карта удаляется и в клиенте ничего не отображается.

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

string

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

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

bool

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

string

Имя параметра сценария действия.

string

Значение параметра.

BorderType

Тип границы.

Color

Цвета, которые будут использоваться, если тип BORDER_TYPE_STROKE .

Чтобы задать цвет обводки, укажите значение для полей red , green и blue . Значение должно быть числом с плавающей запятой от 0 до 1, основанным на значении цвета RGB, где 0 (0/255) представляет отсутствие цвета, а 1 (255/255) представляет максимальную интенсивность цвета.

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

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
}

Поле alpha недоступно для цвета обводки. Если указано, это поле игнорируется.

int32

Угловой радиус границы.

string

Текст, отображаемый внутри кнопки.

Icon

Значок, отображаемый внутри кнопки. Если установлены и icon , и text , то значок появляется перед текстом.

Color

Необязательный. Цвет кнопки. Если этот параметр установлен, type кнопки устанавливается как FILLED , а цвет text и полей icon задается контрастным цветом для удобства чтения. Например, если цвет кнопки установлен синий, любой текст или значки на кнопке станут белыми.

Чтобы задать цвет кнопки, укажите значение для полей red , green и blue . Значение должно быть числом с плавающей запятой от 0 до 1, основанным на значении цвета RGB, где 0 (0/255) представляет отсутствие цвета, а 1 (255/255) представляет максимальную интенсивность цвета.

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

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
}

Поле alpha недоступно для цвета кнопки. Если указано, это поле игнорируется.

OnClick

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

bool

Если true , кнопка отображается в неактивном состоянии и не реагирует на действия пользователя.

string

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

Установите описательный текст, который позволит пользователям узнать, что делает кнопка. Например, если кнопка открывает гиперссылку, вы можете написать: «Открывает новую вкладку браузера и переходит к документации для разработчиков Google Chat по адресу https://developers.google.com/workspace/chat» .

Type

Необязательный. Тип кнопки. Если этот параметр не установлен, тип кнопки по умолчанию — OUTLINED . Если поле color установлено, тип кнопки принудительно устанавливается как FILLED , и любое значение, установленное для этого поля, игнорируется.

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

Button

Массив кнопок.

CardHeader

Заголовок карты. Заголовок обычно содержит ведущее изображение и заголовок. Заголовки всегда отображаются вверху карточки.

Section

Содержит коллекцию виджетов. Каждый раздел имеет свой собственный необязательный заголовок. Разделы визуально разделены разделителем. Пример использования приложений Google Chat см. в разделе «Определение раздела карточки» .

DividerStyle

Стиль разделителя между заголовком, разделами и подвалом.

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"
      }
    }
  }
]

string

Название карты. Используется в качестве идентификатора карты при карточной навигации.

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

CardFixedFooter

Фиксированный нижний колонтитул, показанный внизу этой карточки.

Установка fixedFooter без указания primaryButton или secondaryButton вызывает ошибку. В приложениях чата вы можете использовать фиксированные нижние колонтитулы в диалогах , но не в сообщениях-карточках .

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

DisplayStyle

В надстройках Google Workspace задает свойства отображения peekCardHeader .

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

CardHeader

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

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

string

Метка, которая отображается как элемент меню действий.

OnClick

Действие onClick для этого элемента действия.

Button

Основная кнопка фиксированного нижнего колонтитула. Кнопка должна быть текстовой с заданным текстом и цветом.

Button

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

string

Необходимый. Название шапки карты. Заголовок имеет фиксированную высоту: если указаны и заголовок, и подзаголовок, каждый занимает одну строку. Если указан только заголовок, он занимает обе строки.

string

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

ImageType

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

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

string

URL-адрес HTTPS изображения в заголовке карточки.

string

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

string

Текст, который отображается вверху раздела. Поддерживает простой текст в формате HTML. Дополнительную информацию о форматировании текста см. в разделах «Форматирование текста в приложениях Google Chat» и «Форматирование текста в надстройках Google Workspace» .

Widget

Все виджеты в разделе. Должен содержать хотя бы один виджет.

bool

Указывает, является ли этот раздел сворачиваемым.

Сворачиваемые разделы скрывают некоторые или все виджеты, но пользователи могут развернуть раздел, чтобы отобразить скрытые виджеты, нажав «Показать больше» . Пользователи могут снова скрыть виджеты, нажав «Показать меньше» .

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

int32

Количество несворачиваемых виджетов, которые остаются видимыми, даже если раздел свернут.

Например, если раздел содержит пять виджетов и uncollapsibleWidgetsCount установлено значение 2 , первые два виджета всегда отображаются, а последние три сворачиваются по умолчанию. uncollapsibleWidgetsCount учитывается только в том случае, если collapsible равно true .

CollapseControl

Необязательный. Определите кнопку развертывания и свертывания раздела. Эта кнопка будет отображаться только в том случае, если раздел сворачивается. Если это поле не задано, используется кнопка по умолчанию. Доступно для приложений Google Chat и недоступно для дополнений Google Workspace.

Icon

Изображение значка. Если установлены и icon , и text , то значок появляется перед текстом.

string

Текст, отображаемый внутри чипа.

OnClick

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

bool

Находится ли чип в активном состоянии и реагирует ли на действия пользователя. По умолчанию true . Устарело. Вместо этого используйте disabled .

bool

Находится ли чип в неактивном состоянии и игнорирует действия пользователя. По умолчанию установлено значение false .

string

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

Установите описательный текст, который позволит пользователям узнать, что делает чип. Например, если чип открывает гиперссылку, напишите: «Открывает новую вкладку браузера и переходит к документации для разработчиков Google Chat по адресу https://developers.google.com/workspace/chat» .

Layout

Указанный макет списка микросхем.

Chip

Массив фишек.

HorizontalAlignment

Горизонтальное выравнивание кнопки развернуть и свернуть.

Button

Необязательный. Определите настраиваемую кнопку, чтобы развернуть раздел. Поле «expandButton» и «CrollButton» должно быть установлено. Только один набор полей не вступит в силу. Если это поле не задано, используется кнопка по умолчанию.

Button

Необязательный. Определите настраиваемую кнопку, чтобы свернуть раздел. Поле «expandButton» и «CrollButton» должно быть установлено. Только один набор полей не вступит в силу. Если это поле не задано, используется кнопка по умолчанию.

Column

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

HorizontalSizeStyle

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

HorizontalAlignment

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

VerticalAlignment

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

Widgets

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

TextParagraph

Виджет TextParagraph .

Image

Виджет Image .

DecoratedText

Виджет DecoratedText .

ButtonList

Виджет ButtonList .

TextInput

Виджет TextInput .

SelectionInput

Виджет SelectionInput .

DateTimePicker

Виджет DateTimePicker .

ChipList

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

string

Имя, по которому DateTimePicker идентифицируется в событии ввода формы.

Подробные сведения о работе с входными данными формы см. в разделе Получение данных формы .

string

Текст, предлагающий пользователям ввести дату, время или дату и время. Например, если пользователи планируют встречу, используйте метку, например Appointment date или Appointment date and time .

DateTimePickerType

Поддерживает ли виджет ввод даты, времени или даты и времени.

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 ).

int32

Число, представляющее смещение часового пояса от UTC в минутах. Если установлено, value_ms_epoch отображается в указанном часовом поясе. Если этот параметр не установлен, значение по умолчанию соответствует настройке часового пояса пользователя.

Action

Срабатывает, когда пользователь нажимает кнопку «Сохранить» или «Очистить» в интерфейсе DateTimePicker .

Validation

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

Icon

Устарело в пользу startIcon .

Icon

Значок отображается перед текстом.

string

Текст, который появляется над text . Всегда обрезает.

string

Необходимый. Первичный текст.

Поддерживает простое форматирование. Дополнительную информацию о форматировании текста см. в разделах «Форматирование текста в приложениях Google Chat» и «Форматирование текста в надстройках Google Workspace» .

bool

Настройка переноса текста. Если true , текст переносится и отображается в нескольких строках. В противном случае текст обрезается.

Применяется только к text , а не к topLabel и bottomLabel .

string

Текст, который отображается под text . Всегда заворачивается.

OnClick

Это действие запускается, когда пользователи нажимают topLabel или bottomLabel .

Button

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

SwitchControl

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

Icon

Значок, отображаемый после текста.

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

string

Имя, по которому виджет переключения идентифицируется в событии ввода формы.

Подробные сведения о работе с входными данными формы см. в разделе Получение данных формы .

string

Значение, введенное пользователем и возвращаемое как часть события ввода формы.

Подробные сведения о работе с входными данными формы см. в разделе Получение данных формы .

bool

Если true , переключатель выбран.

Action

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

ControlType

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

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

Action

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

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

Suggestions

string

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

string

Текст, который отображается в заголовке сетки.

GridItem

Элементы, отображаемые в сетке.

BorderStyle

Стиль границы, применяемый к каждому элементу сетки.

int32

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

OnClick

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

string

Заданный пользователем идентификатор для этого элемента сетки. Этот идентификатор возвращается в параметрах обратного вызова onClick родительской сетки.

ImageComponent

Изображение, которое отображается в элементе сетки.

string

Название элемента сетки.

string

Подзаголовок элемента сетки.

GridItemLayout

Макет, используемый для элемента сетки.

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

К изображению применен стиль обрезки. В некоторых случаях применение обрезки CIRCLE приводит к тому, что изображение становится больше встроенного значка.

string

Отобразите один из встроенных значков Google Workspace.

Например, чтобы отобразить значок самолета, укажите AIRPLANE . Для автобуса укажите BUS .

Полный список поддерживаемых значков см. в разделе «Встроенные значки» .

string

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

Например:

"iconUrl":
"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png"

Поддерживаемые типы файлов: .png и .jpg .

MaterialIcon

Отобразите один из значков материалов Google .

Например, чтобы отобразить значок флажка , используйте

"materialIcon": {
  "name": "check_box"
}

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

string

URL-адрес HTTPS, на котором размещено изображение.

Например:

https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png

OnClick

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

string

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

string

URL-адрес изображения.

string

Метка доступности изображения.

ImageCropStyle

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

BorderStyle

Стиль границы, применяемый к изображению.

ImageCropType

Тип урожая.

double

Соотношение сторон, которое будет использоваться, если тип кадрирования — RECTANGLE_CUSTOM .

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

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

string

URL ссылки, чтобы вернуться в дополнение.

string

Название ссылки, чтобы вернуться в дополнение.

Card

Карта, которая отображает информацию о ссылке из сторонней службы.

string

Заголовок, который отображается в Smart Chip для предварительного просмотра ссылки. Если нет, Smart Chip отображает заголовок preview_card .

string

Заголовок, который отображается в предварительном просмотре ссылки. Если USET, предварительный просмотр ссылки отображает заголовок preview_card .

string

Имя значка, определенное в значке материала Google , например, check_box . Любые неверные имена заброшены и заменены пустой строкой и приводят к тому, что значок не смог рендерина.

bool

Будь то иконка заполненной. Значение по умолчанию неверно.

Чтобы предварительно просмотреть различные настройки значка, перейдите на значки шрифта Google и настройте настройки настройки .

int32

Вес инсульта иконы. Выберите из {100, 200, 300, 400, 500, 600, 700}. Если отсутствует, значение по умолчанию составляет 400. Если указано какое -либо другое значение, используется значение по умолчанию.

Чтобы предварительно просмотреть различные настройки значка, перейдите на значки шрифта Google и настройте настройки настройки .

int32

Вес и оценка влияют на толщину символа. Корректировки к оценке более детализируют, чем корректировки веса, и оказывают небольшое влияние на размер символа. Выберите из {-25, 0, 200}. Если отсутствие, значение по умолчанию равно 0. Если указано какое -либо другое значение, используется значение по умолчанию.

Чтобы предварительно просмотреть различные настройки значка, перейдите на значки шрифта Google и настройте настройки настройки .

bool

Стек карт вытаскивает все карты, кроме корневой карты.

bool

Стек карт выпадает на одну карту.

string

Стек карт всплывает все карты над указанной картой с данным именем карты.

Card

Стек карт нажимает карту в стек карт.

Card

Стек карт обновляет верхнюю карту с новой картой и сохраняет значения полей заполненной формы. Для неквалентного поля значение сброшено.

EndNavigation

Действие диалога конечного навигационного действия. Для получения дополнительной информации см. Настройте домашнюю страницу для приложения Google Chat

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

string

Простой текст для отображения для уведомления, без тегов HTML.

Action

Если указано, действие запускается этим onClick .

OpenLink

Если указано, этот onClick запускает действие с открытой ссылкой.

Action

Дополнительное действие запускает это действие, когда действие должно открыть ссылку. Это отличается от open_link выше, так как это должно поговорить с сервером, чтобы получить ссылку. Таким образом, для веб -клиента требуется некоторая подготовительная работа, прежде чем возвращается ответ на действие открытой ссылки.

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

Card

Новая карта перемещается в стек карт после нажатия, если указано.

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

OverflowMenu

Если указано, этот onClick открывает меню переполнения. Доступно для приложений Google Chat и недоступно для надстройки Google Workspace.

string

URL открыть.

OpenAs

Как открыть ссылку.

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

OnClose

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

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

OverflowMenuItem

Необходимый. Список вариантов меню.

Icon

Значок отображается перед текстом.

string

Необходимый. Текст, который идентифицирует или описывает элемент для пользователей.

OnClick

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

bool

Отключен ли параметр меню. По умолчанию ложно.

Action

HostAppActionMarkup

Действия, выполняемые отдельными приложениями хоста.

string

Это поле схемы NO-OP, которое может присутствовать в наценке для проверки синтаксиса.

Navigation

Нажмите, всплывают или обновляют отображаемые карты.

OpenLink

Немедленно откройте целевую ссылку на новой вкладке или всплывающее окно.

Notification

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

LinkPreview

Отобразить предварительный просмотр ссылки на конечного пользователя.

Link

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

string

Необходимый. Имя, которое идентифицирует ввод выбора в событии ввода формы.

Для получения подробной информации о работе с входами формы см. Данные формы приема .

string

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

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

SelectionType

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

SelectionItem

Массив выбранных элементов. Например, массив радиопроизводств или флажок. Поддерживает до 100 предметов.

Action

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

Для получения подробной информации о работе с входами формы см. Данные формы приема .

int32

Для MultiSelect Menus максимальное количество элементов, которые пользователь может выбрать. Минимальное значение - 1 элемент. Если не указано, по умолчанию 3 пункта.

int32

Для MultiSelect Menus количество текстовых символов, которые пользователь вводит перед приложением, запрашивает автозаполнение и отображает предлагаемые элементы в меню.

Если не указано, по умолчанию до 0 символов для статических источников данных и 3 символов для внешних источников данных.

Validation

Для выпадающих меню проверку для этого поля ввода выбора.

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

Action

Внешний источник данных, такой как реляционная база данных.

PlatformDataSource

Источник данных из Google Workspace.

CommonDataSource

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

HostAppDataSourceMarkup

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

Это поле поддерживает клиентские библиотеки Google API, но не доступно в библиотеках Cloud Client. Чтобы узнать больше, см. Установите клиентские библиотеки .

string

Текст, который идентифицирует или описывает элемент для пользователей.

string

Значение, связанное с этим элементом. Клиент должен использовать это в качестве входного значения формы.

Для получения подробной информации о работе с входами формы см. Данные формы приема .

bool

Будет ли элемент выбран по умолчанию. Если ввод выбора принимает только одно значение (например, для радиопроизводительных кнопок или раскрывающегося меню), установите это поле только для одного элемента.

string

Для MultiSelect Menus URL -адрес для значка, отображаемого рядом с text полем элемента. Поддерживает файлы PNG и JPEG. Должен быть HTTPS URL. Например, https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png .

string

Для MultiSelect Menus текстовое описание или этикетку, отображаемое ниже text поля элемента.

RenderActions

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

bool

Изменилось ли состояние карт, и данные в существующих картах устареют.

string

Это поле схемы NO-OP, которое может присутствовать в наценке для проверки синтаксиса.

SuggestionItem

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

string

Значение предлагаемого ввода в поле ввода текста. Это эквивалентно тому, что пользователи вводят себя.

string

Имя, с помощью которого текстовый ввод идентифицируется в событии ввода формы.

Для получения подробной информации о работе с входами формы см. Данные формы приема .

string

Текст, который появляется над полем ввода текста в пользовательском интерфейсе.

Укажите текст, который помогает пользователю ввести информацию, необходимую вашему приложению. Например, если вы спрашиваете чье -то имя, но особенно нужна их фамилия, напишите surname вместо name .

Требуется, если hintText не определен. В противном случае, необязательно.

string

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

Требуется, если label не определен. В противном случае, необязательно.

string

Значение, введенное пользователем, возвращенное как часть события ввода формы.

Для получения подробной информации о работе с входами формы см. Данные формы приема .

Type

Как ввод текстового ввода появляется в пользовательском интерфейсе. Например, является ли поле одиночным или многострочным.

Action

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

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

Suggestions

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

Например, поле ввода текста для языка программирования может предложить Java, JavaScript, Python и C ++. Когда пользователи начинают печатать Jav , список предложений фильтровал, чтобы показать Java и JavaScript .

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

Когда указано, TextInput.type всегда SINGLE_LINE , даже если он устанавливается на MULTIPLE_LINE .

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

Action

Необязательный. Укажите, какое действие предпринять, когда поле Text Inpult предоставляет предложения пользователям, которые взаимодействуют с ним.

В случае неопределенности предложения устанавливаются initialSuggestions и обрабатываются клиентом.

Если указано, приложение принимает указанное здесь действие, например, запуск пользовательской функции.

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

Validation

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

string

Текст, который появляется в поле ввода текста, когда поле пустое. Используйте этот текст, чтобы попросить пользователей ввести значение. Например, Enter a number from 0 to 100 .

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

string

Текст, который показан в виджет.

int32

Максимальное количество строк текста, которые отображаются в виджете. Если текст превышает указанное максимальное количество строк, избыточное содержание скрывается за кнопкой Show Better . Если текст одинаково или короче, чем указанное максимальное количество строк, кнопка «Показать больше» не отображается.

Значение по умолчанию равно 0, и в этом случае отображается весь контекст. Отрицательные значения игнорируются. Доступно для приложений Google Chat и недоступно для надстройки Google Workspace.

int32

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

InputType

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

HorizontalAlignment

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

TextParagraph

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

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

"textParagraph": {
  "text": "  <b>bold text</b>"
}

Image

Отображает изображение.

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

"image": {
  "imageUrl":
  "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
  "altText": "Chat app avatar"
}

DecoratedText

Отображает украшенный текстовый элемент.

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

"decoratedText": {
  "icon": {
    "knownIcon": "EMAIL"
  },
  "topLabel": "Email Address",
  "text": "sasha@example.com",
  "bottomLabel": "This is a new Email address!",
  "switchControl": {
    "name": "has_send_welcome_email_to_sasha",
    "selected": false,
    "controlType": "CHECKBOX"
  }
}

ButtonList

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

Например, следующий JSON создает две кнопки. Первый - это синяя текстовая кнопка, а вторая - это кнопка изображения, которая открывает ссылку:

"buttonList": {
  "buttons": [
    {
      "text": "Edit",
      "color": {
        "red": 0,
        "green": 0,
        "blue": 1,
      },
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}

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

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

Например, следующее 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

Отображает виджет, который позволяет пользователям вводить дату, время или дату и время.

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

"dateTimePicker": {
  "name": "appointment_time",
  "label": "Book your appointment at:",
  "type": "DATE_AND_TIME",
  "valueMsEpoch": "796435200000"
}

Divider

Отображает горизонтальную линейную разделитель между виджетами.

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

"divider": {
}

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

Отображает до 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"
          }
        }
      ]
    }
  ]
}

ChipList

Список чипсов.

Например, следующий JSON создает две фишки. Первый - это текстовый чип, а второй - это микросхема, который открывает ссылку:

"chipList": {
  "chips": [
    {
      "text": "Edit",
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}

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

string

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

Например, использование, см. Данные чтения формы .

ActionParameter

Список параметров действия.

LoadIndicator

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

bool

Указывает, сохраняются ли значения формы после действия. Значение по умолчанию false .

Если true , значения формы остаются после того, как действие запускается. Чтобы позволить пользователю вносить изменения, когда действие обрабатывается, установите на LoadIndicator NONE Для сообщений карт в приложениях чата вы также должны установить ResponseType Actiontype на UPDATE_MESSAGE и использовать ту же card_id с ​​карты, в которой содержалось действие.

Если false , значения формы очищаются, когда действие запускается. Чтобы пользователь не вносит изменения при обработке действия, установите LoadIndicator на SPINNER .

Interaction

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

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

В случае неопределенности приложение отвечает, выполняя action - похоже, открывая ссылку или запустив функцию - как нормально.

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

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

string

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

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

bool

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

string

Имя параметра для сценария действия.

string

Значение параметра.

BorderType

The border type.

Color

The colors to use when the type is BORDER_TYPE_STROKE .

To set the stroke color, specify a value for the red , green , and blue fields. The value must be a float number between 0 and 1 based on the RGB color value, where 0 (0/255) represents the absence of color and 1 (255/255) represents the maximum intensity of the color.

For example, the following sets the color to red at its maximum intensity:

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
}

The alpha field is unavailable for stroke color. If specified, this field is ignored.

int32

The corner radius for the border.

string

The text displayed inside the button.

Icon

An icon displayed inside the button. If both icon and text are set, then the icon appears before the text.

Color

Необязательный. The color of the button. If set, the button type is set to FILLED and the color of text and icon fields are set to a contrasting color for readability. For example, if the button color is set to blue, any text or icons in the button are set to white.

To set the button color, specify a value for the red , green , and blue fields. The value must be a float number between 0 and 1 based on the RGB color value, where 0 (0/255) represents the absence of color and 1 (255/255) represents the maximum intensity of the color.

For example, the following sets the color to red at its maximum intensity:

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
}

The alpha field is unavailable for button color. If specified, this field is ignored.

OnClick

Необходимый. The action to perform when a user clicks the button, such as opening a hyperlink or running a custom function.

bool

If true , the button is displayed in an inactive state and doesn't respond to user actions.

string

The alternative text that's used for accessibility.

Set descriptive text that lets users know what the button does. For example, if a button opens a hyperlink, you might write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat" .

Type

Необязательный. The type of a button. If unset, button type defaults to OUTLINED . If the color field is set, the button type is forced to FILLED and any value set for this field is ignored.

Available for Google Chat apps and unavailable for Google Workspace Add-ons.

Button

An array of buttons.

CardHeader

The header of the card. A header usually contains a leading image and a title. Headers always appear at the top of a card.

Section

Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see Define a section of a card .

DividerStyle

The divider style between the header, sections and footer.

CardAction

The card's actions. Actions are added to the card's toolbar menu.

Available for Google Workspace Add-ons and unavailable for Google Chat apps.

For example, the following JSON constructs a card action menu with Settings and Send Feedback options:

"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"
      }
    }
  }
]

string

Name of the card. Used as a card identifier in card navigation.

Available for Google Workspace Add-ons and unavailable for Google Chat apps.

CardFixedFooter

The fixed footer shown at the bottom of this card.

Setting fixedFooter without specifying a primaryButton or a secondaryButton causes an error. For Chat apps, you can use fixed footers in dialogs , but not card messages .

Available for Google Chat apps and Google Workspace Add-ons.

DisplayStyle

In Google Workspace Add-ons, sets the display properties of the peekCardHeader .

Available for Google Workspace Add-ons and unavailable for Google Chat apps.

CardHeader

When displaying contextual content, the peek card header acts as a placeholder so that the user can navigate forward between the homepage cards and the contextual cards.

Available for Google Workspace Add-ons and unavailable for Google Chat apps.

string

The label that displays as the action menu item.

OnClick

The onClick action for this action item.

Button

The primary button of the fixed footer. The button must be a text button with text and color set.

Button

The secondary button of the fixed footer. The button must be a text button with text and color set. If secondaryButton is set, you must also set primaryButton .

string

Необходимый. The title of the card header. The header has a fixed height: if both a title and subtitle are specified, each takes up one line. If only the title is specified, it takes up both lines.

string

The subtitle of the card header. If specified, appears on its own line below the title .

ImageType

The shape used to crop the image.

Available for Google Chat apps and Google Workspace Add-ons.

string

The HTTPS URL of the image in the card header.

string

The alternative text of this image that's used for accessibility.

string

Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons .

Widget

All the widgets in the section. Must contain at least one widget.

bool

Indicates whether this section is collapsible.

Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking Show more . Users can hide the widgets again by clicking Show less .

To determine which widgets are hidden, specify uncollapsibleWidgetsCount .

int32

The number of uncollapsible widgets which remain visible even when a section is collapsed.

For example, when a section contains five widgets and the uncollapsibleWidgetsCount is set to 2 , the first two widgets are always shown and the last three are collapsed by default. The uncollapsibleWidgetsCount is taken into account only when collapsible is true .

CollapseControl

Необязательный. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used. Available for Google Chat apps and unavailable for Google Workspace Add-ons.

Icon

The icon image. If both icon and text are set, then the icon appears before the text.

string

The text displayed inside the chip.

OnClick

Необязательный. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function.

bool

Whether the chip is in an active state and responds to user actions. Defaults to true . Deprecated. Use disabled instead.

bool

Whether the chip is in an inactive state and ignores user actions. Defaults to false .

string

The alternative text that's used for accessibility.

Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat" .

Layout

Specified chip list layout.

Chip

An array of chips.

HorizontalAlignment

The horizontal alignment of the expand and collapse button.

Button

Необязательный. Define a customizable button to expand the section. Both expandButton and collapseButton field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used.

Button

Необязательный. Define a customizable button to collapse the section. Both expandButton and collapseButton field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used.

Column

An array of columns. You can include up to 2 columns in a card or dialog.

HorizontalSizeStyle

Specifies how a column fills the width of the card.

HorizontalAlignment

Specifies whether widgets align to the left, right, or center of a column.

VerticalAlignment

Specifies whether widgets align to the top, bottom, or center of a column.

Widgets

An array of widgets included in a column. Widgets appear in the order that they are specified.

TextParagraph

TextParagraph widget.

Image

Image widget.

DecoratedText

DecoratedText widget.

ButtonList

ButtonList widget.

TextInput

TextInput widget.

SelectionInput

SelectionInput widget.

DateTimePicker

DateTimePicker widget.

ChipList

ChipList widget. Available for Google Chat apps and unavailable for Google Workspace Add-ons.

string

The name by which the DateTimePicker is identified in a form input event.

For details about working with form inputs, see Receive form data .

string

The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as Appointment date or Appointment date and time .

DateTimePickerType

Whether the widget supports inputting a date, a time, or the date and time.

int64

The default value displayed in the widget, in milliseconds since Unix epoch time .

Specify the value based on the type of picker ( DateTimePickerType ):

• DATE_AND_TIME : a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use 1672574400000 .
• DATE_ONLY : a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use 1672531200000 .
• TIME_ONLY : a time in UTC. For example, to represent 12:00 PM, use 43200000 (or 12 * 60 * 60 * 1000 ).

int32

The number representing the time zone offset from UTC, in minutes. If set, the value_ms_epoch is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting.

Action

Triggered when the user clicks Save or Clear from the DateTimePicker interface.

Validation

Available for Google Chat apps and Google Workspace Add-ons.

Icon

Deprecated in favor of startIcon .

Icon

The icon displayed in front of the text.

string

The text that appears above text . Always truncates.

string

Необходимый. The primary text.

Supports simple formatting. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons .

bool

The wrap text setting. If true , the text wraps and displays on multiple lines. Otherwise, the text is truncated.

Only applies to text , not topLabel and bottomLabel .

string

The text that appears below text . Always wraps.

OnClick

This action is triggered when users click topLabel or bottomLabel .

Button

A button that a user can click to trigger an action.

SwitchControl

A switch widget that a user can click to change its state and trigger an action.

Icon

An icon displayed after the text.

Supports built-in and custom icons.

string

The name by which the switch widget is identified in a form input event.

For details about working with form inputs, see Receive form data .

string

The value entered by a user, returned as part of a form input event.

For details about working with form inputs, see Receive form data .

bool

When true , the switch is selected.

Action

The action to perform when the switch state is changed, such as what function to run.

ControlType

How the switch appears in the user interface.

Available for Google Chat apps and Google Workspace Add-ons.

Action

The render action for the client to end a dialog flow.

Available for Google Chat apps and unavailable for Google Workspace Add-ons.

Suggestions

string

This is a no-op schema field that might be present in the markup for syntax checking.

string

The text that displays in the grid header.

GridItem

The items to display in the grid.

BorderStyle

The border style to apply to each grid item.

int32

The number of columns to display in the grid. A default value is used if this field isn't specified, and that default value is different depending on where the grid is shown (dialog versus companion).

OnClick

This callback is reused by each individual grid item, but with the item's identifier and index in the items list added to the callback's parameters.

string

A user-specified identifier for this grid item. This identifier is returned in the parent grid's onClick callback parameters.

ImageComponent

The image that displays in the grid item.

string

The grid item's title.

string

The grid item's subtitle.

GridItemLayout

The layout to use for the grid item.

string

Необязательный. A description of the icon used for accessibility. If unspecified, the default value Button is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, A user's account portrait , or Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat .

If the icon is set in a Button , the altText appears as helper text when the user hovers over the button. However, if the button also sets text , the icon's altText is ignored.

ImageType

The crop style applied to the image. In some cases, applying a CIRCLE crop causes the image to be drawn larger than a built-in icon.

string

Display one of the built-in icons provided by Google Workspace.

For example, to display an airplane icon, specify AIRPLANE . For a bus, specify BUS .

For a full list of supported icons, see built-in icons .

string

Display a custom icon hosted at an HTTPS URL.

Например:

"iconUrl":
"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png"

Supported file types include .png and .jpg .

MaterialIcon

Display one of the Google Material Icons .

For example, to display a checkbox icon , use

"materialIcon": {
  "name": "check_box"
}

Available for Google Chat apps and unavailable for Google Workspace Add-ons.

string

The HTTPS URL that hosts the image.

Например:

https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png

OnClick

When a user clicks the image, the click triggers this action.

string

The alternative text of this image that's used for accessibility.

string

The image URL.

string

The accessibility label for the image.

ImageCropStyle

The crop style to apply to the image.

BorderStyle

The border style to apply to the image.

ImageCropType

The crop type.

double

The aspect ratio to use if the crop type is RECTANGLE_CUSTOM .

For example, here's how to apply a 16:9 aspect ratio:

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

string

URL of the link to return to the add-on.

string

Title of the link to return to the add-on.

Card

A card that displays information about a link from a third-party service.

string

The title that displays in the smart chip for the link preview. If unset, the smart chip displays the header of the preview_card .

string

The title that displays in the link preview. If unset, the link preview displays the header of the preview_card .

string

The icon name defined in the Google Material Icon , for example, check_box . Any invalid names are abandoned and replaced with empty string and results in the icon failing to render.

bool

Whether the icon renders as filled. Default value is false.

To preview different icon settings, go to Google Font Icons and adjust the settings under Customize .

int32

The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used.

To preview different icon settings, go to Google Font Icons and adjust the settings under Customize .

int32

Weight and grade affect a symbol's thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used.

To preview different icon settings, go to Google Font Icons and adjust the settings under Customize .

bool

Card stack pops all cards off except the root card.

bool

Card stack pops one card off.

string

Card stack pops all cards above the specified card with given card name.

Card

Card stack pushes a card onto the card stack.

Card

Card stack updates the top card with a new card and preserves filled form fields values. For a non-equivalent field, the value is dropped.

EndNavigation

Dialog flow end navigation action. For more information, see Build a homepage for a Google Chat app

Available for Google Chat apps and unavailable for Google Workspace Add-ons.

string

Plain text to display for the notification, without HTML tags.

Action

If specified, an action is triggered by this onClick .

OpenLink

If specified, this onClick triggers an open link action.

Action

An add-on triggers this action when the action needs to open a link. This differs from the open_link above in that this needs to talk to server to get the link. Thus some preparation work is required for web client to do before the open link action response comes back.

Available for Google Workspace Add-ons and unavailable for Google Chat apps.

Card

A new card is pushed to the card stack after clicking if specified.

Available for Google Workspace Add-ons and unavailable for Google Chat apps.

OverflowMenu

If specified, this onClick opens an overflow menu. Available for Google Chat apps and unavailable for Google Workspace Add-ons.

string

The URL to open.

OpenAs

How to open a link.

Available for Google Workspace Add-ons and unavailable for Google Chat apps.

OnClose

Whether the client forgets about a link after opening it, or observes it until the window closes.

Available for Google Workspace Add-ons and unavailable for Google Chat apps.

OverflowMenuItem

Необходимый. The list of menu options.

Icon

The icon displayed in front of the text.

string

Необходимый. The text that identifies or describes the item to users.

OnClick

Необходимый. The action invoked when a menu option is selected. This OnClick cannot contain an OverflowMenu , any specified OverflowMenu is dropped and the menu item disabled.

bool

Whether the menu option is disabled. Defaults to false.

Action

HostAppActionMarkup

Actions handled by individual host apps.

string

This is a no-op schema field that might be present in the markup for syntax checking.

Navigation

Push, pop, or update displayed cards.

OpenLink

Immediately open the target link in a new tab or a pop-up.

Notification

Display a notification to the end user.

LinkPreview

Display a link preview to the end user.

Link

The link for a third-party resource that's created from within a Google Workspace application. Formatted as an array of objects with one item. For more information, see Create third-party resources from the @ menu .

string

Необходимый. The name that identifies the selection input in a form input event.

For details about working with form inputs, see Receive form data .

string

The text that appears above the selection input field in the user interface.

Specify text that helps the user enter the information your app needs. For example, if users are selecting the urgency of a work ticket from a drop-down menu, the label might be "Urgency" or "Select urgency".

SelectionType

The type of items that are displayed to users in a SelectionInput widget. Selection types support different types of interactions. For example, users can select one or more checkboxes, but they can only select one value from a dropdown menu.

SelectionItem

An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.

Action

If specified, the form is submitted when the selection changes. If not specified, you must specify a separate button that submits the form.

For details about working with form inputs, see Receive form data .

int32

For multiselect menus, the maximum number of items that a user can select. Minimum value is 1 item. If unspecified, defaults to 3 items.

int32

For multiselect menus, the number of text characters that a user inputs before the app queries autocomplete and displays suggested items in the menu.

If unspecified, defaults to 0 characters for static data sources and 3 characters for external data sources.

Validation

For dropdown menus, the validation for this selection input field.

Available for Google Chat apps and Google Workspace Add-ons.

Action

An external data source, such as a relational data base.

PlatformDataSource

A data source from Google Workspace.

CommonDataSource

A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.

HostAppDataSourceMarkup

A data source that's unique to a Google Workspace host application, such spaces in Google Chat.

This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see Install the client libraries .

string

The text that identifies or describes the item to users.

string

The value associated with this item. The client should use this as a form input value.

For details about working with form inputs, see Receive form data .

bool

Whether the item is selected by default. If the selection input only accepts one value (such as for radio buttons or a dropdown menu), only set this field for one item.

string

For multiselect menus, the URL for the icon displayed next to the item's text field. Supports PNG and JPEG files. Must be an HTTPS URL. For example, https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png .

string

For multiselect menus, a text description or label that's displayed below the item's text field.

RenderActions

A set of render instructions that tells the card to perform an action and/or tells the add-on host app to perform an app-specific action.

bool

Whether the state of the cards has changed and data in existing cards is stale.

string

This is a no-op schema field that may be present in the markup for syntax checking.

SuggestionItem

A list of suggestions used for autocomplete recommendations in text input fields.

string

The value of a suggested input to a text input field. This is equivalent to what users enter themselves.

string

The name by which the text input is identified in a form input event.

For details about working with form inputs, see Receive form data .

string

The text that appears above the text input field in the user interface.

Specify text that helps the user enter the information your app needs. For example, if you are asking someone's name, but specifically need their surname, write surname instead of name .

Required if hintText is unspecified. Otherwise, optional.

string

Text that appears below the text input field meant to assist users by prompting them to enter a certain value. This text is always visible.

Required if label is unspecified. Otherwise, optional.

string

The value entered by a user, returned as part of a form input event.

For details about working with form inputs, see Receive form data .

Type

How a text input field appears in the user interface. For example, whether the field is single or multi-line.

Action

What to do when a change occurs in the text input field. For example, a user adding to the field or deleting text.

Examples of actions to take include running a custom function or opening a dialog in Google Chat.

Suggestions

Suggested values that users can enter. These values appear when users click inside the text input field. As users type, the suggested values dynamically filter to match what the users have typed.

For example, a text input field for programming language might suggest Java, JavaScript, Python, and C++. When users start typing Jav , the list of suggestions filters to show just Java and JavaScript .

Suggested values help guide users to enter values that your app can make sense of. When referring to JavaScript, some users might enter javascript and others java script . Suggesting JavaScript can standardize how users interact with your app.

When specified, TextInput.type is always SINGLE_LINE , even if it's set to MULTIPLE_LINE .

Available for Google Chat apps and Google Workspace Add-ons.

Action

Необязательный. Specify what action to take when the text input field provides suggestions to users who interact with it.

If unspecified, the suggestions are set by initialSuggestions and are processed by the client.

If specified, the app takes the action specified here, such as running a custom function.

Available for Google Workspace Add-ons and unavailable for Google Chat apps.

Validation

Available for Google Chat apps and Google Workspace Add-ons.

string

Text that appears in the text input field when the field is empty. Use this text to prompt users to enter a value. For example, Enter a number from 0 to 100 .

Available for Google Chat apps and unavailable for Google Workspace Add-ons.

string

The text that's shown in the widget.

int32

The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a show more button. If the text is equal or shorter than the specified maximum number of lines, a show more button isn't displayed.

The default value is 0, in which case all context is displayed. Negative values are ignored. Available for Google Chat apps and unavailable for Google Workspace Add-ons.

int32

Available for Google Chat apps and Google Workspace Add-ons.

InputType

Available for Google Chat apps and Google Workspace Add-ons.

HorizontalAlignment

Specifies whether widgets align to the left, right, or center of a column.

TextParagraph

Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons .

For example, the following JSON creates a bolded text:

"textParagraph": {
  "text": "  <b>bold text</b>"
}

Image

Отображает изображение.

For example, the following JSON creates an image with alternative text:

"image": {
  "imageUrl":
  "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
  "altText": "Chat app avatar"
}

DecoratedText

Displays a decorated text item.

For example, the following JSON creates a decorated text widget showing email address:

"decoratedText": {
  "icon": {
    "knownIcon": "EMAIL"
  },
  "topLabel": "Email Address",
  "text": "sasha@example.com",
  "bottomLabel": "This is a new Email address!",
  "switchControl": {
    "name": "has_send_welcome_email_to_sasha",
    "selected": false,
    "controlType": "CHECKBOX"
  }
}

ButtonList

A list of buttons.

For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link:

"buttonList": {
  "buttons": [
    {
      "text": "Edit",
      "color": {
        "red": 0,
        "green": 0,
        "blue": 1,
      },
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}

TextInput

Displays a text box that users can type into.

For example, the following JSON creates a text input for an email address:

"textInput": {
  "name": "mailing_address",
  "label": "Mailing Address"
}

As another example, the following JSON creates a text input for a programming language with static suggestions:

"textInput": {
  "name": "preferred_programing_language",
  "label": "Preferred Language",
  "initialSuggestions": {
    "items": [
      {
        "text": "C++"
      },
      {
        "text": "Java"
      },
      {
        "text": "JavaScript"
      },
      {
        "text": "Python"
      }
    ]
  }
}

SelectionInput

Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus.

For example, the following JSON creates a dropdown menu that lets users choose a size:

"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

Displays a widget that lets users input a date, time, or date and time.

For example, the following JSON creates a date time picker to schedule an appointment:

"dateTimePicker": {
  "name": "appointment_time",
  "label": "Book your appointment at:",
  "type": "DATE_AND_TIME",
  "valueMsEpoch": "796435200000"
}

Divider

Displays a horizontal line divider between widgets.

For example, the following JSON creates a divider:

"divider": {
}

Grid

Displays a grid with a collection of items.

A grid supports any number of columns and items. The number of rows is determined by the upper bounds of the number items divided by the number of columns. A grid with 10 items and 2 columns has 5 rows. A grid with 11 items and 2 columns has 6 rows.

Available for Google Chat apps and Google Workspace Add-ons.

For example, the following JSON creates a 2 column grid with a single item:

"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

Displays up to 2 columns.

To include more than 2 columns, or to use rows, use the Grid widget.

For example, the following JSON creates 2 columns that each contain text paragraphs:

"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"
          }
        }
      ]
    }
  ]
}

ChipList

A list of chips.

For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link:

"chipList": {
  "chips": [
    {
      "text": "Edit",
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}

Available for Google Chat apps and unavailable for Google Workspace Add-ons.