Эта страница переведена с помощью Cloud Translation API.

Class Grid

Организованная сетка для отображения коллекции элементов сетки.

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

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

Методы

Метод	Тип возврата	Краткое описание
`addItem(gridItem)`	`Grid`	Добавляет новый элемент сетки в сетку.
`setAuthorizationAction(action)`	`Grid`	Устанавливает действие авторизации, которое открывает URL-адрес потока авторизации при щелчке объекта.
`setBorderStyle(borderStyle)`	`Grid`	Устанавливает стиль границы, применяемый к каждому элементу сетки.
`setComposeAction(action, composedEmailType)`	`Grid`	Устанавливает действие, которое формирует черновик электронного письма при щелчке объекта.
`setNumColumns(numColumns)`	`Grid`	Количество столбцов, отображаемых в сетке.
`setOnClickAction(action)`	`Grid`	Устанавливает действие, которое выполняется при щелчке объекта.
`setOnClickOpenLinkAction(action)`	`Grid`	Устанавливает действие, которое открывает URL-адрес на вкладке при щелчке объекта.
`setOpenLink(openLink)`	`Grid`	Устанавливает URL-адрес, который будет открываться при нажатии на объект.
`setTitle(title)`	`Grid`	Устанавливает текст заголовка сетки.

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

`addItem(gridItem)`

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

Параметры

Имя	Тип	Описание
`gridItem`	`GridItem`	Добавляемый элемент сетки.

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

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`	`AuthorizationAction`	Объект, определяющий действие авторизации, которое необходимо выполнить при щелчке этого элемента.

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

Grid — этот объект для цепочки.

`setBorderStyle(borderStyle)`

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

Параметры

Имя	Тип	Описание
`borderStyle`	`BorderStyle`	Применяемый стиль границы.

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

Grid — этот объект для цепочки.

`setComposeAction(action, composedEmailType)`

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

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

Примечание . Этот метод не устанавливает действие создания , которое используется для расширения пользовательского интерфейса создания . Скорее, этот метод подключает этот элемент пользовательского интерфейса к Action , которое составляет черновики сообщений в скрипте приложений, которые открываются в 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`	Объект, определяющий действие создания, выполняемое при щелчке этого элемента.
`composedEmailType`	`ComposedEmailType`	Значение перечисления, указывающее, является ли составленный черновик автономным или черновиком ответа.

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

Grid — этот объект для цепочки.

`setNumColumns(numColumns)`

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

Параметры

Имя	Тип	Описание
`numColumns`	`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) .

Параметры

Имя	Тип	Описание
`openLink`	`OpenLink`	Объект `OpenLink` описывающий открываемый URL-адрес.

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

Grid — этот объект для цепочки.

`setTitle(title)`

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

Параметры

Имя	Тип	Описание
`title`	`String`	Текст заголовка.

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

Grid — этот объект для цепочки.