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設定授權動作,在物件點擊時開啟授權流程的網址。
setComposeAction(action, composedEmailType)Image設定在物件點選時,撰寫電子郵件草稿的動作。
setImageUrl(url)Image提供圖片的網址或資料字串,以設定使用圖片。
setOnClickAction(action)Image設定在點選物件時要執行的動作。
setOnClickOpenLinkAction(action)Image設定當使用者點選物件時,於分頁中開啟網址的動作。
setOpenLink(openLink)Image設定在點選物件時開啟的網址。

內容詳盡的說明文件

setAltText(altText)

設定圖片的無障礙功能替代文字。這是必填欄位。

參數

名稱類型說明
altTextString要指派給這張圖片的替代文字。

回攻員

Image:這個物件用於鏈結。


setAuthorizationAction(action)

設定授權動作,在物件點擊時開啟授權流程的網址。網址會在新視窗中開啟。當使用者完成授權流程並返回應用程式時,外掛程式會重新載入。

UI 物件只能設定 setOpenLink(openLink)setOnClickAction(action)setOnClickOpenLinkAction(action)setAuthorizationAction(action)setComposeAction(action, composedEmailType) 的其中一項。

// ...

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

參數

名稱類型說明
actionAuthorizationAction這個物件會在使用者點擊此元素時,指定要採取的動作。

回攻員

Image:這個物件用於鏈結。


setComposeAction(action, composedEmailType)

設定在物件點選時,撰寫電子郵件草稿的動作。UI 物件只能設定 setOpenLink(openLink)setOnClickAction(action)setOnClickOpenLinkAction(action)setAuthorizationAction(action)setComposeAction(action, composedEmailType) 的其中一項。

Action 參數必須指定回呼函式,該函式會傳回使用 ComposeActionResponseBuilder.setGmailDraft(draft) 設定的 ComposeActionResponse 物件。

// ...

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();
}

參數

名稱類型說明
actionAction這個物件會在使用者點擊此元素時,指定要採取的動作。
composedEmailTypeComposedEmailType此列舉值可指定撰寫的草稿是獨立或回覆草稿。

回攻員

Image:這個物件用於鏈結。


setImageUrl(url)

提供圖片的網址或資料字串,以設定使用圖片。必填。

提供的網址可以是可公開存取的網址,或是採用 Base64 編碼的圖片字串。如要取得後者,您可以使用以下程式碼,從 Google 雲端硬碟中的圖片建立編碼的圖片字串,然後儲存該字串,以搭配 setImageUrl(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).

參數

名稱類型說明
urlString要使用的代管圖片網址,或已編碼的圖片字串。

回攻員

Image:這個物件用於鏈結。


setOnClickAction(action)

設定在點選物件時要執行的動作。UI 物件只能設定 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();
}

參數

名稱類型說明
actionAction點按此元素時要採取的動作。

回攻員

Image:這個物件用於鏈結。


setOnClickOpenLinkAction(action)

設定當使用者點選物件時,於分頁中開啟網址的動作。在需要建構網址,或需要在外掛程式中執行其他動作以建立 OpenLink 物件時,請使用此函式。UI 物件只能設定 setOpenLink(openLink)setOnClickAction(action)setOnClickOpenLinkAction(action)setAuthorizationAction(action)setComposeAction(action, composedEmailType) 的其中一種。

Action 參數必須指定回呼函式,該函式會傳回使用 ActionResponseBuilder.setOpenLink(openLink) 設定的 ActionResponse 物件。

// ...

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();
}

參數

名稱類型說明
actionAction此物件會在使用者點選此元素時,指定開啟的連結動作。

回攻員

Image:這個物件用於鏈結。


設定在點選物件時開啟的網址。當已知網址且只需要開啟時,請使用此函式。UI 物件只能設定 setOpenLink(openLink)setOnClickAction(action)setOnClickOpenLinkAction(action)setAuthorizationAction(action)setComposeAction(action, composedEmailType) 的其中一項。

參數

名稱類型說明
openLinkOpenLinkOpenLink 物件,用於描述要開啟的網址。

回攻員

Image:這個物件用於鏈結。