Package google.apps.card.v1

Индекс

Действие

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

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

Поля
function

string

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

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

parameters[]

ActionParameter

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

load_indicator

LoadIndicator

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

persist_values

bool

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

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

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

interaction

Interaction

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

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

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

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

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

required_widgets[]

string

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

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

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

all_widgets_are_required

bool

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

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

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

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

Более подробную информацию см. в разделе CommonEventObject .

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

Поля
key

string

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

value

string

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

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

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

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

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

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

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

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

Перечисления
INTERACTION_UNSPECIFIED Значение по умолчанию. action выполняется как обычно.
OPEN_DIALOG

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

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

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

Индикатор нагрузки

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

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

Перечисления
SPINNER Отображает вращающийся индикатор, указывающий на загрузку контента.
NONE Ничего не отображается.

BorderStyle

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

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

Поля
type

BorderType

Тип границы.

stroke_color

Color

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

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

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

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

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

corner_radius

int32

Радиус угла границы.

BorderType

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

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

Перечисления
BORDER_TYPE_UNSPECIFIED Не использовать. Не указано.
NO_BORDER Границы нет.
STROKE Значение по умолчанию. Контур.

Кнопка

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

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

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

Поля
text

string

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

icon

Icon

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

color

Color

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

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

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

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

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

on_click

OnClick

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

disabled

bool

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

alt_text

string

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

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

type

Type

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

Тип

Необязательно. Тип кнопки. Если задано поле color , type принудительно устанавливается на FILLED .

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

Перечисления
TYPE_UNSPECIFIED Не использовать. Не указано.
OUTLINED Выделенные кнопки — кнопки средней важности. Они обычно содержат важные действия, но не являются основными в приложении чата или дополнении.
FILLED Заполненная кнопка представляет собой контейнер со сплошным цветом. Она производит наиболее визуальное впечатление и рекомендуется для важных и основных действий в приложении чата или дополнении.
FILLED_TONAL Кнопка с заливкой и тоновым оформлением — это альтернативный вариант между кнопками с заливкой и кнопками с контуром. Они полезны в ситуациях, когда кнопка с низким приоритетом требует чуть большего внимания, чем кнопка с контуром.
BORDERLESS По умолчанию кнопка не имеет невидимого контейнера. Она часто используется для действий с самым низким приоритетом, особенно при наличии нескольких вариантов выбора.

ButtonList

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

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

Поля
buttons[]

Button

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

Карта

Интерфейс карточки, отображаемый в сообщении Google Chat или дополнении Google Workspace.

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

Создавайте и просматривайте открытки с помощью Card Builder.

Откройте конструктор карт

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

Примечание: Вы можете добавить до 100 виджетов на одну карточку. Любые виджеты, превышающие это ограничение, игнорируются. Это ограничение применяется как к сообщениям и диалогам в приложениях Google Chat, так и к карточкам в расширениях Google Workspace.

Пример: сообщение в карточке для приложения Google Chat

Пример контактной карточки

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

{
  "cardsV2": [
    {
      "cardId": "unique-card-id",
      "card": {
        "header": {
           "title": "Sasha",
           "subtitle": "Software Engineer",
           "imageUrl":
           "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
           "imageType": "CIRCLE",
           "imageAltText": "Avatar for Sasha"
         },
         "sections": [
           {
             "header": "Contact Info",
             "collapsible": true,
             "uncollapsibleWidgetsCount": 1,
             "widgets": [
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "EMAIL"
                   },
                   "text": "sasha@example.com"
                 }
               },
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "PERSON"
                   },
                   "text": "<font color=\"#80e27e\">Online</font>"
                 }
               },
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "PHONE"
                   },
                   "text": "+1 (555) 555-1234"
                 }
               },
               {
                 "buttonList": {
                   "buttons": [
                     {
                       "text": "Share",
                       "onClick": {
                        "openLink": {
                           "url": "https://example.com/share"
                         }
                       }
                     },
                     {
                       "text": "Edit",
                       "onClick": {
                         "action": {
                           "function": "goToView",
                           "parameters": [
                             {
                               "key": "viewType",
                               "value": "EDIT"
                             }
                           ]
                         }
                       }
                     }
                   ]
                 }
               }
             ]
           }
         ]
       }
    }
  ]
}
Поля
header

CardHeader

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

sections[]

Section

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

section_divider_style

DividerStyle

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

card_actions[]

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

string

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

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

display_style

DisplayStyle

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

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

peek_card_header

CardHeader

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

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

CardAction

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

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

Поля
action_label

string

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

on_click

OnClick

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

CardFixedFooter

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

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

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

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

Поля
primary_button

Button

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

secondary_button

Button

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

CardHeader

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

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

