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

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

string

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

string

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

object ( Widget )

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

boolean

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

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

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

integer

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

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

object ( CollapseControl )

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

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 создает сетку из двух столбцов с одним элементом:

"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 столбцов.

Чтобы включить более двух столбцов или использовать строки, используйте виджет 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 ( ChipList )

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

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

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

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

string

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

integer

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

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

string

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

Например:

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

object ( OnClick )

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

string

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

object ( Action )

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

object ( OpenLink )

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

object ( Action )

Надстройка запускает это действие, когда действию необходимо открыть ссылку. Это отличается от описанного выше openLink тем, что для получения ссылки необходимо связаться с сервером. Таким образом, веб-клиенту необходимо выполнить некоторую подготовительную работу, прежде чем вернется ответ на действие по открытию ссылки.

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

object ( Card )

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

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

object ( OverflowMenu )

Если указано, этот onClick открывает меню переполнения. Доступно для приложений Google Chat и недоступно для дополнений Google Workspace.

string

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

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

object ( ActionParameter )

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

enum ( LoadIndicator )

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

boolean

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

Если true , значения формы сохраняются после запуска действия. Чтобы позволить пользователю вносить изменения во время обработки действия, установите для LoadIndicator значение NONE . Для сообщений с карточками в приложениях чата необходимо также установить для 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

Отключена ли опция меню. По умолчанию ложь.

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 .

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

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

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

string

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

boolean

Будет ли значок отображаться заполненным. Значение по умолчанию — ложь.

Чтобы просмотреть различные настройки значков, перейдите в раздел «Значки шрифтов Google» и настройте параметры в разделе «Настроить» .

integer

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

Чтобы просмотреть различные настройки значков, перейдите в раздел «Значки шрифтов Google» и настройте параметры в разделе «Настроить» .

integer

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

Чтобы просмотреть различные настройки значков, перейдите в раздел «Значки шрифтов Google» и настройте параметры в разделе «Настроить» .

object ( Icon )

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

object ( Icon )

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

string

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

string

Необходимый. Первичный текст.

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

boolean

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

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

string

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

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 , и любое значение, установленное для этого поля, игнорируется.

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

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

Нажмите или обновите отображаемые карты.

Card

Стек карт помещает карту в стопку карт.

Card

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

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

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

integer

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

Если вы не вытекают, в меню MultiSelect используется следующие значения по умолчанию:

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

object ( Validation )

Для выпадающих меню проверку для этого поля ввода выбора.

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

object ( Action )

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

object ( PlatformDataSource )

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

string

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

string

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

Для получения подробной информации о работе с входами формы см. Данные формы приема .

boolean

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

string

Для MultiSelect Menus URL -адрес для значка, отображаемого рядом с text полем элемента. Поддерживает файлы PNG и JPEG. Должен быть HTTPS URL. Например, https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png .

string

Для MultiSelect Menus текстовое описание или этикетку, отображаемое ниже text поля элемента.

enum ( CommonDataSource )

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

object ( HostAppDataSourceMarkup )

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

Это поле поддерживает клиентские библиотеки Google API, но не доступно в библиотеках Cloud Client. Чтобы узнать больше, см. Установите клиентские библиотеки .

object ( ChatClientDataSourceMarkup )

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

object ( SpaceDataSource )

Google Chat Spaces, которым является пользователь.

boolean

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

string

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

Для получения подробной информации о работе с входами формы см. Данные формы приема .

string

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

enum ( DateTimePickerType )

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

string ( int64 format)

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

Укажите значение, основанное на типе Picker ( DateTimePickerType ):

• DATE_AND_TIME : календарный дата и время в UTC. Например, для представления 1 января 2023 года в 12:00 UTC, используйте 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 .

object ( Validation )

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

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 )

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

enum ( HorizontalSizeStyle )

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

enum ( HorizontalAlignment )

Определяет, выровняются ли виджеты влево, справа или центр столбца.

enum ( VerticalAlignment )

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

object ( Widgets )

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

object ( TextParagraph )

Виджет TextParagraph .

object ( Image )

Виджет Image .

object ( DecoratedText )

Виджет DecoratedText .

object ( ButtonList )

ButtonList Vidget.

object ( TextInput )

Виджет TextInput .

object ( SelectionInput )

SelectionInput виджет.

object ( DateTimePicker )

Виджет DateTimePicker .

object ( ChipList )

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

enum ( Layout )

Указанный макет списка чипов.

object ( Chip )

Массив чипсов.

object ( Icon )

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

string

Текст отображается внутри чипа.

object ( OnClick )

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

boolean

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

boolean

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

string

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

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

enum ( HorizontalAlignment )

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

object ( Button )

Необязательный. Определите настраиваемую кнопку для расширения раздела. Оба Expandbutton и Collapsebutton Field должно быть установлено. Только один набор поля не вступит в силу. Если это поле не установлено, используется кнопка по умолчанию.

object ( Button )

Необязательный. Определите настраиваемую кнопку, чтобы свернуть раздел. Оба Expandbutton и Collapsebutton Field должно быть установлено. Только один набор поля не вступит в силу. Если это поле не установлено, используется кнопка по умолчанию.

string

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

object ( OnClick )

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

object ( Button )

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

object ( Button )

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