Организованная сетка для отображения коллекции элементов сетки.
Доступно для надстроек Google Workspace и приложений Google Chat.
const grid = CardService.newGrid().setTitle('My Grid').setNumColumns(2).addItem( CardService.newGridItem().setTitle('My item'));
Методы
| Метод | Тип возврата | Краткое описание | 
|---|---|---|
 add Item(gridItem) |  Grid | Добавляет новый элемент сетки в сетку. | 
 set Authorization Action(action) |  Grid | Устанавливает действие авторизации, которое открывает URL-адрес потока авторизации при щелчке объекта. | 
 set Border Style(borderStyle) |  Grid | Устанавливает стиль границы, применяемый к каждому элементу сетки. | 
 set Compose Action(action, composedEmailType) |  Grid | Устанавливает действие, которое формирует черновик электронного письма при щелчке объекта. | 
 set Num Columns(numColumns) |  Grid | Количество столбцов, отображаемых в сетке. | 
 set On Click Action(action) |  Grid | Устанавливает действие, которое выполняется при щелчке объекта. | 
 set On Click Open Link Action(action) |  Grid | Устанавливает действие, которое открывает URL-адрес на вкладке при щелчке объекта. | 
 set Open Link(openLink) |  Grid | Устанавливает URL-адрес, который будет открываться при нажатии на объект. | 
 set Title(title) |  Grid | Устанавливает текст заголовка сетки. | 
Подробная документация
 add Item(gridItem)
 set Authorization Action(action)
Устанавливает действие авторизации, которое открывает URL-адрес потока авторизации при щелчке объекта. URL-адрес откроется в новом окне. Когда пользователь завершает процесс авторизации и возвращается в приложение, надстройка перезагружается.
 Объект пользовательского интерфейса может иметь только одно из следующих значений: set Open Link(openLink) , set On Click Action(action) , set On Click Open Link Action(action) , set Authorization Action(action) или set Compose Action(action, composedEmailType) set. .
// ... const action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
Параметры
| Имя | Тип | Описание | 
|---|---|---|
 action |  Authorization Action | Объект, определяющий действие авторизации, которое необходимо выполнить при щелчке этого элемента. | 
Возвращаться
 Grid — этот объект для цепочки. 
 set Border Style(borderStyle)
Устанавливает стиль границы, применяемый к каждому элементу сетки. По умолчанию — NO_BORDER.
Параметры
| Имя | Тип | Описание | 
|---|---|---|
 border Style |  Border Style | Применяемый стиль границы. | 
Возвращаться
 Grid — этот объект для цепочки. 
 set Compose Action(action, composedEmailType)
 Устанавливает действие, которое формирует черновик электронного письма при щелчке объекта. Объект пользовательского интерфейса может иметь только одно из следующих значений: set Open Link(openLink) , set On Click Action(action) , set On Click Open Link Action(action) , set Authorization Action(action) или set Compose Action(action, composedEmailType) set. .
 Параметр Action должен указывать функцию обратного вызова, которая возвращает объект Compose Action Response настроенный с помощью Compose Action Response Builder.setGmailDraft(draft) .
// ... const action = CardService.newAction().setFunctionName('composeEmailCallback'); CardService.newTextButton() .setText('Compose Email') .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT); // ... function composeEmailCallback(e) { const thread = GmailApp.getThreadById(e.threadId); const draft = thread.createDraftReply('This is a reply'); return CardService.newComposeActionResponseBuilder() .setGmailDraft(draft) .build(); }
Параметры
| Имя | Тип | Описание | 
|---|---|---|
 action |  Action | Объект, определяющий действие создания, выполняемое при щелчке этого элемента. | 
 composed Email Type |  Composed Email Type | Значение перечисления, указывающее, является ли составленный черновик автономным или черновиком ответа. | 
Возвращаться
 Grid — этот объект для цепочки. 
 set Num Columns(numColumns)
Количество столбцов, отображаемых в сетке. Если отображается на правой боковой панели, вы можете отображать 1–2 столбца, значение по умолчанию — 1. Если отображается в диалоговом окне, вы можете отображать 2–3 столбца, значение по умолчанию — 2.
Параметры
| Имя | Тип | Описание | 
|---|---|---|
 num Columns |  Integer | Количество столбцов. | 
Возвращаться
 Grid — этот объект для цепочки. 
 set On Click Action(action)
 Устанавливает действие, которое выполняется при щелчке объекта. Объект пользовательского интерфейса может иметь только одно из следующих значений: set Open Link(openLink) , set On Click Action(action) , set On Click Open Link Action(action) , set Authorization Action(action) или set Compose Action(action, composedEmailType) set. .
 Параметр Action должен указывать функцию обратного вызова, которая возвращает объект Action Response .
// ... const action = CardService.newAction().setFunctionName('notificationCallback'); CardService.newTextButton() .setText('Create notification') .setOnClickAction(action); // ... function notificationCallback() { return CardService.newActionResponseBuilder() .setNotification( CardService.newNotification().setText('Some info to display to user'), ) .build(); }
Параметры
| Имя | Тип | Описание | 
|---|---|---|
 action |  Action | Действие, которое необходимо выполнить при щелчке по этому элементу. | 
Возвращаться
 Grid — этот объект для цепочки. 
 set On Click Open Link Action(action)
 Устанавливает действие, которое открывает URL-адрес на вкладке при щелчке объекта. Используйте эту функцию, когда URL-адрес необходимо создать или когда вам нужно выполнить другие действия помимо создания объекта Open Link . Объект пользовательского интерфейса может иметь только одно из следующих значений: set Open Link(openLink) , set On Click Action(action) , set On Click Open Link Action(action) , set Authorization Action(action) или set Compose Action(action, composedEmailType) set. .
 Параметр Action должен указывать функцию обратного вызова, которая возвращает объект Action Response , настроенный с помощью Action Response Builder.setOpenLink(openLink) .
// ... const action = CardService.newAction().setFunctionName('openLinkCallback'); CardService.newTextButton() .setText('Open Link') .setOnClickOpenLinkAction(action); // ... function openLinkCallback() { return CardService.newActionResponseBuilder() .setOpenLink(CardService.newOpenLink().setUrl('https://www.google.com')) .build(); }
Параметры
| Имя | Тип | Описание | 
|---|---|---|
 action |  Action | Объект, определяющий действие открытия ссылки, которое необходимо выполнить при щелчке по этому элементу. | 
Возвращаться
 Grid — этот объект для цепочки. 
 set Open Link(openLink)
 Устанавливает URL-адрес, который будет открываться при нажатии на объект. Используйте эту функцию, когда URL-адрес уже известен и его нужно только открыть. Объект пользовательского интерфейса может иметь только одно из следующих значений: set Open Link(openLink) , set On Click Action(action) , set On Click Open Link Action(action) , set Authorization Action(action) или set Compose Action(action, composedEmailType) set. .
Параметры
| Имя | Тип | Описание | 
|---|---|---|
 open Link |  Open Link |  Объект Open Link описывающий открываемый URL-адрес. | 
Возвращаться
 Grid — этот объект для цепочки. 
 set Title(title)
Устанавливает текст заголовка сетки. Текст должен представлять собой обычную строку без форматирования.
Параметры
| Имя | Тип | Описание | 
|---|---|---|
 title |  String | Текст заголовка. | 
Возвращаться
 Grid — этот объект для цепочки.