Поля
title

string

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

subtitle

string

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

image_type

ImageType

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

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

image_url

string

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

image_alt_text

string

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

DisplayStyle

В дополнениях Google Workspace определяет способ отображения карточки.

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

Перечисления
DISPLAY_STYLE_UNSPECIFIED Не использовать. Не указано.
PEEK Заголовок карты отображается внизу боковой панели, частично перекрывая текущую верхнюю карту в колоде. Щелчок по заголовку добавляет карту в колоду. Если у карты нет заголовка, вместо него используется сгенерированный заголовок.
REPLACE Значение по умолчанию. Карта отображается, заменяя вид верхней карты в стопке.

DividerStyle

Разделитель для карточек. В настоящее время используется только для разделителей между секциями карточек.

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

Перечисления
DIVIDER_STYLE_UNSPECIFIED Не использовать. Не указано.
SOLID_DIVIDER Параметр по умолчанию. Отобразить сплошной разделитель.
NO_DIVIDER Если установлено, разделитель не отображается. Этот стиль полностью удаляет разделитель из макета. Результат эквивалентен отсутствию разделителя вообще.

Вложенный виджет

Список виджетов, которые могут быть отображены в содержащем макете, например CarouselCard . Доступно для приложений Google Chat и недоступно для дополнений Google Workspace.

Поля

data полевых исследований Союза.

data могут быть только одним из следующих:

text_paragraph

TextParagraph

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

button_list

ButtonList

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

image

Image

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

Раздел

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

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

Поля
header

string

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

widgets[]

Widget

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

collapsible

bool

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

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

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

uncollapsible_widgets_count

int32

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

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

collapse_control

CollapseControl

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

Карусель, также известная как слайдер, вращается и отображает список виджетов в формате слайд-шоу с кнопками для перехода к предыдущему или следующему виджету.

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

{
  "carouselCards": [
    {
      "widgets": [
        {
          "textParagraph": {
            "text": "First text paragraph in carousel",
          }
        }
      ]
    },
    {
      "widgets": [
        {
          "textParagraph": {
            "text": "Second text paragraph in carousel",
          }
        }
      ]
    },
    {
      "widgets": [
        {
          "textParagraph": {
            "text": "Third text paragraph in carousel",
          }
        }
      ]
    }
  ]
}

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

Поля
carousel_cards[]

CarouselCard

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

КарусельКарта

Карточка, которая может отображаться как элемент карусели. Доступно для приложений Google Chat и недоступно для дополнений Google Workspace.

Поля
widgets[]

NestedWidget

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

footer_widgets[]

NestedWidget

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

Чип

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

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

Поля
icon

Icon

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

label

string

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

on_click

OnClick

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

enabled
(deprecated)

bool

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

disabled

bool

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

alt_text

string

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

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

ChipList

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

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

Поля
layout

Layout

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

chips[]

Chip

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

Макет

Макет списка микросхем.

Перечисления
LAYOUT_UNSPECIFIED Не использовать. Не указано.
WRAPPED Значение по умолчанию. Список фишек переносится на следующую строку, если по горизонтали недостаточно места.
HORIZONTAL_SCROLLABLE Фишки прокручиваются горизонтально, если они не помещаются в отведенное им место.

CollapseControl

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

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

Поля
horizontal_alignment

HorizontalAlignment

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

expand_button

Button

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

collapse_button

Button

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

Колонны

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

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

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

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

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

Доступно для приложений Google Chat и дополнений Google Workspace. Интерфейсы дополнений, поддерживающие столбцы, включают:

  • Диалоговое окно, отображаемое, когда пользователи открывают дополнение из черновика электронного письма.
  • Диалоговое окно, отображаемое, когда пользователи открывают дополнение из меню «Добавить вложение» в событии Календаря Google.
Поля
column_items[]

Column

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

Столбец

Колонка.

Дополнения Google Workspace и приложения чата

Поля
horizontal_size_style

HorizontalSizeStyle

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

horizontal_alignment

HorizontalAlignment

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

vertical_alignment

VerticalAlignment

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

widgets[]

Widgets

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

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

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

Дополнения Google Workspace и приложения чата

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

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

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

Дополнения Google Workspace и приложения чата

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

Виджеты

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

Дополнения Google Workspace и приложения чата

Поля

data полевых исследований Союза.

data могут быть только одним из следующих:

text_paragraph

TextParagraph

Виджет TextParagraph .

image

Image

Виджет Image .

decorated_text

DecoratedText

Виджет DecoratedText .

button_list

ButtonList

Виджет ButtonList .

text_input

TextInput

Виджет TextInput .

selection_input

SelectionInput

Виджет SelectionInput .

date_time_picker

