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 :

"card_actions": [
  {
    "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

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

Button

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

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.

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 .

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

"material_icon": {
  "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

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

bool

Будет ли значок отображаться заполненным. Значение по умолчанию — ложь.

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

int32

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

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

int32

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

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

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

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

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, например пространства в 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 поля элемента.

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.