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 , и любое заданное для этого поля значение игнорируется.

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

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

string

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

TextParagraph

Виджет текстового абзаца.

ButtonList

Виджет списка кнопок.

Image

Виджет изображения.

string

Текст, отображаемый в верхней части раздела. Поддерживает простой текст в формате HTML. Подробнее о форматировании текста см. в разделах Форматирование текста в приложениях Google Chat и Форматирование текста в расширениях Google Workspace .

Widget

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

bool

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

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

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

int32

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

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

CollapseControl

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

CarouselCard

Список карточек, включенных в карусель.

NestedWidget

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

NestedWidget

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

Icon

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

string

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

OnClick

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

bool

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

bool

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

string

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

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

Layout

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

Chip

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

HorizontalAlignment

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

Button

Необязательно. Создайте настраиваемую кнопку для развёртывания раздела. Необходимо задать поля expandButton и ColombiaButton. Только один набор полей не будет действовать. Если это поле не задано, будет использоваться кнопка по умолчанию.

Button

Необязательно. Создайте настраиваемую кнопку для сворачивания раздела. Необходимо задать оба поля: expandButton и ColombiaButton. Только один набор полей не будет действовать. Если это поле не задано, будет использоваться кнопка по умолчанию.

Column

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

HorizontalSizeStyle

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

HorizontalAlignment

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

VerticalAlignment

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

Widgets

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

TextParagraph

Виджет TextParagraph .

Image

Виджет Image .

DecoratedText

Виджет DecoratedText .

ButtonList

Виджет ButtonList .

TextInput

Виджет TextInput .

SelectionInput

Виджет SelectionInput .

DateTimePicker

Виджет DateTimePicker .

ChipList

Виджет ChipList .

HostAppDataActionMarkup

Определяет, как обновлять данные Google Workspace.

string

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

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

string

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

DateTimePickerType

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

int64

Значение по умолчанию, отображаемое в виджете, в миллисекундах с начала эпохи Unix .

Укажите значение на основе типа выбора ( DateTimePickerType ):

• DATE_AND_TIME : календарная дата и время в формате UTC. Например, чтобы обозначить 1 января 2023 года в 12:00 по UTC, используйте 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 .

Icon

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

Icon

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

VerticalAlignment

Необязательно. Вертикальное выравнивание значка «Пуск». Если не задано, значок будет выровнен по центру.

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

string

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

TextParagraph

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

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

string

Обязательно. Основной текст.

Поддерживает простое форматирование. Подробнее о форматировании текста см. в разделах Форматирование текста в приложениях Google Chat и Форматирование текста в расширениях Google Workspace .

TextParagraph

TextParagraph эквивалентен text . Позволяет использовать более сложное форматирование, чем text .

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

bool

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

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

string

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

TextParagraph

TextParagraph эквивалентно bottom_label . Всегда переносится. Позволяет реализовать более сложное форматирование, чем bottom_label .

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

OnClick

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

Button

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

SwitchControl

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

Icon

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

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

string

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

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

string

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

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

bool

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

Action

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

ControlType

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

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

Action

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

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

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

string

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

string

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

bool

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

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

int32

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

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

int32

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

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

UpdateWidget

Для надстроек в Google Chat обновляет виджет на карточке или в диалоговом окне.

SelectionInputWidgetSuggestions

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

SelectionItem

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

bool

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

bool

Вытаскивает одну карту.

string

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

Card

Помещает карту в стопку карт.

Для диалогов в Google Chat открывает или обновляет диалог.

Card

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

Для диалогов в Google Chat открывает или обновляет диалог.

EndNavigation

Для дополнений в Google Chat закрывает диалоговое окно .

string

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

Action

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

OpenLink

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

Action

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

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

Card

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

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

OverflowMenu

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

string

URL-адрес для открытия.

OpenAs

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

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

OnClose

Забывает ли клиент о ссылке после ее открытия или наблюдает за ней до закрытия окна.

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

OverflowMenuItem

Обязательно. Список опций меню.

Icon

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

string

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

OnClick

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

bool

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

Action

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

Дополнения в Google Chat .

HostAppActionMarkup

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

string

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

Navigation

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

Дополнения в Google Chat .

OpenLink

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

Notification

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

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

LinkPreview

Доступно в Google Docs, Google Sheets и Google Slides. Предварительный просмотр ссылок со смарт-чипами и картами. Подробности см. в разделе Предварительный просмотр ссылок со смарт-чипами .

Link

Доступно в Документах Google. Возвращает ссылку со стороннего ресурса и преобразует ее в смарт-чип в хост-приложении. Отформатирован как массив объектов с одним элементом.

Дополнительные сведения см. в разделе Создание сторонних ресурсов из меню @ .

ModifyCard

Для дополнений в Google Chat обновляет карточку на основе взаимодействия с пользователем. Массив должен содержать только один объект.

string

Обязательно. Имя, которое идентифицирует ввод выбора в событии ввода формы.

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

string

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

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

SelectionType

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

SelectionItem

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

Action

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

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

int32

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

int32

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

Если этот параметр не установлен, в меню множественного выбора используются следующие значения по умолчанию:

• Если в меню используется статический массив элементов SelectionInput , по умолчанию используется 0 символов и немедленно заполняются элементы из массива.
• Если в меню используется динамический источник данных ( multi_select_data_source ), по умолчанию используется 3 символа, прежде чем запрашивать источник данных для возврата предлагаемых элементов.

string

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

Поддерживается только Google Workspace Workflows, но не Google Chat API или надстройками Google Workspace.

Action

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

PlatformDataSource

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

CommonDataSource

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

HostAppDataSourceMarkup

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

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

string

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

string

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

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

bool

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

string

Для меню с множественным выбором — текстовое описание или метка, отображаемая под text полем элемента.

string

RenderActions

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

bool

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

string

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

SuggestionItem

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

string

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

string

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

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

string

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

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

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

string

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

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

string

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

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

Type

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

Action

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

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

Suggestions

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

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

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

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

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

Action

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

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

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

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

Validation

Укажите проверку формата ввода, необходимую для этого текстового поля.

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

string

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

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

string

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

int32

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

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

TextSyntax

Синтаксис текста. Если не установлено, текст отображается как HTML.

Доступно для приложений 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 создает сетку из двух столбцов с одним элементом:

"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 столбцов.

Чтобы включить более двух столбцов или использовать строки, используйте виджет 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"
          }
        }
      ]
    }
  ]
}

Carousel

Карусель содержит коллекцию вложенных виджетов. Например, это JSON-представление карусели, содержащее два текстовых абзаца.

{
  "widgets": [
    {
      "textParagraph": {
        "text": "First text paragraph in the carousel."
      }
    },
    {
      "textParagraph": {
        "text": "Second text paragraph in the carousel."
      }
    }
  ]
}

ChipList

Список фишек.

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

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