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

Updates the top card with a new card and preserves filled form fields values. For a non-equivalent field, the value is dropped.

For dialogs in Google Chat , opens or updates a dialog.

object ( SuggestionItem )

A list of suggestions used for autocomplete recommendations in text input fields.

string

The value of a suggested input to a text input field. This is equivalent to what users enter themselves.

integer

Specify the character limit for text input widgets. Note that this is only used for text input and is ignored for other widgets.

Available for Google Chat apps and Google Workspace add-ons.

enum ( InputType )

Specify the type of the input widgets.

Available for Google Chat apps and Google Workspace add-ons.

string

Required. The name that identifies the selection input in a form input event.

For details about working with form inputs, see Receive form data .

string

The text that appears above the selection input field in the user interface.

Specify text that helps the user enter the information your app needs. For example, if users are selecting the urgency of a work ticket from a drop-down menu, the label might be "Urgency" or "Select urgency".

enum ( SelectionType )

The type of items that are displayed to users in a SelectionInput widget. Selection types support different types of interactions. For example, users can select one or more checkboxes, but they can only select one value from a dropdown menu.

object ( SelectionItem )

An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.

object ( Action )

If specified, the form is submitted when the selection changes. If not specified, you must specify a separate button that submits the form.

For details about working with form inputs, see Receive form data .

integer

For multiselect menus, the number of text characters that a user inputs before the menu returns suggested selection items.

If unset, the multiselect menu uses the following default values:

• If the menu uses a static array of SelectionInput items, defaults to 0 characters and immediately populates items from the array.
• If the menu uses a dynamic data source ( multi_select_data_source ), defaults to 3 characters before querying the data source to return suggested items.

integer

For multiselect menus, the maximum number of items that a user can select. Minimum value is 1 item. If unspecified, defaults to 3 items.

object ( Action )

An external data source, such as a relational database.

object ( PlatformDataSource )

A data source from Google Workspace.

string

The text that identifies or describes the item to users.

string

The value associated with this item. The client should use this as a form input value.

For details about working with form inputs, see Receive form data .

boolean

Whether the item is selected by default. If the selection input only accepts one value (such as for radio buttons or a dropdown menu), only set this field for one item.

string

For multiselect menus, a text description or label that's displayed below the item's text field.

string

enum ( CommonDataSource )

A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.

object ( HostAppDataSourceMarkup )

A data source that's unique to a Google Workspace host application, such spaces in Google Chat.

This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see Install the client libraries .

object ( ChatClientDataSourceMarkup )

A data source from Google Chat.

object ( SpaceDataSource )

Google Chat spaces that the user is a member of.

boolean

If set to true , the multiselect menu selects the current Google Chat space as an item by default.

string

The name by which the DateTimePicker is identified in a form input event.

For details about working with form inputs, see Receive form data .

string

The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as Appointment date or Appointment date and time .

enum ( DateTimePickerType )

Whether the widget supports inputting a date, a time, or the date and time.

string ( int64 format)

The default value displayed in the widget, in milliseconds since Unix epoch time .

Specify the value based on the type of picker ( DateTimePickerType ):

• DATE_AND_TIME : a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use 1672574400000 .
• DATE_ONLY : a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use 1672531200000 .
• TIME_ONLY : a time in UTC. For example, to represent 12:00 PM, use 43200000 (or 12 * 60 * 60 * 1000 ).

integer

The number representing the time zone offset from UTC, in minutes. If set, the valueMsEpoch is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting.

object ( Action )

Triggered when the user clicks Save or Clear from the DateTimePicker interface.

string

The text that displays in the grid header.

object ( GridItem )

The items to display in the grid.

object ( BorderStyle )

The border style to apply to each grid item.

integer

The number of columns to display in the grid. A default value is used if this field isn't specified, and that default value is different depending on where the grid is shown (dialog versus companion).

object ( OnClick )

This callback is reused by each individual grid item, but with the item's identifier and index in the items list added to the callback's parameters.

string

A user-specified identifier for this grid item. This identifier is returned in the parent grid's onClick callback parameters.

object ( ImageComponent )

The image that displays in the grid item.

string

The grid item's title.

string

The grid item's subtitle.

enum ( GridItemLayout )

The layout to use for the grid item.

string

The image URL.

string

The accessibility label for the image.

object ( ImageCropStyle )

The crop style to apply to the image.

object ( BorderStyle )

The border style to apply to the image.

enum ( ImageCropType )

The crop type.

number

The aspect ratio to use if the crop type is RECTANGLE_CUSTOM .

For example, here's how to apply a 16:9 aspect ratio:

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

enum ( BorderType )

The border type.

object ( Color )

The colors to use when the type is BORDER_TYPE_STROKE .

To set the stroke color, specify a value for the red , green , and blue fields. The value must be a float number between 0 and 1 based on the RGB color value, where 0 (0/255) represents the absence of color and 1 (255/255) represents the maximum intensity of the color.

For example, the following sets the color to red at its maximum intensity:

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

The alpha field is unavailable for stroke color. If specified, this field is ignored.

integer

The corner radius for the border.

object ( Column )

An array of columns. You can include up to 2 columns in a card or dialog.

enum ( HorizontalSizeStyle )

Specifies how a column fills the width of the card.

enum ( HorizontalAlignment )

Specifies whether widgets align to the left, right, or center of a column.

enum ( VerticalAlignment )

Specifies whether widgets align to the top, bottom, or center of a column.

object ( Widgets )

An array of widgets included in a column. Widgets appear in the order that they are specified.

object ( TextParagraph )

TextParagraph widget.

object ( Image )

Image widget.

object ( DecoratedText )

DecoratedText widget.

object ( ButtonList )

ButtonList widget.

object ( TextInput )

TextInput widget.

object ( SelectionInput )

SelectionInput widget.

object ( DateTimePicker )

DateTimePicker widget.

object ( ChipList )

ChipList widget.

enum ( Layout )

Specified chip list layout.

object ( Chip )

An array of chips.

object ( Icon )

The icon image. If both icon and text are set, then the icon appears before the text.

string

The text displayed inside the chip.

object ( OnClick )

Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function.

boolean

Whether the chip is in an active state and responds to user actions. Defaults to true . Deprecated. Use disabled instead.

boolean

Whether the chip is in an inactive state and ignores user actions. Defaults to false .

string

The alternative text that's used for accessibility.

Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat" .

object ( CarouselCard )

A list of cards included in the carousel.

object ( NestedWidget )

A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified.

object ( NestedWidget )

A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified.

object ( TextParagraph )

A text paragraph widget.

object ( ButtonList )

A button list widget.

object ( Image )

An image widget.

enum ( HorizontalAlignment )

The horizontal alignment of the expand and collapse button.

object ( Button )

Optional. Define a customizable button to expand the section. Both expandButton and collapseButton field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used.

object ( Button )

Optional. Define a customizable button to collapse the section. Both expandButton and collapseButton field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used.

string

The label that displays as the action menu item.

object ( OnClick )

The onClick action for this action item.

object ( Button )

The primary button of the fixed footer. The button must be a text button with text and color set.

object ( Button )

The secondary button of the fixed footer. The button must be a text button with text and color set. If secondaryButton is set, you must also set primaryButton .