Class CardAction

CardAction

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

const action = CardService.newAction();
// Finish building the action...

const cardAction =
    CardService.newCardAction().setText('Card action').setOnClickAction(action);

Методы

Метод Тип возвращаемого значения Краткое описание
set Authorization Action(action) Card Action Задает действие авторизации, которое открывает URL-адрес для процесса авторизации при щелчке по объекту.
set Compose Action(action, composedEmailType) Card Action Задает действие, которое создает черновик электронного письма при щелчке по объекту.
set On Click Action(action) Card Action Задает действие, которое выполняется при щелчке по объекту.
set On Click Open Link Action(action) Card Action Задает действие, которое открывает URL-адрес во вкладке при щелчке по объекту.
set Open Link(openLink) Card Action Задает URL-адрес, который будет открыт при щелчке по объекту.
set Text(text) Card Action Задает текст меню для этого действия.

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

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

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

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


setComposeAction(action, composedEmailType)

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

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

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

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


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 Действие, которое необходимо выполнить при нажатии на этот элемент.

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

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


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 Объект, определяющий действие по открытию ссылки при щелчке по этому элементу.

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

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


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

Параметры

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

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

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


setText(text)

Задает текст меню для этого действия.

Параметры

Имя Тип Описание
text String Текст пункта меню.

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

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