Cards v1

Карта

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

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

object ( CardHeader )

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

sections[]

object ( Section )

Разделы разделены разделителем строк.

card Actions[]

object ( CardAction )

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

name

string

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

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

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

string

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

subtitle

string

Подзаголовок шапки карты.

image Style

enum ( ImageStyle )

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

image Url

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 могут быть только одним из следующих:
text Paragraph

object ( TextParagraph )

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

image

object ( Image )

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

key Value

object ( KeyValue )

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

ТекстАбзац

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

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

string

Изображение

Изображение, заданное URL-адресом и может иметь действие onclick .

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

string

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

on Click

object ( OnClick )

Действие onclick .

aspect Ratio

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)
    }
  ]
}
Поля
action Method Name

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.
}
Поля
top Label

string

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

content

string

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

content Multiline

boolean

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

bottom Label

string

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

on Click

object ( OnClick )

Действие onclick . Щелкать можно только по верхней метке, нижней метке и области содержимого.

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

enum ( Icon )

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

icon Url

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 может быть только одним из следующих:

text Button

object ( TextButton )

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

image Button

object ( ImageButton )

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

ТекстКнопка

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

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

string

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

on Click

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.
}
Поля
on Click

object ( OnClick )

Действие onclick .

name

string

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

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

enum ( Icon )

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

icon Url

string

Значок, заданный URL-адресом.

КартаДействие

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

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

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

string

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

on Click

object ( OnClick )

Действие onclick для этого элемента действия.