Class KeyValue

Ключевое значение

Устарело. Этот класс устарел и не должен использоваться в новых сценариях.

Этот класс устарел. Вместо этого используйте Decorated Text .

Методы

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

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

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

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

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

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 Значение перечисления, указывающее, является ли составленный черновик автономным или ответным черновиком.

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

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

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

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

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

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

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

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

Устанавливает 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-адрес.

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

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

Устаревшие методы