DateTimePicker

Виджет DateTimePicker .

chip_list

ChipList

Виджет ChipList .

DateTimePicker

Позволяет пользователям вводить дату, время или и дату, и время одновременно. Поддерживает валидацию отправки форм. Если Action.all_widgets_are_required задано значение true или этот виджет указан в Action.required_widgets , отправка блокируется, если не выбрано значение. Пример в приложениях Google Chat см. в разделе «Разрешить пользователю выбирать дату и время» .

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

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

Поля
name

string

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

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

label

string

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

type

DateTimePickerType

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

value_ms_epoch

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

int32

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

on_change_action

Action

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

DateTimePickerType

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

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

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

DecoratedText

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

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

Поля
icon
(deprecated)

Icon

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

start_icon

Icon

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

start_icon_vertical_alignment

VerticalAlignment

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

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

top_label

string

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

top_label_text

TextParagraph

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

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

text

string

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

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

content_text

TextParagraph

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

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

wrap_text

bool

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

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

bottom_label

string

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

bottom_label_text

TextParagraph

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

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

on_click

OnClick

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

control полем объединения. Кнопка, переключатель, флажок или изображение, отображаемые справа от текста в виджете decoratedText . control может быть только одним из следующих:
button

Button

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

switch_control

SwitchControl

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

end_icon

Icon

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

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

SwitchControl

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

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

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

Поля
name

string

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

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

value

string

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

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

selected

bool

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

on_change_action

Action

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

control_type

ControlType

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

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

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

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

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

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

Разделитель

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

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

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

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

"divider": {}

Сетка

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

Сетка поддерживает любое количество столбцов и элементов. Количество строк определяется отношением количества элементов к количеству столбцов. Сетка с 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"
    }
  }
}
Поля
title

string

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

items[]

GridItem

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

border_style

BorderStyle

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

column_count

int32

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

on_click

OnClick

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

GridItem

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

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

Поля
id

string

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

image

ImageComponent

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

title

string

Заголовок элемента сетки.

subtitle

string

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

layout

GridItemLayout

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

GridItemLayout

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

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

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

Икона

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

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

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

Поля
alt_text

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 значка игнорируется.

image_type

ImageType

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

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

string

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

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

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

icon_url

string

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

Например:

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

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

material_icon

MaterialIcon

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

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

"material_icon": {
  "name": "check_box"
}

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

Изображение

Изображение, которое указано URL и может иметь действие onClick . Для примера см. Добавьте изображение .

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

Поля
image_url

string

HTTPS URL, который размещает изображение.

Например: 

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

OnClick

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

alt_text

string

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

ImageComponent

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

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

Поля
image_uri

string

Изображение URL.

alt_text

string

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

crop_style

ImageCropStyle

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

border_style

BorderStyle

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

ImageCropstyle

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

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

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

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 16/9
}
Поля
type

ImageCropType

Тип урожая.

aspect_ratio

double

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

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

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

ImageCroptype

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

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

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

Материал

Значок материала Google , который включает в себя более 2500 опций.

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

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

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

Поля
name

string

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

fill

bool

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

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

weight

int32

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

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

grade

int32

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

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

Onclick

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

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

Поля

Объединенные полевые data .

data могут быть только одним из следующих:

action

Action

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

card

Card

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

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

overflow_menu

OverflowMenu

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

Onclose

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

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

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

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

Перечисление
NOTHING Значение по умолчанию. Карта не перезагружается; ничего не происходит.
RELOAD

Перезагружает карту после закрытия детского окна.

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

OpenS

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

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

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

Overflowmenu

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

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

Поля
items[]

OverflowMenuItem

Требуется Список вариантов меню.

Overflowmenuitem

Вариант, который пользователи могут вызвать в меню переполнения.

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

Поля
start_icon

Icon

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

text

string

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

on_click

OnClick

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

disabled

bool

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

SelectionInput

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

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

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

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

Поля
name

string

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

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

label

string

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

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

type

SelectionType

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

items[]

SelectionItem

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

on_change_action

Action

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

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

multi_select_max_selected_items

int32

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

multi_select_min_query_length

int32

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

Если вы не вытекают, в меню MultiSelect используется следующие значения по умолчанию:

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

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

Доступно для приложений Google Chat и недоступно для надстройки Google Workspace. multi_select_data_source может быть только одним из следующих:

external_data_source

Action

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

platform_data_source

PlatformDataSource

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

PlatformDatasource

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

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

Поля
Поле Союза data_source . Источник данных. data_source может быть только одним из следующих:
common_data_source

CommonDataSource

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

host_app_data_source

HostAppDataSourceMarkup

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

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

Commondatasource

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

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

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

SelectionItem

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

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

