Карта
Карточка — это элемент пользовательского интерфейса, который может содержать виджеты пользовательского интерфейса, такие как текст и изображения.
JSON-представление |
---|
{ "header": { object ( |
Поля | |
---|---|
header | Заголовок карты. Заголовок обычно содержит заголовок и изображение. |
sections[] | Разделы разделены разделителем строк. |
cardActions[] | Действия этой карты. |
name | Название карты. |
Заголовок карты
JSON-представление |
---|
{
"title": string,
"subtitle": string,
"imageStyle": enum ( |
Поля | |
---|---|
title | Должно быть указано название. Заголовок имеет фиксированную высоту: если указаны и заголовок, и подзаголовок, каждый занимает одну строку. Если указан только заголовок, он занимает обе строки. |
subtitle | Подзаголовок шапки карты. |
imageStyle | Тип изображения (например, квадратная или круглая рамка). |
imageUrl | URL-адрес изображения в заголовке карточки. |
Стиль изображения
Перечисления | |
---|---|
IMAGE_STYLE_UNSPECIFIED | |
IMAGE | Квадратная граница. |
AVATAR | Круглая граница. |
Раздел
Раздел содержит коллекцию виджетов, которые отображаются (вертикально) в том порядке, в котором они указаны. На всех платформах карточки имеют узкую фиксированную ширину, поэтому в настоящее время нет необходимости в свойствах макета (например, float).
JSON-представление |
---|
{
"header": string,
"widgets": [
{
object ( |
Поля | |
---|---|
header | Заголовок раздела. Поддерживается форматированный текст. Дополнительную информацию о форматировании текста см. в разделах «Форматирование текста в приложениях Google Chat» и «Форматирование текста в надстройках Google Workspace» . |
widgets[] | Раздел должен содержать хотя бы один виджет. |
Разметка виджета
Виджет — это элемент пользовательского интерфейса, который представляет текст и изображения.
JSON-представление |
---|
{ "buttons": [ { object ( |
Поля | |
---|---|
buttons[] | Список кнопок. Кнопки также являются |
data поля объединения. WidgetMarkup может содержать только один из следующих элементов. Вы можете использовать несколько полей WidgetMarkup для отображения большего количества элементов. data могут быть только одним из следующих: | |
textParagraph | Отобразите текстовый абзац в этом виджете. |
image | Отобразите изображение в этом виджете. |
keyValue | Отобразите элемент ключевого значения в этом виджете. |
Текстовый абзац
Абзац текста. Поддерживается форматированный текст. Дополнительную информацию о форматировании текста см. в разделах «Форматирование текста в приложениях Google Chat» и «Форматирование текста в надстройках Google Workspace» .
JSON-представление |
---|
{ "text": string } |
Поля | |
---|---|
text | |
Изображение
Изображение, заданное URL-адресом и имеющее действие onclick
.
JSON-представление |
---|
{
"imageUrl": string,
"onClick": {
object ( |
Поля | |
---|---|
imageUrl | URL-адрес изображения. |
onClick | Действие |
aspectRatio | Соотношение сторон этого изображения (ширина и высота). Это поле позволяет вам зарезервировать нужную высоту изображения во время ожидания его загрузки. Он не предназначен для переопределения встроенного соотношения сторон изображения. Если значение не установлено, сервер заполняет его, предварительно загружая изображение. |
OnClick
Действие onclick
(например, открытие ссылки).
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
| |
action | Действие формы запускается этим действием |
openLink | Это действие |
ФормаДействие
Действие формы описывает поведение при отправке формы. Например, вы можете вызвать Apps Script для обработки формы.
JSON-представление |
---|
{
"actionMethodName": string,
"parameters": [
{
object ( |
Поля | |
---|---|
actionMethodName | Имя метода используется для определения того, какая часть формы вызвала отправку формы. Эта информация возвращается в приложение чата как часть события щелчка карты. Вы можете использовать одно и то же имя метода для нескольких элементов, которые вызывают общее поведение. |
parameters[] | Список параметров действия. |
Параметр действия
Список строковых параметров, которые необходимо указать при вызове метода действия. Например, рассмотрим три кнопки повтора: отложить сейчас, отложить один день, отложить на следующей неделе. Вы можете использовать action method = snooze()
, передав тип и время повтора в списке строковых параметров.
JSON-представление |
---|
{ "key": string, "value": string } |
Поля | |
---|---|
key | Имя параметра сценария действия. |
value | Значение параметра. |
ОпенЛинк
Ссылка, открывающая новое окно.
JSON-представление |
---|
{ "url": string } |
Поля | |
---|---|
url | URL-адрес для открытия. |
КлючЗначение
Элемент пользовательского интерфейса содержит ключ (метку) и значение (содержимое). Этот элемент также может содержать некоторые действия, такие как кнопка onclick
.
JSON-представление |
---|
{ "topLabel": string, "content": string, "contentMultiline": boolean, "bottomLabel": string, "onClick": { object ( |
Поля | |
---|---|
topLabel | Текст верхней метки. Поддерживается форматированный текст. Дополнительную информацию о форматировании текста см. в разделах «Форматирование текста в приложениях Google Chat» и «Форматирование текста в надстройках Google Workspace» . |
content | Текст контента. Форматированный текст поддерживается и всегда необходим. Дополнительную информацию о форматировании текста см. в разделах «Форматирование текста в приложениях Google Chat» и «Форматирование текста в надстройках Google Workspace» . |
contentMultiline | Если контент должен быть многострочным. |
bottomLabel | Текст нижней метки. Поддерживается форматированный текст. Дополнительную информацию о форматировании текста см. в разделах «Форматирование текста в приложениях Google Chat» и «Форматирование текста в надстройках Google Workspace» . |
onClick | Действие |
icons полей Союза. Должен быть определен хотя бы один из значков: top_label и bottom_label . icons могут быть только одним из следующих: | |
icon | Значение перечисления, которое API Chat заменяет соответствующим изображением значка. |
iconUrl | Значок, заданный URL-адресом. |
Полевой control Союза. Виджет управления. Вы можете установить либо button , либо switch_widget , но не оба сразу. control может быть только одним из следующих: | |
button | Кнопка, по которой можно нажать, чтобы вызвать действие. |
Икона
Набор поддерживаемых иконок.
Перечисления | |
---|---|
ICON_UNSPECIFIED | |
AIRPLANE | |
BOOKMARK | |
BUS | |
CAR | |
CLOCK | |
CONFIRMATION_NUMBER_ICON | |
DOLLAR | |
DESCRIPTION | |
EMAIL | |
EVENT_PERFORMER | |
EVENT_SEAT | |
FLIGHT_ARRIVAL | |
FLIGHT_DEPARTURE | |
HOTEL | |
HOTEL_ROOM_TYPE | |
INVITE | |
MAP_PIN | |
MEMBERSHIP | |
MULTIPLE_PEOPLE | |
OFFER | |
PERSON | |
PHONE | |
RESTAURANT_ICON | |
SHOPPING_CART | |
STAR | |
STORE | |
TICKET | |
TRAIN | |
VIDEO_CAMERA | |
VIDEO_PLAY |
Кнопка
Кнопка. Это может быть текстовая кнопка или кнопка изображения.
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
| |
textButton | Кнопка с текстом и действием |
imageButton | Кнопка с изображением и действием |
ТекстКнопка
Кнопка с текстом и действием onclick
.
JSON-представление |
---|
{
"text": string,
"onClick": {
object ( |
Поля | |
---|---|
text | Текст кнопки. |
onClick | Действие |
Кнопка изображения
Кнопка изображения с действием onclick
.
JSON-представление |
---|
{ "onClick": { object ( |
Поля | |
---|---|
onClick | Действие |
name | Имя этой |
icons полей Союза. Значок можно указать с помощью enum Icon или URL-адреса. icons могут быть только одним из следующих: | |
icon | Значок, заданный |
iconUrl | Значок, заданный URL-адресом. |
КартаДействие
Действие карты — это действие, связанное с картой. Для карточки счета типичным действием будет: удалить счет, отправить его по электронной почте или открыть счет в браузере.
Не поддерживается приложениями Google Chat.
JSON-представление |
---|
{
"actionLabel": string,
"onClick": {
object ( |
Поля | |
---|---|
actionLabel | Метка раньше отображалась в пункте меню действий. |
onClick | Действие onclick для этого элемента действия. |