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

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

CardHeader

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

string

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

subtitle

string

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

imageStyle

enum (ImageStyle)

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

imageUrl

string

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

ImageStyle

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

Раздел

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

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

string

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

widgets[]

object (WidgetMarkup)

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

WidgetMarkup

Виджет – это элемент интерфейса, который содержит текст и изображения.

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

  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "keyValue": {
    object (KeyValue)
  }
}
Поля
buttons[]

object (Button)

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

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

object (TextParagraph)

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

image

object (Image)

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

keyValue

object (KeyValue)

Показывать в этом виджете элемент с ключом и значением.

Конец взаимоисключающих полей.

TextParagraph

Абзац текста. Поддерживается форматированный текст. Дополнительную информацию о форматировании текста можно найти в статьях Форматирование текста в приложениях 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-представление
{

  "action": {
    object (FormAction)
  },
  "openLink": {
    object (OpenLink)
  }
}
Поля
Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
action

object (FormAction)

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

Конец взаимоисключающих полей.

FormAction

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

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

string

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

parameters[]

object (ActionParameter)

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

ActionParameter

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

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

string

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

value

string

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

KeyValue

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

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

  "icon": enum (Icon),
  "iconUrl": string

  "button": {
    object (Button)
  }
}
Поля
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. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
icon

enum (Icon)

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

iconUrl

string

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

Конец взаимоисключающих полей.
Виджет управления. Вы можете задать либо button, либо switch_widget, но не оба значения. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
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

Кнопка

Кнопка A. Это может быть текстовая кнопка или кнопка-изображение.

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

  "textButton": {
    object (TextButton)
  },
  "imageButton": {
    object (ImageButton)
  }
}
Поля
Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
textButton

object (TextButton)

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

imageButton

object (ImageButton)

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

Конец взаимоисключающих полей.

TextButton

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

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

string

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

onClick

object (OnClick)

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

ImageButton

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

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

  "icon": enum (Icon),
  "iconUrl": string
}
Поля
onClick

object (OnClick)

Действие onclick.

name

string

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

Значок можно указать с помощью Icon, enum или URL. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
icon

enum (Icon)

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

iconUrl

string

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

Конец взаимоисключающих полей.

CardAction

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

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

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

string

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

onClick

object (OnClick)

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