Cards v2

object ( CardHeader )

Заголовок карточки. Заголовок обычно содержит начальное изображение и название. Заголовки всегда располагаются в верхней части карточки.

object ( Section )

Содержит набор виджетов. Каждый раздел имеет собственный заголовок (необязательно). Разделы визуально разделены линией-разделителем. Пример в приложениях Google Chat см. в разделе «Определение раздела карточки» .

enum ( DividerStyle )

Стиль разделителя между заголовком, разделами и нижним колонтитулом.

object ( CardAction )

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

Доступно для дополнений Google Workspace и недоступно для приложений Google Chat.

Например, следующий JSON-код создает меню действий карточки с параметрами Settings и Send Feedback :

"cardActions": [
  {
    "actionLabel": "Settings",
    "onClick": {
      "action": {
        "functionName": "goToView",
        "parameters": [
          {
            "key": "viewType",
            "value": "SETTING"
         }
        ],
        "loadIndicator": "LoadIndicator.SPINNER"
      }
    }
  },
  {
    "actionLabel": "Send Feedback",
    "onClick": {
      "openLink": {
        "url": "https://example.com/feedback"
      }
    }
  }
]

string

Название карты. Используется как идентификатор карты при навигации по ней.

Доступно для дополнений Google Workspace и недоступно для приложений Google Chat.

object ( CardFixedFooter )

Фиксированный нижний колонтитул, показанный внизу этой карточки.

Установка fixedFooter без указания primaryButton или secondaryButton приводит к ошибке. В приложениях чата можно использовать фиксированные колонтитулы в диалоговых окнах , но не в сообщениях карточек .

Доступно для приложений Google Chat и дополнений Google Workspace.

enum ( DisplayStyle )

В надстройках Google Workspace задает свойства отображения peekCardHeader .

Доступно для дополнений Google Workspace и недоступно для приложений Google Chat.

object ( CardHeader )

При отображении контекстного контента заголовок всплывающей карточки действует как заполнители, позволяя пользователю перемещаться между карточками домашней страницы и контекстными карточками.

Доступно для дополнений Google Workspace и недоступно для приложений Google Chat.

string

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

string

Подзаголовок заголовка карточки. Если указан, отображается на отдельной строке под title .

enum ( ImageType )

Форма, используемая для обрезки изображения.

Доступно для приложений Google Chat и дополнений Google Workspace.

string

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

string

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

string

Текст, отображаемый в верхней части раздела. Поддерживает простой текст в формате HTML. Подробнее о форматировании текста см. в разделах Форматирование текста в приложениях Google Chat и Форматирование текста в расширениях Google Workspace .

object ( Widget )

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

boolean

Указывает, является ли этот раздел сворачиваемым.

Сворачиваемые разделы скрывают некоторые или все виджеты, но пользователи могут развернуть раздел, чтобы отобразить скрытые виджеты, нажав «Показать больше» . Пользователи могут снова скрыть виджеты, нажав «Показать меньше» .

Чтобы определить, какие виджеты скрыты, укажите uncollapsibleWidgetsCount .

integer

Количество несворачиваемых виджетов, которые остаются видимыми даже при свертывании раздела.

Например, если раздел содержит пять виджетов, а значение uncollapsibleWidgetsCount равно 2 , первые два виджета всегда отображаются, а последние три — свёрнуты по умолчанию. Значение uncollapsibleWidgetsCount учитывается только в том случае, если collapsible равно true .

object ( CollapseControl )

Необязательно. Задайте кнопку развёртывания и свёртывания раздела. Эта кнопка будет отображаться только если раздел можно свернуть. Если это поле не задано, будет использоваться кнопка по умолчанию.

enum ( HorizontalAlignment )

Указывает, выравниваются ли виджеты по левому краю, правому краю или центру столбца.

object ( TextParagraph )

Отображает текстовый абзац. Поддерживает простой текст в формате HTML. Подробнее о форматировании текста см. в разделах Форматирование текста в приложениях Google Chat и Форматирование текста в расширениях Google Workspace .

Например, следующий JSON-код создает полужирный текст:

"textParagraph": {
  "text": "  <b>bold text</b>"
}

