Class Image

Изображение

Виджет, отображающий одно изображение. Сведения об обрезке изображений см. в разделе Image Crop Style .

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

const image = CardService.newImage()
                  .setAltText('A nice image')
                  .setImageUrl('https://image.png');

Методы

Метод Тип возврата Краткое описание
add Event Action(eventAction) Widget Добавляет действие события, которое можно выполнить над виджетом.
set Alt Text(altText) Image Устанавливает альтернативный текст изображения для доступности.
set Authorization Action(action) Image Устанавливает действие авторизации, которое открывает URL-адрес потока авторизации при щелчке по объекту.
set Compose Action(action, composedEmailType) Image Устанавливает действие, которое создает черновик электронного письма при щелчке по объекту.
set Id(id) Widget Задает уникальный назначенный идентификатор, который используется для идентификации виджета, подлежащего мутации.
set Image Url(url) Image Задает изображение для использования, предоставляя его URL-адрес или строку данных.
set On Click Action(action) Image Устанавливает действие, которое выполняется при щелчке по объекту.
set On Click Open Link Action(action) Image Устанавливает действие, которое открывает URL-адрес на вкладке при щелчке по объекту.
set Open Link(openLink) Image Устанавливает URL-адрес, который будет открываться при щелчке по объекту.
set Visibility(visibility) Widget Устанавливает видимость виджета.

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

add Event Action(eventAction)

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

Параметры

Имя Тип Описание
event Action Event Action Будет добавлено Event Action .

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

Widget — Объект, для объединения в цепочку.


set Alt Text(altText)

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

Параметры

Имя Тип Описание
alt Text String Альтернативный текст, который следует назначить данному изображению.

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

Image — Этот объект, для объединения в цепочку.


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) .

// ...

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

Параметры

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

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

Image — Этот объект, для объединения в цепочку.


set Compose Action(action, composedEmailType)

Задаёт действие, которое создаёт черновик электронного письма при щелчке по объекту. Для объекта пользовательского интерфейса может быть задано только одно из следующих значений: set Open Link(openLink) , set set On Click Action(action) , set On Click Open Link Action(action) , set Authorization Action(action) или set Compose Action(action, composedEmailType) .

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

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

Image — Этот объект, для объединения в цепочку.


set Id(id)

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

Параметры

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

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

Widget — объект для объединения в цепочку.


set Image Url(url)

Задаёт используемое изображение, предоставляя его URL или строку данных. Обязательно.

Предоставленный URL может быть либо общедоступным URL-адресом, либо строкой изображения в кодировке base64. Для получения последнего вы можете использовать следующий код для создания закодированной строки изображения из изображения на Google Диске, а затем сохранить эту строку для дальнейшего использования с помощью set Image Url(url) . Этот метод избавляет ваше дополнение от необходимости доступа к общедоступному URL-адресу изображения:

// The following assumes you have the image to use in Google Drive and have its
// ID.
const imageBytes = DriveApp.getFileById('123abc').getBlob().getBytes();
const encodedImageURL =
    `data:image/jpeg;base64,${Utilities.base64Encode(imageBytes)}`;

// You can store encodeImageURL and use it as a parameter to
// Image.setImageUrl(url).

Параметры

Имя Тип Описание
url String URL-адрес размещенного изображения для использования или закодированная строка изображения.

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

Image — Этот объект, для объединения в цепочку.


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) .

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

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

Image — Этот объект, для объединения в цепочку.


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) .

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

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

Image — Этот объект, для объединения в цепочку.


Задаёт 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) .

Параметры

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

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

Image — Этот объект, для объединения в цепочку.


set Visibility(visibility)

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

Параметры

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

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

Widget — Объект, для объединения в цепочку.