Class Image

Image

Một tiện ích hiển thị một hình ảnh duy nhất. Để biết thông tin về cách cắt hình ảnh, hãy xem ImageCropStyle.

Có sẵn cho các ứng dụng Tiện ích bổ sung của Google Workspace và Google Chat.

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

Phương thức

Phương thứcLoại dữ liệu trả vềMô tả ngắn
setAltText(altText)ImageĐặt văn bản thay thế của hình ảnh để hỗ trợ tiếp cận.
setAuthorizationAction(action)ImageĐặt một hành động uỷ quyền mở URL đến quy trình uỷ quyền khi người dùng nhấp vào đối tượng.
setComposeAction(action, composedEmailType)ImageĐặt một thao tác soạn email nháp khi người dùng nhấp vào đối tượng.
setImageUrl(url)ImageĐặt hình ảnh cần sử dụng bằng cách cung cấp URL hoặc chuỗi dữ liệu của hình ảnh đó.
setOnClickAction(action)ImageĐặt một hành động thực thi khi người dùng nhấp vào đối tượng.
setOnClickOpenLinkAction(action)ImageĐặt một thao tác mở URL trong thẻ khi đối tượng được nhấp vào.
setOpenLink(openLink)ImageĐặt URL sẽ được mở khi đối tượng được nhấp vào.

Tài liệu chi tiết

setAltText(altText)

Đặt văn bản thay thế của hình ảnh để hỗ trợ tiếp cận. Bắt buộc.

Tham số

TênLoạiMô tả
altTextStringVăn bản thay thế để chỉ định cho hình ảnh này.

Cầu thủ trả bóng

Image – Đối tượng này, để tạo chuỗi.


setAuthorizationAction(action)

Đặt một hành động uỷ quyền mở URL đến quy trình uỷ quyền khi người dùng nhấp vào đối tượng. Thao tác này sẽ mở URL trong một cửa sổ mới. Khi người dùng hoàn tất quy trình uỷ quyền và quay lại ứng dụng, tiện ích bổ sung sẽ tải lại.

Một đối tượng giao diện người dùng chỉ có thể có một trong các tập hợp setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) hoặc setComposeAction(action, composedEmailType).

// ...

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

Tham số

TênLoạiMô tả
actionAuthorizationActionĐối tượng chỉ định hành động uỷ quyền cần thực hiện khi người dùng nhấp vào phần tử này.

Cầu thủ trả bóng

Image – Đối tượng này, để tạo chuỗi.


setComposeAction(action, composedEmailType)

Đặt một thao tác soạn email nháp khi người dùng nhấp vào đối tượng. Một đối tượng giao diện người dùng chỉ có thể có một trong các tập hợp setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) hoặc setComposeAction(action, composedEmailType).

Tham số Action phải chỉ định một hàm gọi lại trả về đối tượng ComposeActionResponse được định cấu hình bằng ComposeActionResponseBuilder.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();
}

Tham số

TênLoạiMô tả
actionActionĐối tượng chỉ định hành động soạn thư cần thực hiện khi nhấp vào phần tử này.
composedEmailTypeComposedEmailTypeGiá trị enum chỉ định liệu thư nháp đã soạn là thư độc lập hay thư trả lời.

Cầu thủ trả bóng

Image – Đối tượng này, để tạo chuỗi.


setImageUrl(url)

Đặt hình ảnh cần sử dụng bằng cách cung cấp URL hoặc chuỗi dữ liệu của hình ảnh đó. Bắt buộc.

URL được cung cấp có thể là URL có thể truy cập công khai hoặc chuỗi hình ảnh được mã hoá base64. Để lấy chuỗi hình ảnh đã mã hoá, bạn có thể sử dụng mã sau để tạo một chuỗi hình ảnh đã mã hoá từ một hình ảnh trong Google Drive, sau đó lưu trữ chuỗi đó để sử dụng sau này với setImageUrl(url). Phương thức này giúp tiện ích bổ sung của bạn không cần truy cập vào URL hình ảnh có sẵn công khai:

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

Tham số

TênLoạiMô tả
urlStringĐịa chỉ URL của hình ảnh được lưu trữ để sử dụng hoặc chuỗi hình ảnh đã mã hoá.

Cầu thủ trả bóng

Image – Đối tượng này, để tạo chuỗi.


setOnClickAction(action)

Đặt một hành động thực thi khi người dùng nhấp vào đối tượng. Một đối tượng giao diện người dùng chỉ có thể có một trong các tập hợp setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) hoặc setComposeAction(action, composedEmailType).

Tham số Action phải chỉ định một hàm callback trả về đối tượng 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();
}

Tham số

TênLoạiMô tả
actionActionHành động cần thực hiện khi nhấp vào phần tử này.

Cầu thủ trả bóng

Image – Đối tượng này, để tạo chuỗi.


setOnClickOpenLinkAction(action)

Đặt một thao tác mở URL trong thẻ khi đối tượng được nhấp vào. Sử dụng hàm này khi cần tạo URL hoặc khi bạn cần thực hiện các thao tác khác ngoài việc tạo đối tượng OpenLink. Một đối tượng giao diện người dùng chỉ có thể có một trong các tập hợp setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) hoặc setComposeAction(action, composedEmailType).

Tham số Action phải chỉ định một hàm gọi lại trả về đối tượng ActionResponse được định cấu hình bằng ActionResponseBuilder.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();
}

Tham số

TênLoạiMô tả
actionActionĐối tượng chỉ định hành động mở đường liên kết cần thực hiện khi người dùng nhấp vào phần tử này.

Cầu thủ trả bóng

Image – Đối tượng này, để tạo chuỗi.


Đặt URL sẽ được mở khi đối tượng được nhấp vào. Sử dụng hàm này khi URL đã được biết và chỉ cần mở. Một đối tượng giao diện người dùng chỉ có thể có một trong các tập hợp setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) hoặc setComposeAction(action, composedEmailType).

Tham số

TênLoạiMô tả
openLinkOpenLinkĐối tượng OpenLink mô tả URL cần mở.

Cầu thủ trả bóng

Image – Đối tượng này, để tạo chuỗi.