object ( Image )

Отображает изображение.

Например, следующий JSON создает изображение с альтернативным текстом:

"image": {
  "imageUrl":
  "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
  "altText": "Chat app avatar"
}

object ( DecoratedText )

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

Например, следующий JSON-код создает декорированный текстовый виджет, отображающий адрес электронной почты:

"decoratedText": {
  "icon": {
    "knownIcon": "EMAIL"
  },
  "topLabel": "Email Address",
  "text": "sasha@example.com",
  "bottomLabel": "This is a new Email address!",
  "switchControl": {
    "name": "has_send_welcome_email_to_sasha",
    "selected": false,
    "controlType": "CHECKBOX"
  }
}

object ( ButtonList )

Список кнопок.

Например, следующий JSON-код создаёт две кнопки. Первая — синяя текстовая кнопка, а вторая — кнопка-изображение, открывающая ссылку:

"buttonList": {
  "buttons": [
    {
      "text": "Edit",
      "color": {
        "red": 0,
        "green": 0,
        "blue": 1,
      },
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}

object ( TextInput )

Отображает текстовое поле, в котором пользователи могут вводить текст.

Например, следующий JSON-код создает текстовое поле для адреса электронной почты:

"textInput": {
  "name": "mailing_address",
  "label": "Mailing Address"
}

В качестве другого примера, следующий JSON создает текстовое поле ввода для языка программирования со статическими предложениями:

"textInput": {
  "name": "preferred_programing_language",
  "label": "Preferred Language",
  "initialSuggestions": {
    "items": [
      {
        "text": "C++"
      },
      {
        "text": "Java"
      },
      {
        "text": "JavaScript"
      },
      {
        "text": "Python"
      }
    ]
  }
}

object ( SelectionInput )

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

Например, следующий код JSON создает раскрывающееся меню, позволяющее пользователям выбрать размер:

"selectionInput": {
  "name": "size",
  "label": "Size"
  "type": "DROPDOWN",
  "items": [
    {
      "text": "S",
      "value": "small",
      "selected": false
    },
    {
      "text": "M",
      "value": "medium",
      "selected": true
    },
    {
      "text": "L",
      "value": "large",
      "selected": false
    },
    {
      "text": "XL",
      "value": "extra_large",
      "selected": false
    }
  ]
}

object ( DateTimePicker )

Отображает виджет, позволяющий пользователям вводить дату, время или дату и время.

Например, следующий JSON-код создает выбор даты и времени для планирования встречи:

"dateTimePicker": {
  "name": "appointment_time",
  "label": "Book your appointment at:",
  "type": "DATE_AND_TIME",
  "valueMsEpoch": 796435200000
}

object ( Divider )

Отображает горизонтальную линию-разделитель между виджетами.

Например, следующий JSON-код создает разделитель:

"divider": {
}

object ( Grid )

Отображает сетку с коллекцией элементов.

Сетка поддерживает любое количество столбцов и элементов. Количество строк определяется верхней границей числа элементов, делённой на количество столбцов. Сетка с 10 элементами и 2 столбцами имеет 5 строк. Сетка с 11 элементами и 2 столбцами имеет 6 строк.

Доступно для приложений Google Chat и дополнений Google Workspace.

Например, следующий JSON-код создает сетку из 2 столбцов с одним элементом:

"grid": {
  "title": "A fine collection of items",
  "columnCount": 2,
  "borderStyle": {
    "type": "STROKE",
    "cornerRadius": 4
  },
  "items": [
    {
      "image": {
        "imageUri": "https://www.example.com/image.png",
        "cropStyle": {
          "type": "SQUARE"
        },
        "borderStyle": {
          "type": "STROKE"
        }
      },
      "title": "An item",
      "textAlignment": "CENTER"
    }
  ],
  "onClick": {
    "openLink": {
      "url": "https://www.example.com"
    }
  }
}

object ( Columns )

Отображает до 2 столбцов.

Чтобы включить более 2 столбцов или использовать строки, используйте виджет Grid .

Например, следующий JSON создает 2 столбца, каждый из которых содержит текстовые абзацы:

"columns": {
  "columnItems": [
    {
      "horizontalSizeStyle": "FILL_AVAILABLE_SPACE",
      "horizontalAlignment": "CENTER",
      "verticalAlignment": "CENTER",
      "widgets": [
        {
          "textParagraph": {
            "text": "First column text paragraph"
          }
        }
      ]
    },
    {
      "horizontalSizeStyle": "FILL_AVAILABLE_SPACE",
      "horizontalAlignment": "CENTER",
      "verticalAlignment": "CENTER",
      "widgets": [
        {
          "textParagraph": {
            "text": "Second column text paragraph"
          }
        }
      ]
    }
  ]
}

object ( Carousel )

Карусель содержит набор вложенных виджетов. Например, это JSON-представление карусели, содержащей два текстовых абзаца.

{
  "widgets": [
    {
      "textParagraph": {
        "text": "First text paragraph in the carousel."
      }
    },
    {
      "textParagraph": {
        "text": "Second text paragraph in the carousel."
      }
    }
  ]
}

object ( ChipList )

Список фишек.

Например, следующий JSON-код создаёт два чипа. Первый — текстовый, а второй — значок, открывающий ссылку:

"chipList": {
  "chips": [
    {
      "text": "Edit",
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}

string

Текст, отображаемый в виджете.

integer

Максимальное количество строк текста, отображаемых в виджете. Если длина текста превышает указанное максимальное количество строк, лишний текст скрывается за кнопкой «Показать больше» . Если длина текста равна или короче указанного максимального количества строк, кнопка «Показать больше» не отображается.

Значение по умолчанию — 0, в этом случае отображается весь контекст. Отрицательные значения игнорируются.

enum ( TextSyntax )

Синтаксис текста. Если не задан, текст отображается как HTML.

Доступно для приложений Google Chat и недоступно для дополнений Google Workspace.

string

HTTPS-URL, на котором размещено изображение.

Например:

https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png

object ( OnClick )

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

string

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

object ( Action )

Если указано, действие запускается этим onClick .

object ( OpenLink )

Если указано, этот onClick инициирует действие открытия ссылки.

object ( Action )

Дополнение активирует это действие, когда ему требуется открыть ссылку. Оно отличается от описанного выше действия openLink тем, что для получения ссылки требуется обращение к серверу. Таким образом, веб-клиенту требуется определённая подготовительная работа, прежде чем будет получен ответ на действие open link.

Доступно для дополнений Google Workspace и недоступно для приложений Google Chat.

object ( Card )

Если указано, после щелчка новая карта помещается в стопку карт.

Доступно для дополнений Google Workspace и недоступно для приложений Google Chat.

object ( OverflowMenu )

Если указано, onClick открывает дополнительное меню.

string

Пользовательская функция, вызываемая при щелчке по содержащему элементу или его активации.

Пример использования см. в разделе Чтение данных формы .

object ( ActionParameter )

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

enum ( LoadIndicator )

Указывает индикатор загрузки, который действие отображает при вызове действия.

boolean

Указывает, сохраняются ли значения формы после действия. Значение по умолчанию — false .

Если true , значения формы сохраняются после выполнения действия. Чтобы пользователь мог вносить изменения во время обработки действия, установите для LoadIndicator значение NONE . ​​Для сообщений с карточками в приложениях Chat необходимо также установить ResponseType действия значение UPDATE_MESSAGE и использовать тот же cardId из карточки, содержащей действие.

Если false , значения формы очищаются при выполнении действия. Чтобы запретить пользователю вносить изменения во время выполнения действия, установите для LoadIndicator SPINNER .

enum ( Interaction )

Необязательно. Требуется при открытии диалогового окна .

Что делать в ответ на взаимодействие с пользователем, например, нажатие пользователем кнопки в сообщении карточки.

Если не указано иное, приложение реагирует, выполняя action (например, открытие ссылки или запуск функции) как обычно.

Указав interaction , приложение может реагировать особыми интерактивными способами. Например, если задать interaction как OPEN_DIALOG , приложение может открыть диалог . Если это указано, индикатор загрузки не отображается. Если указано для дополнения, вся карточка удаляется, и в клиенте ничего не отображается.

Доступно для приложений Google Chat и недоступно для дополнений Google Workspace.

string

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

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

Доступно для приложений Google Chat и дополнений Google Workspace.

boolean

Необязательно. Если это так, то все виджеты считаются обязательными для этого действия.

Доступно для приложений Google Chat и дополнений Google Workspace.

string

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

string

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

string

URL-адрес для открытия.

enum ( OpenAs )

Как открыть ссылку.

Доступно для дополнений Google Workspace и недоступно для приложений Google Chat.

enum ( OnClose )

Забывает ли клиент о ссылке после ее открытия или наблюдает за ней до тех пор, пока окно не закроется.

Доступно для дополнений Google Workspace и недоступно для приложений Google Chat.

object ( OverflowMenuItem )

Обязательно. Список пунктов меню.

object ( Icon )

Значок, отображаемый перед текстом.

string

Обязательно. Текст, который идентифицирует или описывает элемент для пользователей.

object ( OnClick )

Обязательно. Действие, вызываемое при выборе пункта меню. Этот OnClick не может содержать OverflowMenu , любой указанный OverflowMenu удаляется, а пункт меню отключается.

boolean

Отключён ли пункт меню. По умолчанию — false.

string

Необязательно. Описание значка, используемого для обеспечения доступности. Если не указано иное, предоставляется значение по умолчанию Button . Рекомендуется задать понятное описание того, что отображает значок, и, если применимо, его функции. Например, A user's account portrait или « Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat .

Если значок установлен в Button , altText отображается как вспомогательный текст при наведении курсора на кнопку. Однако, если кнопка также устанавливает text , altText значка игнорируется.

enum ( ImageType )

Стиль кадрирования, применённый к изображению. В некоторых случаях применение обрезки CIRCLE приводит к тому, что изображение становится больше встроенного значка.

string

Отобразите один из встроенных значков, предоставляемых Google Workspace.

Например, чтобы отобразить значок самолёта, укажите AIRPLANE . Для автобуса укажите BUS .

Полный список поддерживаемых значков смотрите в разделе встроенные значки .

string

Отображение пользовательского значка, размещенного по URL-адресу HTTPS.

Например:

"iconUrl":
"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png"

Поддерживаемые типы файлов включают .png и .jpg .

object ( MaterialIcon )

Отобразите один из значков Google Material .

Например, чтобы отобразить значок флажка , используйте

"materialIcon": {
  "name": "check_box"
}

Доступно для приложений Google Chat и недоступно для дополнений Google Workspace.

string

Имя значка, заданное в Google Material Icon , например, check_box . Любые недопустимые имена отбрасываются и заменяются пустой строкой, что приводит к невозможности отображения значка.

boolean

Отображается ли значок как заполненный. Значение по умолчанию — false.

Для предварительного просмотра различных настроек значков перейдите в раздел «Значки шрифтов Google» и измените параметры в разделе «Настройка» .

integer

Толщина штриха значка. Выберите из {100, 200, 300, 400, 500, 600, 700}. Если значение отсутствует, по умолчанию используется значение 400. Если указано другое значение, используется значение по умолчанию.

Для предварительного просмотра различных настроек значков перейдите в раздел «Значки шрифтов Google» и измените параметры в разделе «Настройка» .

integer

Насыщенность и насыщенность влияют на толщину символа. Корректировка насыщенности более точна, чем корректировка насыщенности, и оказывает незначительное влияние на размер символа. Доступны значения {-25, 0, 200}. Если значение отсутствует, по умолчанию используется 0. Если указано другое значение, используется значение по умолчанию.

Для предварительного просмотра различных настроек значков перейдите в раздел «Значки шрифтов Google» и измените параметры в разделе «Настройка» .

object ( Icon )

Устарело в пользу startIcon .

object ( Icon )

Значок, отображаемый перед текстом.

enum ( VerticalAlignment )

Необязательно. Вертикальное выравнивание значка «Пуск». Если не задано, значок будет выровнен по центру.

Доступно для приложений Google Chat и недоступно для дополнений Google Workspace.

string

Текст, отображаемый над text . Всегда обрезается.

object ( TextParagraph )

TextParagraph эквивалентен topLabel . Всегда обрезает. Позволяет реализовать более сложное форматирование, чем topLabel .

Доступно для приложений Google Chat и недоступно для дополнений Google Workspace.

string

Обязательно. Основной текст.

Поддерживает простое форматирование. Подробнее о форматировании текста см. в разделах Форматирование текста в приложениях Google Chat и Форматирование текста в расширениях Google Workspace .

object ( TextParagraph )

TextParagraph эквивалентен text . Позволяет использовать более сложное форматирование, чем text .

Доступно для приложений Google Chat и недоступно для дополнений Google Workspace.

boolean

Настройка переноса текста. Если true , текст переносится и отображается на нескольких строках. В противном случае текст обрезается.

Применяется только к text , но не к topLabel и bottomLabel .

string

Текст, отображаемый под text . Всегда переносится.

object ( TextParagraph )

TextParagraph эквивалентно bottomLabel . Всегда переносится. Позволяет реализовать более сложное форматирование, чем bottomLabel .

Доступно для приложений Google Chat и недоступно для дополнений Google Workspace.

object ( OnClick )

Это действие запускается, когда пользователи нажимают topLabel или bottomLabel .

object ( Button )

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

object ( SwitchControl )

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

object ( Icon )

Значок, отображаемый после текста.

Поддерживает встроенные и пользовательские значки.

string

Текст, отображаемый внутри кнопки.

object ( Icon )

Значок, отображаемый внутри кнопки. Если заданы и icon , и text , то значок отображается перед текстом.

object ( Color )

Необязательный. Цвет кнопки. Если задано, type кнопки — FILLED , а цвет text полей и icon — контрастный для удобства чтения. Например, если цвет кнопки синий, любой текст и значки на кнопке будут белыми.

Чтобы задать цвет кнопки, укажите значения для полей red , green » и blue . Значение должно быть числом с плавающей точкой в ​​диапазоне от 0 до 1 в зависимости от значения цвета в системе RGB, где 0 (0/255) соответствует отсутствию цвета, а 1 (255/255) — максимальной интенсивности цвета.

Например, следующий код устанавливает красный цвет с максимальной интенсивностью:

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
}

Поле alpha недоступно для цвета кнопки. Если указано, это поле игнорируется.

object ( OnClick )

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

boolean

Если true , кнопка отображается в неактивном состоянии и не реагирует на действия пользователя.

string

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

Добавьте описательный текст, который даст пользователям понять, что делает кнопка. Например, если кнопка открывает гиперссылку, можно написать: «Открывает новую вкладку браузера и перенаправляет к документации разработчика Google Chat по адресу https://developers.google.com/workspace/chat» .

enum ( Type )

Необязательный. Тип кнопки. Если не задано, тип кнопки по умолчанию — OUTLINED . Если задано поле color , тип кнопки принудительно устанавливается на FILLED , и любое заданное для этого поля значение игнорируется.

number

Количество красного в цвете как значение в интервале [0, 1].

number

Количество зеленого цвета в цвете как значение в интервале [0, 1].

number

Количество синего в цвете как значение в интервале [0, 1].

number

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

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

Это означает, что значение 1,0 соответствует сплошному цвету, тогда как значение 0,0 соответствует полностью прозрачному цвету. В этом случае используется сообщение-обёртка, а не простой скаляр с плавающей точкой, что позволяет различать значение по умолчанию и значение, которое не задано. Если этот параметр опущен, этот цветовой объект отображается как сплошной цвет (как если бы альфа-значению было явно присвоено значение 1,0).

string

Имя, по которому виджет-переключатель идентифицируется в событии ввода формы.

Подробную информацию о работе с данными формы см. в разделе Получение данных формы .

string

Значение, введенное пользователем, возвращается как часть события ввода формы.

Подробную информацию о работе с данными формы см. в разделе Получение данных формы .

boolean

Если true , переключатель выбран.

object ( Action )

Действие, которое следует выполнить при изменении состояния переключателя, например, какую функцию следует запустить.

enum ( ControlType )

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

Доступно для приложений Google Chat и дополнений Google Workspace.

object ( Button )

Массив кнопок.

string

Имя, по которому текстовый ввод идентифицируется в событии ввода формы.

Подробную информацию о работе с данными формы см. в разделе Получение данных формы .

string

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

Укажите текст, который поможет пользователю ввести информацию, необходимую вашему приложению. Например, если вы спрашиваете чьё-то имя, но вам нужна именно фамилия, напишите surname вместо name .

Обязательно, если hintText не указан. В противном случае — необязательно.

string

Текст, отображаемый под полем ввода текста, призван помочь пользователю ввести определённое значение. Этот текст виден всегда.

Обязательно, если label не указана. В противном случае — необязательно.

string

Значение, введенное пользователем, возвращается как часть события ввода формы.

Подробную информацию о работе с данными формы см. в разделе Получение данных формы .

enum ( Type )

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

object ( Action )

Что делать, если в поле ввода текста произошло изменение. Например, пользователь добавил текст в поле или удалил его.

Примеры действий, которые можно выполнить, включают запуск пользовательской функции или открытие диалога в Google Chat.

object ( Suggestions )

Предлагаемые значения, которые могут ввести пользователи. Эти значения появляются при щелчке внутри поля ввода текста. По мере ввода текста предлагаемые значения динамически фильтруются в соответствии с введенным пользователем текстом.

Например, поле ввода текста для языка программирования может предлагать Java, JavaScript, Python и C++. Когда пользователи начинают вводить Jav , список предложений фильтруется, отображая только Java и JavaScript .

Предлагаемые значения помогают пользователям вводить значения, понятные вашему приложению. При использовании JavaScript одни пользователи могут вводить javascript , а другие java script . Предлагаемые JavaScript могут стандартизировать взаимодействие пользователей с вашим приложением.

Если указано, TextInput.type всегда имеет SINGLE_LINE , даже если задано значение MULTIPLE_LINE .

Доступно для приложений Google Chat и дополнений Google Workspace.

object ( Action )

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

Если не указано иное, предложения задаются initialSuggestions и обрабатываются клиентом.

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

Доступно для дополнений Google Workspace и недоступно для приложений Google Chat.

object ( Validation )

Укажите проверку формата ввода, необходимую для этого текстового поля.

Доступно для приложений Google Chat и дополнений Google Workspace.

string

Текст, который отображается в поле ввода, когда оно пустое. Используйте этот текст, чтобы предложить пользователям ввести значение. Например, Enter a number from 0 to 100 .

Доступно для приложений Google Chat и недоступно для дополнений Google Workspace.

Action

Navigation

Вставляет, выталкивает или обновляет карту.

Дополнения в Google Chat .

Card

Кладет карту в стопку карт.

Для диалогов в Google Chat открывает или обновляет диалог.

Card

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

Для диалогов в Google Chat открывает или обновляет диалог.

object ( SuggestionItem )

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

string

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

integer

Укажите ограничение на количество символов для виджетов ввода текста. Обратите внимание, что это используется только для ввода текста и игнорируется для других виджетов.

Доступно для приложений Google Chat и дополнений Google Workspace.

enum ( InputType )

Укажите тип входных виджетов.

Доступно для приложений Google Chat и дополнений Google Workspace.

string

Обязательно. Имя, которое идентифицирует ввод выбора в событии ввода формы.

Подробные сведения о работе с входными данными формы см. в разделе Получение данных формы .

string

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

Укажите текст, который поможет пользователю ввести информацию, необходимую вашему приложению. Например, если пользователи выбирают срочность рабочего билета из раскрывающегося меню, метка может быть «Срочность» или «Выбрать срочность».

enum ( SelectionType )

Тип элементов, которые отображаются пользователям в виджете SelectionInput . Типы выбора поддерживают различные типы взаимодействий. Например, пользователи могут установить один или несколько флажков, но выбрать только одно значение из раскрывающегося меню.

object ( SelectionItem )

Массив выбираемых элементов. Например, массив переключателей или флажков. Поддерживает до 100 элементов.

object ( Action )

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

Подробные сведения о работе с входными данными формы см. в разделе Получение данных формы .

integer

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

Если этот параметр не установлен, в меню множественного выбора используются следующие значения по умолчанию:

• Если в меню используется статический массив элементов SelectionInput , по умолчанию используется 0 символов и немедленно заполняются элементы из массива.
• Если в меню используется динамический источник данных ( multi_select_data_source ), по умолчанию используется 3 символа перед запросом источника данных для возврата предлагаемых элементов.

integer

Для меню с множественным выбором — максимальное количество элементов, которые может выбрать пользователь. Минимальная стоимость — 1 шт. Если не указано, по умолчанию используется 3 элемента.

object ( Action )

Внешний источник данных, например реляционная база данных.

object ( PlatformDataSource )

Источник данных из Google Workspace.

string

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

string

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

Подробные сведения о работе с входными данными формы см. в разделе Получение данных формы .

boolean

Выбран ли элемент по умолчанию. Если входные данные выбора принимают только одно значение (например, для переключателей или раскрывающегося меню), установите это поле только для одного элемента.

string

Для меню с множественным выбором — текстовое описание или метка, отображаемая под text полем элемента.

string

enum ( CommonDataSource )

Источник данных, общий для всех приложений Google Workspace, например пользователей в организации Google Workspace.

object ( HostAppDataSourceMarkup )

Источник данных, уникальный для хост-приложения Google Workspace, например пространства в Google Chat.

Это поле поддерживает клиентские библиотеки Google API, но недоступно в облачных клиентских библиотеках. Дополнительные сведения см. в разделе Установка клиентских библиотек .

object ( ChatClientDataSourceMarkup )

Источник данных из Google Chat.

object ( SpaceDataSource )

Пространства Google Chat, участником которых является пользователь.

boolean

Если установлено значение true , меню множественного выбора выбирает текущее пространство Google Chat в качестве элемента по умолчанию.

string

Имя, по которому DateTimePicker идентифицируется в событии ввода формы.

Подробные сведения о работе с входными данными формы см. в разделе Получение данных формы .

string

Текст, предлагающий пользователям ввести дату, время или дату и время. Например, если пользователи планируют встречу, используйте метку, например Appointment date или Appointment date and time .

enum ( DateTimePickerType )

Поддерживает ли виджет ввод даты, времени или даты и времени.

string ( int64 format)

Значение по умолчанию, отображаемое в виджете, в миллисекундах с момента эпохи Unix .

Укажите значение в зависимости от типа средства выбора ( DateTimePickerType ):

• DATE_AND_TIME : календарная дата и время в формате UTC. Например, чтобы представить 1 января 2023 года в 12:00 по всемирному координированному времени, используйте 1672574400000 .
• DATE_ONLY : календарная дата в 00:00:00 UTC. Например, чтобы представить 1 января 2023 года, используйте 1672531200000 .
• TIME_ONLY : время в формате UTC. Например, чтобы представить 12:00, используйте 43200000 (или 12 * 60 * 60 * 1000 ).

integer

Число, представляющее смещение часового пояса от UTC в минутах. Если установлено, valueMsEpoch отображается в указанном часовом поясе. Если этот параметр не установлен, значение по умолчанию соответствует настройке часового пояса пользователя.

object ( Action )

Срабатывает, когда пользователь нажимает кнопку «Сохранить» или «Очистить» в интерфейсе DateTimePicker .

string

Текст, который отображается в заголовке сетки.

object ( GridItem )

Элементы, отображаемые в сетке.

object ( BorderStyle )

Стиль границы, применяемый к каждому элементу сетки.

integer

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

object ( OnClick )

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

string

Заданный пользователем идентификатор для этого элемента сетки. Этот идентификатор возвращается в параметрах обратного вызова onClick родительской сетки.

object ( ImageComponent )

Изображение, которое отображается в элементе сетки.

string

Название элемента сетки.

string

Подзаголовок элемента сетки.

enum ( GridItemLayout )

Макет, используемый для элемента сетки.

string

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

string

Метка доступности изображения.

object ( ImageCropStyle )

Стиль обрезки, применяемый к изображению.

object ( BorderStyle )

Стиль границы, применяемый к изображению.

enum ( ImageCropType )

Тип урожая.

number

Соотношение сторон, которое будет использоваться, если тип кадрирования — RECTANGLE_CUSTOM .

Например, вот как применить соотношение сторон 16:9:

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 16/9
}

enum ( BorderType )

Тип границы.

object ( Color )

Цвета, которые будут использоваться, если тип BORDER_TYPE_STROKE .

Чтобы задать цвет обводки, укажите значение для полей red , green и blue . Значение должно быть числом с плавающей запятой от 0 до 1, основанным на значении цвета RGB, где 0 (0/255) представляет отсутствие цвета, а 1 (255/255) представляет максимальную интенсивность цвета.

Например, следующий код устанавливает красный цвет с максимальной интенсивностью:

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
}

Поле alpha недоступно для цвета обводки. Если указано, это поле игнорируется.

integer

Угловой радиус границы.

object ( Column )

Массив столбцов. Вы можете включить до двух столбцов в карточку или диалог.

enum ( HorizontalSizeStyle )

Указывает, как столбец заполняет ширину карточки.

enum ( HorizontalAlignment )

Указывает, выравниваются ли виджеты по левому, правому или центру столбца.

enum ( VerticalAlignment )

Указывает, выравниваются ли виджеты по верху, низу или центру столбца.

object ( Widgets )

Массив виджетов, включенных в столбец. Виджеты отображаются в том порядке, в котором они указаны.

object ( TextParagraph )

Виджет TextParagraph .

object ( Image )

Виджет Image .

object ( DecoratedText )

Виджет DecoratedText .

object ( ButtonList )

Виджет ButtonList .

object ( TextInput )

Виджет TextInput .

object ( SelectionInput )

Виджет SelectionInput .

object ( DateTimePicker )

Виджет DateTimePicker .

object ( ChipList )

Виджет ChipList .

enum ( Layout )

Указанный макет списка микросхем.

object ( Chip )

Массив фишек.

object ( Icon )

Изображение значка. Если установлены и icon , и text , то значок появляется перед текстом.

string

Текст, отображаемый внутри чипа.

object ( OnClick )

Необязательно. Действие, которое необходимо выполнить, когда пользователь щелкает чип, например открытие гиперссылки или запуск пользовательской функции.

boolean

Находится ли чип в активном состоянии и реагирует ли на действия пользователя. По умолчанию true . Устарело. Вместо этого используйте disabled .

boolean

Находится ли чип в неактивном состоянии и игнорирует действия пользователя. По умолчанию установлено значение false .

string

Альтернативный текст, используемый для специальных возможностей.

Установите описательный текст, который позволит пользователям узнать, что делает чип. Например, если чип открывает гиперссылку, напишите: «Открывает новую вкладку браузера и переходит к документации для разработчиков Google Chat по адресу https://developers.google.com/workspace/chat» .

object ( CarouselCard )

Список карточек в карусели.

object ( NestedWidget )

Список виджетов, отображаемых в карточке карусели. Виджеты отображаются в том порядке, в котором они указаны.

object ( NestedWidget )

Список виджетов отображается внизу карточки карусели. Виджеты отображаются в том порядке, в котором они указаны.

object ( TextParagraph )

Виджет текстового абзаца.

object ( ButtonList )

Виджет списка кнопок.

object ( Image )

Виджет изображения.

enum ( HorizontalAlignment )

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

object ( Button )

Необязательно. Определите настраиваемую кнопку, чтобы развернуть раздел. Поле «expandButton» и «CrollButton» должно быть установлено. Только один набор полей не вступит в силу. Если это поле не задано, используется кнопка по умолчанию.

object ( Button )

Необязательно. Определите настраиваемую кнопку, чтобы свернуть раздел. Поле «expandButton» и «CrollButton» должно быть установлено. Только один набор полей не вступит в силу. Если это поле не задано, используется кнопка по умолчанию.

string

Метка, которая отображается как элемент меню действий.

object ( OnClick )

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

object ( Button )

Основная кнопка фиксированного нижнего колонтитула. Кнопка должна быть текстовой с заданным текстом и цветом.

object ( Button )

Вторичная кнопка фиксированного нижнего колонтитула. Кнопка должна быть текстовой с заданным текстом и цветом. Если установлен secondaryButton , вы также должны установить primaryButton .