Class Grid

Сетка

Упорядоченная сетка для отображения набора элементов сетки.

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

const grid = CardService.newGrid().setTitle('My Grid').setNumColumns(2).addItem(
    CardService.newGridItem().setTitle('My item'));

Методы

Метод	Тип возвращаемого значения	Краткое описание
add Event Action(eventAction)	Widget	Добавляет действие события, которое можно выполнить с виджетом.
add Item(gridItem)	Grid	Добавляет новый элемент в сетку.
set Authorization Action(action)	Grid	Задает действие авторизации, которое открывает URL-адрес для процесса авторизации при щелчке по объекту.
set Border Style(borderStyle)	Grid	Задает стиль границы, применяемый к каждому элементу сетки.
set Compose Action(action, composedEmailType)	Grid	Задает действие, которое создает черновик электронного письма при щелчке по объекту.
set Id(id)	Widget	Задает уникальный идентификатор, используемый для идентификации виджета, подлежащего изменению.
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	Задает текст заголовка сетки.
set Visibility(visibility)	Widget	Задает видимость виджета.

Подробная документация

addEventAction(eventAction)

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

Параметры

Имя	Тип	Описание
event Action	Event Action	Необходимо добавить Event Action .

Возвращаться

Widget — Объект для создания цепочек.

---

addItem(gridItem)

Добавляет новый элемент в сетку.

Параметры

Имя	Тип	Описание
grid Item	Grid Item	Элемент сетки, который нужно добавить.

Возвращаться

Grid — Этот объект используется для создания цепочек.

---

setAuthorizationAction(action)

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

Для объекта пользовательского интерфейса может быть установлено только одно из следующих действий: setOpenLink(openLink) , setOnClickAction(action) , setOnClickOpenLinkAction(action) , setAuthorizationAction(action) или setComposeAction(action, composedEmailType) .

// ...

const action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

Параметры

Имя	Тип	Описание
action	Authorization Action	Объект, определяющий действие авторизации, которое должно быть выполнено при нажатии на этот элемент.

Возвращаться

Grid — Этот объект используется для создания цепочек.

---

setBorderStyle(borderStyle)

Задает стиль границы, применяемый к каждому элементу сетки. По умолчанию — NO_BORDER.

Параметры

Имя	Тип	Описание
border Style	Border Style	Стиль рамки, который следует применить.

Возвращаться

Grid — Этот объект используется для создания цепочек.

---

setComposeAction(action, composedEmailType)

Задает действие, которое создает черновик электронного письма при щелчке по объекту. Объект пользовательского интерфейса может иметь только одно из следующих заданий: setOpenLink(openLink) , setOnClickAction(action) , setOnClickOpenLinkAction(action) , setAuthorizationAction(action) или setComposeAction(action, composedEmailType) .

Параметр Action должен указывать функцию обратного вызова, которая возвращает объект ComposeActionResponse , настроенный с помощью ComposeActionResponseBuilder.setGmailDraft(draft) .

Примечание : Этот метод не задает действие создания сообщения , используемое для расширения пользовательского интерфейса создания сообщений . Вместо этого, этот метод связывает этот элемент пользовательского интерфейса с Action , которое создает черновики сообщений в Apps Script, открываемые в Gmail после завершения действия.

// ...

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 — Этот объект используется для создания цепочек.

---

setId(id)

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

Параметры

Имя	Тип	Описание
id	String	Идентификатор виджета, ограниченный 64 символами и в формате `[a-zA-Z0-9-]+`.

Возвращаться

Widget — этот объект используется для создания цепочек вызовов.

---

setNumColumns(numColumns)

Количество столбцов для отображения в таблице. Если отображается в правой боковой панели, можно отобразить 1-2 столбца, значение по умолчанию — 1. Если отображается в диалоговом окне, можно отобразить 2-3 столбца, значение по умолчанию — 2.

Параметры

Имя	Тип	Описание
num Columns	Integer	Количество столбцов.

Возвращаться

Grid — Этот объект используется для создания цепочек.

---

setOnClickAction(action)

Задает действие, которое выполняется при щелчке по объекту. Для объекта пользовательского интерфейса может быть установлено только одно из следующих действий setOpenLink(openLink) , setOnClickAction(action) , setOnClickOpenLinkAction(action) , setAuthorizationAction(action) или setComposeAction(action, composedEmailType) .

Параметр Action должен указывать функцию обратного вызова, которая возвращает объект ActionResponse .

// ...

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 — Этот объект используется для создания цепочек.

---

setOnClickOpenLinkAction(action)

Задает действие, которое открывает URL-адрес во вкладке при щелчке по объекту. Используйте эту функцию, когда необходимо создать URL-адрес или выполнить другие действия в дополнение к созданию объекта OpenLink . Объект пользовательского интерфейса может иметь только одно из следующих заданий: setOpenLink(openLink) , setOnClickAction(action) , setOnClickOpenLinkAction(action) , setAuthorizationAction(action) или setComposeAction(action, composedEmailType) .

Параметр Action должен указывать функцию обратного вызова, которая возвращает объект ActionResponse , настроенный с помощью ActionResponseBuilder.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 — Этот объект используется для создания цепочек.

---

setOpenLink(openLink)

Устанавливает URL-адрес, который будет открыт при щелчке по объекту. Используйте эту функцию, когда URL-адрес уже известен и его нужно только открыть. Объект пользовательского интерфейса может иметь только один из следующих параметров: setOpenLink(openLink) , setOnClickAction(action) , setOnClickOpenLinkAction(action) , setAuthorizationAction(action) или setComposeAction(action, composedEmailType) .

Параметры

Имя	Тип	Описание
open Link	Open Link	Объект Open Link , описывающий URL-адрес для открытия.

Возвращаться

Grid — Этот объект используется для создания цепочек.

---

setTitle(title)

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

Параметры

Имя	Тип	Описание
title	String	Заголовочный текст.

Возвращаться

Grid — Этот объект используется для создания цепочек.

---

setVisibility(visibility)

Задает видимость виджета. Значение по умолчанию — `VISIBLE`.

Параметры

Имя	Тип	Описание
visibility	Visibility	Visibility виджета.

Возвращаться

Widget — Объект для создания цепочек.