Карта
Карточка — это элемент пользовательского интерфейса, который может содержать такие виджеты пользовательского интерфейса, как текст и изображения.
Представление JSON |
---|
{ "header": { object ( |
Поля | |
---|---|
header | Заголовок карты. Заголовок обычно содержит заголовок и изображение. |
sections[] | Секции разделены разделителем строк. |
cardActions[] | Действия этой карты. |
name | Название карты. |
Заголовок карты
Представление JSON |
---|
{
"title": string,
"subtitle": string,
"imageStyle": enum ( |
Поля | |
---|---|
title | Должно быть указано название. Заголовок имеет фиксированную высоту: если указаны и заголовок, и подзаголовок, каждый из них занимает одну строку. Если указано только название, оно занимает обе строки. |
subtitle | Подзаголовок заголовка карточки. |
imageStyle | Тип изображения (например, квадратная рамка или круглая рамка). |
imageUrl | URL изображения в шапке карточки. |
Стиль изображения
перечисления | |
---|---|
IMAGE_STYLE_UNSPECIFIED | |
IMAGE | Квадратный бордюр. |
AVATAR | Круглая граница. |
Раздел
Раздел содержит набор виджетов, отображаемых (по вертикали) в том порядке, в котором они указаны. На всех платформах карточки имеют узкую фиксированную ширину, поэтому в настоящее время нет необходимости в свойствах макета (например, обтекание).
Представление 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
(например, открытие ссылки).
Представление JSON |
---|
{ // Union field |
Поля | |
---|---|
| |
action | Действие формы запускается этим действием |
openLink | Это действие |
ФормаДействие
Действие формы описывает поведение при отправке формы. Например, вы можете вызвать скрипт приложений для обработки формы.
Представление JSON |
---|
{
"actionMethodName": string,
"parameters": [
{
object ( |
Поля | |
---|---|
actionMethodName | Имя метода используется для определения того, какая часть формы вызвала отправку формы. Эта информация передается обратно в приложение Chat как часть события щелчка карты. Вы можете использовать одно и то же имя метода для нескольких элементов, которые вызывают общее поведение. |
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 | Значение перечисления, которое Chat API заменяет соответствующим изображением значка. |
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-адресом. |
CardAction
Действие карты — это действие, связанное с картой. Для карточки счета типичным действием будет: удалить счет, отправить счет по электронной почте или открыть счет в браузере.
Не поддерживается приложениями Google Chat.
Представление JSON |
---|
{
"actionLabel": string,
"onClick": {
object ( |
Поля | |
---|---|
actionLabel | Метка раньше отображалась в пункте меню действий. |
onClick | Действие по щелчку для этого элемента действия. |