Поля
text

string

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

value

string

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

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

selected

bool

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

bottom_text

string

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

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

string

SelectionType

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

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

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

Перечисление
CHECK_BOX Набор флажок. Пользователи могут выбрать один или несколько флажков.
RADIO_BUTTON Набор радиопроизводств. Пользователи могут выбрать одну радиопроизводительную кнопку.
SWITCH Набор переключателей. Пользователи могут включать один или несколько коммутаторов.
DROPDOWN Выпадающее меню. Пользователи могут выбрать один элемент из меню.
MULTI_SELECT

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

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

  • Данные Google Workspace: элементы заполняются с использованием данных из Google Workspace, таких как пользователи Google Workspace или Google Chat Spaces.
  • Внешние данные: элементы заполняются из внешнего источника данных за пределами Google Workspace.

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

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

Предложения

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

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

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

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

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

Поля
items[]

SuggestionItem

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

Предложение

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

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

Поля

Полевой content союза.

content может быть только одним из следующих:

text

string

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

Ввод текста

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

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

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

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

Поля
name

string

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

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

label

string

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

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

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

hint_text

string

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

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

value

string

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

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

type

Type

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

on_change_action

Action

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

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

initial_suggestions

Suggestions

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

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

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

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

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

auto_complete_action

Action

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

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

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

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

validation

Validation

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

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

placeholder_text

string

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

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

Тип

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

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

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

TextParagraph

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

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

Поля
text

string

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

max_lines

int32

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

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

text_syntax

TextSyntax

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

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

Textsyntax

Синтаксис для использования для форматирования текста.

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

Перечисление
TEXT_SYNTAX_UNSPECIFIED Текст визуализируется как HTML, если он не указан.
HTML Текст отображается как HTML. Это значение по умолчанию.
MARKDOWN Текст отображается как отметка.

Проверка

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

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

Поля
character_limit

int32

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

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

input_type

InputType

Укажите тип входных виджетов.

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

Inputtype

Тип входного виджета.

Перечисление
INPUT_TYPE_UNSPECIFIED Неопределенный тип. Не используйте.
TEXT Регулярный текст, который принимает всех символов.
INTEGER Целочисленное значение.
FLOAT Значение поплавки.
EMAIL Адрес электронной почты.
EMOJI_PICKER Эмодзи, отобранный из предоставленного системой сборщика смайликов.

Виджет

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

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

Поля
horizontal_alignment

HorizontalAlignment

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

Объединенные полевые data . Виджет может иметь только один из следующих элементов. Вы можете использовать несколько полей виджетов для отображения большего количества элементов. data могут быть только одним из следующих:
text_paragraph

TextParagraph

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

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

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

Image

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

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

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

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

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

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

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

DateTimePicker

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

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

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

Divider

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

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

"divider": {
}
grid

Grid

Отображает сетку с коллекцией предметов.

Сетка поддерживает любое количество столбцов и элементов. Количество строк определяется верхними границами числа элементов, деленных на количество столбцов. Сетка с 10 пунктами и 2 столбцами имеет 5 строк. Сетка с 11 элементами и 2 столбцами имеет 6 строк.

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

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

"grid": {
  "title": "A fine collection of items",
  "columnCount": 2,
  "borderStyle": {
    "type": "STROKE",
    "cornerRadius": 4
  },
  "items": [
    {
      "image": {
        "imageUri": "https://www.example.com/image.png",
        "cropStyle": {
          "type": "SQUARE"
        },
        "borderStyle": {
          "type": "STROKE"
        }
      },
      "title": "An item",
      "textAlignment": "CENTER"
    }
  ],
  "onClick": {
    "openLink": {
      "url": "https://www.example.com"
    }
  }
}
columns

Columns

Отображает до 2 столбцов.

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

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

"columns": {
  "columnItems": [
    {
      "horizontalSizeStyle": "FILL_AVAILABLE_SPACE",
      "horizontalAlignment": "CENTER",
      "verticalAlignment": "CENTER",
      "widgets": [
        {
          "textParagraph": {
            "text": "First column text paragraph"
          }
        }
      ]
    },
    {
      "horizontalSizeStyle": "FILL_AVAILABLE_SPACE",
      "horizontalAlignment": "CENTER",
      "verticalAlignment": "CENTER",
      "widgets": [
        {
          "textParagraph": {
            "text": "Second column text paragraph"
          }
        }
      ]
    }
  ]
}
carousel

Carousel

Карусель содержит коллекцию вложенных виджетов. Например, это представление JSON карусели, которая содержит два текстовых параграфа. 

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

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.

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

ImageType

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

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

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

Вертикалинг

Представляет атрибут вертикального выравнивания.

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