ym88659208ym87991671
Элементы интерфейса смартапов | Документация SmartMarket
Skip to main content

Элементы интерфейса смартапов

Элементы интерфейса из массива items сообщения ANSWER_TO_USER.

Смартапы могут передавать ассистенту следующие элементы интерфейса:

  • bubble — текст;
  • card — карточка.

Ассистент отображает элементы интерфейса в порядке, в котором они расположены в массиве items.

bubble

text
string <= 250 characters

Текст, который отобразит ассистент

markdown
boolean

Указывает, что текст содержит маркдаун-разметку, которую необходимо обработать.

Если поле отсутствует, применяется значение false и текст отображается в исходном виде.

expand_policy
string
Default: "auto_expand"
Enum: "auto_expand" "force_expand" "preserve_panel_state"

Поведение шторки ассистента. Параметр актуален при работе с ассистентом на наших устройствах. Возможные значения:

  • auto_expand — шторка будет автоматически разворачиваться, если полученный текст не помещается в свернутой шторке;
  • force_expand — шторка развернётся независимо от того, помещается полученный текст в свёрнутой шторке или нет;
  • preserve_panel_state — сохраняет текущее состояние шторки независимо от длины текста.
{
  • "text": "*Привет всем*\n",
  • "markdown": true,
  • "expand_policy": "auto_expand"
}

card

Карточки помогают смартапам организовать сложную информацию на экране ассистента. Внешний вид карточек отличается в зависимости от типа смартапа (Chat App или Canvas App), а также в зависимости от типа поверхности (SberBox, SberPortal или приложение Салют).

note

Карточки недоступны в проектах SmartBot.

Карточки бывают следующих типов:

Ниже приводятся JSON-схемы карточек с примерами.

Карточки передаются в объектах card. Следующие поля присутствуют в карточках любого типа:

object (paddings)

Параметры отступов

can_be_disabled
boolean
Default: false

Указывает, что карточка может отображаться как неактивная

type
required
string

Тип карточки

Value: "gallery_card"
required
Array of media_gallery_item (object) or gallery_more_button_item (object) non-empty [ items ]

Объекты с описанием ячеек карточки. В массиве должна быть минимум одна ячейка

{
  • "paddings": {
    },
  • "can_be_disabled": false,
  • "type": "gallery_card",
  • "items": [
    ]
}

Горизонтальная галерея.

Пример отображения вертикальной галереи:

Пример отображения горизонтальной галереи:

object (paddings)

Параметры отступов

can_be_disabled
boolean
Default: false

Указывает, что карточка может отображаться как неактивная

type
required
string

Тип карточки

Value: "gallery_card"
required
Array of media_gallery_item (object) or gallery_more_button_item (object) non-empty [ items ]

Объекты с описанием ячеек карточки. В массиве должна быть минимум одна ячейка

{
  • "paddings": {
    },
  • "can_be_disabled": false,
  • "type": "gallery_card",
  • "items": [
    ]
}

list_card

Карточки с вертикальным списком ячеек.

object (paddings)

Параметры отступов

can_be_disabled
boolean
Default: false

Указывает, что карточка может отображаться как неактивная

type
required
string

Тип карточки

Value: "list_card"
Array of left_right_cell_view (object) or text_cell_view (object) or button_cell_view (object) or image_cell_view (object) or details_cell_view (object) or weather_cell_view (object)[ items ]

Массив ячеек карточки

{
  • "paddings": {
    },
  • "can_be_disabled": false,
  • "type": "list_card",
  • "cells": [
    ]
}

Примеры

Пример карточки с ячейками типа left_right_cell_view.

Примеры карточек

В разделе содержатся примеры функциональности разработанной с помощью карточек.

Получение согласия пользователей

Курсы драгоценных металлов

Подтверждение действия

Горизонтальная галерея результатов поиска

Данный пример работает только на устройствах.

Обновлено 29 июня 2022

Заметили ошибку?

Выделите текст и нажмите Ctrl + Enter, чтобы сообщить нам о ней