Cards v1

Карточка

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

JSON-представление 
{
  "header": {
    object (CardHeader)
  },
  "sections": [
    {
      object (Section)
    }
  ],
  "cardActions": [
    {
      object (CardAction)
    }
  ],
  "name": string
}
Поля
header

object ( CardHeader )

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

sections[]

object ( Section )

Разделы разделены линией-разделителем.

cardActions[]

object ( CardAction )

Действия этой карты.

name

string

Название карты.

Заголовок карты

JSON-представление 
{
  "title": string,
  "subtitle": string,
  "imageStyle": enum (ImageStyle),
  "imageUrl": string
}
Поля
title

string

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

subtitle

string

Подзаголовок заголовка карточки.

imageStyle

enum ( ImageStyle )

Тип изображения (например, квадратная рамка или круглая рамка).

imageUrl

string

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

СтильИзображения

Перечисления
IMAGE_STYLE_UNSPECIFIED
IMAGE Квадратная граница.
AVATAR Круглая граница.

Раздел

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

JSON-представление 
{
  "header": string,
  "widgets": [
    {
      object (WidgetMarkup)
    }
  ]
}
Поля
header

string

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

widgets[]

object ( WidgetMarkup )

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

ВиджетРазметка

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

JSON-представление 
{
  "buttons": [
    {
      object (Button)
    }
  ],

  // Union field data can be only one of the following:
  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "keyValue": {
    object (KeyValue)
  }
  // End of list of possible types for union field data.
}
Поля
buttons[]

object ( Button )

Список кнопок. Кнопки также являются oneof data , и только одно из этих полей должно быть задано.

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

object ( TextParagraph )

Отобразите текстовый абзац в этом виджете.

image

object ( Image )

Отобразить изображение в этом виджете.

keyValue

object ( KeyValue )

Отобразите элемент ключевого значения в этом виджете.

ТекстовыйАбзац

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

JSON-представление 
{
  "text": string
}
Поля
text

string

Изображение

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

JSON-представление 
{
  "imageUrl": string,
  "onClick": {
    object (OnClick)
  },
  "aspectRatio": number
}
Поля
imageUrl

string

URL-адрес изображения.

onClick

object ( OnClick )

Действие onclick .

aspectRatio

number

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

OnClick

Действие onclick (например, открытие ссылки).

JSON-представление 
{

  // Union field data can be only one of the following:
  "action": {
    object (FormAction)
  },
  "openLink": {
    object (OpenLink)
  }
  // End of list of possible types for union field data.
}
Поля

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

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

action

object ( FormAction )

Действие формы запускается этим действием onclick если оно указано.

ФормаДействие

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

JSON-представление 
{
  "actionMethodName": string,
  "parameters": [
    {
      object (ActionParameter)
    }
  ]
}
Поля
actionMethodName

string

Имя метода используется для определения того, какая часть формы инициировала отправку формы. Эта информация возвращается в приложение Chat как часть события нажатия на карточку. Вы можете использовать одно и то же имя метода для нескольких элементов, которые инициируют общее поведение.

parameters[]

object ( ActionParameter )

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

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

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

JSON-представление 
{
  "key": string,
  "value": string
}
Поля
key

string

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

value

string

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

Ключ-значение

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

JSON-представление 
{
  "topLabel": string,
  "content": string,
  "contentMultiline": boolean,
  "bottomLabel": string,
  "onClick": {
    object (OnClick)
  },

  // Union field icons can be only one of the following:
  "icon": enum (Icon),
  "iconUrl": string
  // End of list of possible types for union field icons.

  // Union field control can be only one of the following:
  "button": {
    object (Button)
  }
  // End of list of possible types for union field control.
}
Поля
topLabel

string

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

content

string

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

contentMultiline

boolean

Если содержимое должно быть многострочным.

bottomLabel

string

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

onClick

object ( OnClick )

Действие onclick . Только верхняя метка, нижняя метка и область содержимого могут быть кликабельны.

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

enum ( Icon )

Значение перечисления, которое API чата заменяет соответствующим изображением значка.

iconUrl

string

Значок, указанный в URL.

Поле объединения control . Виджет управления. Можно задать либо button , либо switch_widget , но не оба. control может быть только одним из следующих:
button

object ( 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 type can be only one of the following:
  "textButton": {
    object (TextButton)
  },
  "imageButton": {
    object (ImageButton)
  }
  // End of list of possible types for union field type.
}
Поля

type поля «Союз».

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

textButton

object ( TextButton )

Кнопка с текстом и действием onclick .

imageButton

object ( ImageButton )

Кнопка с изображением и действием onclick .

Текстовая кнопка

Кнопка с текстом и действием onclick .

JSON-представление 
{
  "text": string,
  "onClick": {
    object (OnClick)
  }
}
Поля
text

string

Текст кнопки.

onClick

object ( OnClick )

Действие кнопки onclick .

ИзображениеКнопка

Кнопка-изображение с действием onclick .

JSON-представление 
{
  "onClick": {
    object (OnClick)
  },
  "name": string,

  // Union field icons can be only one of the following:
  "icon": enum (Icon),
  "iconUrl": string
  // End of list of possible types for union field icons.
}
Поля
onClick

object ( OnClick )

Действие onclick .

name

string

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

icons полей объединения. Значок может быть указан enum Icon или URL. icons могут быть только одними из следующих:
icon

enum ( Icon )

Значок, заданный enum , которое указывает на значок, предоставленный API чата.

iconUrl

string

Значок, указанный в URL.

Действие карты

Действие карты — это действие, связанное с картой. Для карты счета-фактуры типичным действием будет: удалить счет-фактуру, отправить счет-фактуру по электронной почте или открыть счет-фактуру в браузере.

Не поддерживается приложениями Google Chat.

JSON-представление 
{
  "actionLabel": string,
  "onClick": {
    object (OnClick)
  }
}
Поля
actionLabel

string

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

onClick

object ( OnClick )

Действие по щелчку для этого элемента действия.