Cards v2

object ( CardHeader )

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

object ( Section )

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

enum ( DividerStyle )

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

object ( 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.

object ( CardFixedFooter )

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

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

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

enum ( DisplayStyle )

В дополнениях Google Workspace задаются свойства отображения элемента peekCardHeader .

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

object ( CardHeader )

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

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

object ( ExpressionData )

Данные выражения для карты.

Доступно для дополнений Google Workspace, расширяющих функциональность Google Workspace Studio. Недоступно для приложений Google Chat.

string

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

string

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

enum ( ImageType )

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

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

string

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

string

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

string

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

object ( Widget )

Все виджеты в разделе. Должен содержать как минимум один виджет.

boolean

Указывает, можно ли свернуть этот раздел.

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

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

integer

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

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

string

Уникальный идентификатор, присваиваемый разделу и используемый для идентификации раздела, подлежащего изменению. Идентификатор имеет ограничение в 64 символа и должен быть в формате [a-zA-Z0-9-]+ .

Доступно для дополнений Google Workspace, расширяющих функциональность Google Workspace Studio. Недоступно для приложений Google Chat.

object ( CollapseControl )

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

enum ( HorizontalAlignment )

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

string

Уникальный идентификатор, присваиваемый виджету и используемый для идентификации виджета, подлежащего изменению. Идентификатор имеет ограничение в 64 символа и должен быть в формате [a-zA-Z0-9-]+ и.

Доступно для дополнений Google Workspace, расширяющих функциональность Google Workspace Studio. Недоступно для приложений Google Chat.

enum ( Visibility )

Указывает, будет ли виджет видимым или скрытым. Значение по умолчанию — VISIBLE .

Доступно для дополнений Google Workspace, расширяющих функциональность Google Workspace Studio. Недоступно для приложений Google Chat.

object ( EventAction )

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

Доступно для дополнений Google Workspace, расширяющих функциональность Google Workspace Studio. Недоступно для приложений Google Chat.

object ( TextParagraph )

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

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

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

object ( Image )

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

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

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

object ( 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"
  }
}

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

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

object ( 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
    }
  ]
}

object ( DateTimePicker )

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

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

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

object ( Divider )

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

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

"divider": {
}

object ( 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"
    }
  }
}

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

object ( Carousel )

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

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

object ( ChipList )

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

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

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

string

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

integer

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

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

enum ( TextSyntax )

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

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

string

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

Например:

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

object ( OnClick )

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

string

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

object ( Action )

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

object ( OpenLink )

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

object ( Action )

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

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

object ( Card )

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

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

object ( OverflowMenu )

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

string

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

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

object ( ActionParameter )

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

enum ( LoadIndicator )

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

boolean

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

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

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

enum ( Interaction )

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

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

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

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

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

string

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

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

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

boolean

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

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

string

Название параметра для скрипта действия.

string

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

string

URL-адрес для открытия. HTTP-адреса преобразуются в HTTPS.

enum ( OpenAs )

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

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

enum ( OnClose )

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

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

object ( OverflowMenuItem )

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

object ( Icon )

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

string

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

object ( OnClick )

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

boolean

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

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

enum ( ImageType )

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

string

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

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

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

string

Отобразить пользовательскую иконку, размещенную по адресу HTTPS.

Например:

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

Поддерживаются файлы следующих форматов: .png и .jpg .

object ( MaterialIcon )

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

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

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

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

string

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

boolean

Определяет, отображается ли иконка заполненной. Значение по умолчанию — false.

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

integer

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

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

integer

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

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

object ( Icon )

Устарело, вместо него используется startIcon .

object ( Icon )

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

enum ( VerticalAlignment )

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

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

string

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

object ( TextParagraph )

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

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

string

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

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

object ( TextParagraph )

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

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

boolean

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

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

string

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

object ( TextParagraph )

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

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

object ( OnClick )

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

object ( Button )

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

object ( SwitchControl )

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

object ( Icon )

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

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

string

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

object ( Icon )

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

