Class Image

Изображение

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

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

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

Методы

Метод Тип возврата Краткое описание
setAltText(altText) Image Устанавливает альтернативный текст изображения для доступности.
setAuthorizationAction(action) Image Устанавливает действие авторизации, которое открывает URL-адрес потока авторизации при щелчке объекта.
setComposeAction(action, composedEmailType) Image Устанавливает действие, которое формирует черновик электронного письма при щелчке объекта.
setImageUrl(url) Image Устанавливает изображение для использования, предоставляя его URL-адрес или строку данных.
setOnClickAction(action) Image Устанавливает действие, которое выполняется при щелчке объекта.
setOnClickOpenLinkAction(action) Image Устанавливает действие, которое открывает URL-адрес на вкладке при щелчке объекта.
setOpenLink(openLink) Image Устанавливает URL-адрес, который будет открываться при нажатии на объект.

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

setAltText(altText)

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

Параметры

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

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

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

setAuthorizationAction(action)

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

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

// ...

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

Параметры

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

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

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

setComposeAction(action, composedEmailType)

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

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

// ...

var action = CardService.newAction().setFunctionName('composeEmailCallback');
CardService.newTextButton()
    .setText('Compose Email')
    .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT);

// ...

function composeEmailCallback() {
  var thread = GmailApp.getThreadById(e.threadId);
  var draft = thread.createDraftReply('This is a reply');
  return CardService.newComposeActionResponseBuilder()
      .setGmailDraft(draft)
      .build();
}

Параметры

Имя Тип Описание
action Action Объект, определяющий действие создания, выполняемое при щелчке этого элемента.
composedEmailType ComposedEmailType Значение перечисления, указывающее, является ли составленный черновик автономным или черновиком ответа.

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

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

setImageUrl(url)

Устанавливает изображение для использования, предоставляя его URL-адрес или строку данных. Необходимый.

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

// The following assumes you have the image to use in Google Drive and have its ID.
var imageBytes = DriveApp.getFileById(imageID).getBlob().getBytes();
var 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 — этот объект для цепочки.

setOnClickAction(action)

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

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

// ...

var 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 — этот объект для цепочки.

setOnClickOpenLinkAction(action)

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

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

// ...

var 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-адрес уже известен и его нужно только открыть. Объект пользовательского интерфейса может иметь только один из наборов setOpenLink(openLink) , setOnClickAction(action) , setOnClickOpenLinkAction(action) , setAuthorizationAction(action) или setComposeAction(action, composedEmailType) .

Параметры

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

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

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