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

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

subtitle

string

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

imageStyle

enum ( ImageStyle )

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

imageUrl

string

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

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

перечисления
IMAGE_STYLE_UNSPECIFIED
IMAGE Квадратный бордюр.
AVATAR Круглая граница.

Раздел

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

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

string

Заголовок раздела, поддерживается текстовое форматирование.

widgets[]

object ( WidgetMarkup )

Раздел должен содержать как минимум 1 виджет.

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

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

Представление 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 )

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

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

object ( TextParagraph )

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

image

object ( Image )

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

keyValue

object ( KeyValue )

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

Текстовый Параграф

Абзац текста. Поддерживается форматированный текст.

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

string

Изображение

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

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

string

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

onClick

object ( OnClick )

Действие по клику.

aspectRatio

number

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

По щелчку

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

Представление 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 )

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

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

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

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

string

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

parameters[]

object ( ActionParameter )

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

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

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

string

Текст верхней этикетки. Поддерживается форматированный текст.

content

string

Текст содержания. Форматированный текст поддерживается и всегда требуется.

contentMultiline

boolean

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

bottomLabel

string

Текст нижней этикетки. Поддерживается форматированный текст.

onClick

object ( OnClick )

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

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

enum ( Icon )

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

iconUrl

string

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

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 )

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

imageButton

object ( ImageButton )

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

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

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

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

string

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

onClick

object ( 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 )

Действие по клику.

name

string

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

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

enum ( Icon )

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

iconUrl

string

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

CardAction

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

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

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

string

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

onClick

object ( OnClick )

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