此页面由 Cloud Translation API 翻译。

Class Image

用于显示单张图片的微件。如需了解如何剪裁图片，请参阅 ImageCropStyle。

适用于 Google Workspace 插件和 Google Chat 应用。

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

方法

方法	返回类型	简介
`setAltText(altText)`	`Image`	设置图片的替代文本，以便提供无障碍功能。
`setAuthorizationAction(action)`	`Image`	设置授权操作，以便在用户点击相应对象时打开指向授权流程的网址。
`setComposeAction(action, composedEmailType)`	`Image`	设置在用户点击对象时撰写电子邮件草稿的操作。
`setImageUrl(url)`	`Image`	通过提供网址或数据字符串来设置要使用的图片。
`setOnClickAction(action)`	`Image`	设置在点击对象时执行的操作。
`setOnClickOpenLinkAction(action)`	`Image`	设置在用户点击对象时在标签页中打开网址的操作。
`setOpenLink(openLink)`	`Image`	设置在用户点击对象时要打开的网址。

详细文档

`setAltText(altText)`

设置图片的替代文本以便提供无障碍功能。必填。

参数

名称	类型	说明
`altText`	`String`	要为此图片分配的替代文本。

Image - 此对象，用于链式调用。

`setAuthorizationAction(action)`

设置授权操作，以便在用户点击相应对象时打开指向授权流程的网址。系统随即会在新窗口中打开该网址。当用户完成授权流程并返回应用时，该插件会重新加载。

界面对象只能设置 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`	用于指定在点击此元素时要执行的授权操作的对象。

Image - 此对象，用于链式调用。

`setComposeAction(action, composedEmailType)`

设置在用户点击对象时撰写电子邮件草稿的操作。界面对象只能设置 setOpenLink(openLink)、setOnClickAction(action)、setOnClickOpenLinkAction(action)、setAuthorizationAction(action) 或 setComposeAction(action, composedEmailType) 中的一种。

Action 参数必须指定一个回调函数，该函数会返回使用 ComposeActionResponseBuilder.setGmailDraft(draft) 配置的 ComposeActionResponse 对象。

注意：此方法不会设置用于扩展 Compose 界面的 Compose 操作。而是将此界面元素连接到一个 Action，该 Action 会在 Apps Script 中撰写草稿邮件，并在操作完成后在 Gmail 中打开这些邮件。

// ...

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

// ...

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

参数

名称	类型	说明
`action`	`Action`	用于指定点击此元素时要执行的撰写操作的对象。
`composedEmailType`	`ComposedEmailType`	一个枚举值，用于指定撰写的草稿是独立草稿还是回复草稿。

Image - 此对象，用于链式调用。

`setImageUrl(url)`

通过提供图片的网址或数据字符串来设置要使用的图片。必填。

提供的网址可以是可公开访问的网址，也可以是 base64 编码的图片字符串。如需获取后者，您可以使用以下代码根据 Google 云端硬盘中的图片创建编码图片字符串，然后存储该字符串以供日后与 setImageUrl(url) 搭配使用。此方法可让您的插件无需访问公开可用的图片网址：

// The following assumes you have the image to use in Google Drive and have its
// ID.
const imageBytes = DriveApp.getFileById(imageID).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`	要使用的托管图片的网址或编码后的图片字符串。

Image - 此对象，用于链式调用。

`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`	点击此元素时要执行的操作。

Image - 此对象，用于链式调用。

`setOnClickOpenLinkAction(action)`

设置在用户点击对象时在标签页中打开网址的操作。当需要构建网址，或者除了创建 OpenLink 对象之外还需要执行其他操作时，请使用此函数。界面对象只能设置 setOpenLink(openLink)、setOnClickAction(action)、setOnClickOpenLinkAction(action)、setAuthorizationAction(action) 或 setComposeAction(action, composedEmailType) 之一。

Action 参数必须指定一个回调函数，该函数会返回使用 ActionResponseBuilder.setOpenLink(openLink) 配置的 ActionResponse 对象。

// ...

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 - 此对象，用于链式调用。

`setOpenLink(openLink)`

设置在点击对象时要打开的网址。当网址已知且只需打开时，请使用此函数。界面对象只能设置 setOpenLink(openLink)、setOnClickAction(action)、setOnClickOpenLinkAction(action)、setAuthorizationAction(action) 或 setComposeAction(action, composedEmailType) 之一。

参数

名称	类型	说明
`openLink`	`OpenLink`	一个 `OpenLink` 对象，用于描述要打开的网址。

Image - 此对象，用于链式调用。