object ( 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 недоступно для выбора цвета кнопки. Если оно указано, это поле игнорируется.

object ( OnClick )

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

boolean

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

string

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

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

enum ( Type )

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

number

Количество красного цвета в заданном диапазоне значений находится в интервале [0, 1].

number

Количество зеленого цвета в заданном диапазоне значений находится в интервале [0, 1].

number

Количество синего цвета в заданном цвете выражается значением в интервале [0, 1].

number

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

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

Это означает, что значение 1,0 соответствует сплошному цвету, а значение 0,0 — полностью прозрачному цвету. Используется оберточное сообщение, а не простое скалярное значение с плавающей запятой, что позволяет различать значение по умолчанию и значение, которое не задано. Если этот параметр опущен, объект цвета отображается как сплошной цвет (как если бы значению альфа-канала было явно присвоено значение 1,0).

string

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

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

string

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

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

boolean

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

object ( Action )

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

enum ( ControlType )

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

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

object ( Button )

Набор кнопок.

string

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

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

string

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

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

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

string

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

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

string

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

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

enum ( Type )

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

object ( Action )

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

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

object ( Suggestions )

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

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

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

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

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

object ( Action )

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

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

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

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

object ( Validation )

Specify the input format validation necessary for this text field.

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

string

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

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

object ( HostAppDataSourceMarkup )

A data source that's unique to a Google Workspace host application, such as Gmail emails, Google Calendar events, or Google Chat messages.

Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.

Action

Navigation

Pushes, pops, or updates a card.

Add-ons in Google Chat .

Card

Pushes a card onto the card stack.

For dialogs in Google Chat , opens or updates a dialog.

Card

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

For dialogs in Google Chat , opens or updates a dialog.

object ( SuggestionItem )

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

string

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

integer

Specify the character limit for text input widgets. Note that this is only used for text input and is ignored for other widgets.

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

enum ( InputType )

Specify the type of the input widgets.

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

object ( ChatClientDataSourceMarkup )

A data source from Google Chat.

object ( WorkflowDataSourceMarkup )

A data source from Google Workflow.

object ( SpaceDataSource )

Google Chat spaces that the user is a member of.

boolean

If set to true , the multiselect menu selects the current Google Chat space as an item by default.

boolean

Whether to include variables from the previous step in the data source.

enum ( Type )

The type of data source.

string

Required. The name that identifies the selection input in a form input event.

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

string

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

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

enum ( SelectionType )

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

object ( SelectionItem )

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

object ( Action )

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

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

integer

For multiselect menus, the number of text characters that a user inputs before the menu returns suggested selection items.

If unset, the multiselect menu uses the following default values:

• If the menu uses a static array of SelectionInput items, defaults to 0 characters and immediately populates items from the array.
• If the menu uses a dynamic data source ( multi_select_data_source ), defaults to 3 characters before querying the data source to return suggested items.

object ( DataSourceConfig )

Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source.

If specified, the multiSelectMaxSelectedItems field, multiSelectMinQueryLength field, externalDataSource field and platformDataSource field are ignored.

Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the Dropdown widget widget in Google Chat apps as part of the Developer Preview Program . Note: For the Dropdown widget in Google Chat apps, only one DataSourceConfig is supported. If multiple DataSourceConfig s are provided, only the first one is used.

integer

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

string

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

Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.

object ( Action )

An external data source, such as a relational database.

object ( PlatformDataSource )

A data source from Google Workspace.

string

The text that identifies or describes the item to users.

string

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

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

boolean

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

string

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

string

enum ( CommonDataSource )

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

object ( HostAppDataSourceMarkup )

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

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

object ( Action )

The data is from a remote data provider.

object ( PlatformDataSource )

The data is from a Google Workspace application.

integer

The minimum number of characters the user must enter before this data provider is triggered (ie, before it starts returning results).

string

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

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

string

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

enum ( DateTimePickerType )

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

string ( int64 format)

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

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

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

integer

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

object ( Action )

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

object ( HostAppDataSourceMarkup )

A data source that's unique to a Google Workspace host application, such as Gmail emails, Google Calendar events, or Google Chat messages.

Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.

string

The text that displays in the grid header.

object ( GridItem )

The items to display in the grid.

object ( BorderStyle )

The border style to apply to each grid item.

integer

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

object ( OnClick )

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

string

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

object ( ImageComponent )

The image that displays in the grid item.

string

The grid item's title.

string

The grid item's subtitle.

enum ( GridItemLayout )

The layout to use for the grid item.

string

The image URL.

string

The accessibility label for the image.

object ( ImageCropStyle )

The crop style to apply to the image.

object ( BorderStyle )

The border style to apply to the image.

enum ( ImageCropType )

The crop type.

number

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

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

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

enum ( BorderType )

The border type.

object ( Color )

The colors to use when the type is BORDER_TYPE_STROKE .

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

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

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

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

integer

The corner radius for the border.

object ( Column )

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

enum ( HorizontalSizeStyle )

Specifies how a column fills the width of the card.

enum ( HorizontalAlignment )

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

enum ( VerticalAlignment )

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

object ( Widgets )

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

object ( TextParagraph )

TextParagraph widget.

object ( Image )

Image widget.

object ( DecoratedText )

DecoratedText widget.

object ( ButtonList )

ButtonList widget.

object ( TextInput )

TextInput widget.

object ( SelectionInput )

SelectionInput widget.

object ( DateTimePicker )

DateTimePicker widget.

object ( ChipList )

ChipList widget.

enum ( Layout )

Specified chip list layout.

object ( Chip )

An array of chips.

object ( Icon )

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

string

The text displayed inside the chip.

object ( OnClick )

Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function.

boolean

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

boolean

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

string

The alternative text that's used for accessibility.

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

object ( CarouselCard )

A list of cards included in the carousel.

object ( NestedWidget )

A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified.

object ( NestedWidget )

A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified.

object ( TextParagraph )

A text paragraph widget.

object ( ButtonList )

A button list widget.

object ( Image )

An image widget.

string

The unique identifier of the ActionRule.

object ( Trigger )

The list of triggers that will be triggered after the EventAction is executed.

object ( CommonWidgetAction )

Common widget action.

string

The unique identifier of the ActionRule.

object ( UpdateVisibilityAction )

The action to update the visibility of a widget.

enum ( Visibility )

The new visibility.

enum ( HorizontalAlignment )

The horizontal alignment of the expand and collapse button.

object ( Button )

Optional. Define a customizable button to expand the section. Both expandButton and collapseButton field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used.

object ( Button )

Optional. Define a customizable button to collapse the section. Both expandButton and collapseButton field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used.

string

The label that displays as the action menu item.

object ( OnClick )

The onClick action for this action item.

object ( Button )

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

object ( Button )

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

string

The unique identifier of the ExpressionData.

string

The uncompiled expression.

object ( Condition )

The list of conditions that are determined by the expression evaluation result.

object ( EventAction )

The list of actions that the ExpressionData can be used.

string

The unique identifier of the ActionRule.

object ( ExpressionDataCondition )

The condition that is determined by the expression data.

enum ( ConditionType )

The type of the condition.