Class Button

Button

Lớp cơ sở cho tất cả các nút.

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

Phương thức

Phương thứcLoại dữ liệu trả vềMô tả ngắn
setAuthorizationAction(action)ButtonThiết lập một thao tác uỷ quyền sẽ mở một URL trong quy trình uỷ quyền khi người dùng nhấp vào đối tượng.
setComposeAction(action, composedEmailType)ButtonThiết lập một thao tác soạn email nháp khi người dùng nhấp vào đối tượng.
setOnClickAction(action)ButtonThiết lập một thao tác thực thi khi đối tượng được nhấp vào.
setOnClickOpenLinkAction(action)ButtonĐặt một thao tác mở URL trong thẻ khi đối tượng được nhấp vào.
setOpenLink(openLink)ButtonĐặt URL sẽ được mở khi đối tượng được nhấp vào.
setOverflowMenu(menu)ButtonĐặt một trình đơn bật lên để mở khi nhấp vào đối tượng.

Tài liệu chi tiết

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

Thông số

TênLoạiMô tả
actionAuthorizationActionĐối tượng chỉ định thao tác 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

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


setComposeAction(action, composedEmailType)

Thiết lập 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() {
  const thread = GmailApp.getThreadById(e.threadId);
  const draft = thread.createDraftReply('This is a reply');
  return CardService.newComposeActionResponseBuilder()
      .setGmailDraft(draft)
      .build();
}

Thông số

TênLoạiMô tả
actionActionĐối tượng chỉ định thao tác cần thực hiện khi người dùng 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

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


setOnClickAction(action)

Đặt một thao tác thực thi khi người dùng nhấp vào đối tượng. Mỗi đố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();
}

Thông 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

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


setOnClickOpenLinkAction(action)

Đặt một hành động mở URL trong một thẻ khi người dùng nhấp vào đối tượng. Hãy 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ỗi đối tượng giao diện người dùng chỉ được có một trong các giá trị: 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 đượ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();
}

Thông số

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

Cầu thủ trả bóng

Button – Đố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).

Thông số

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

Cầu thủ trả bóng

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


setOverflowMenu(menu)

Đặt một trình đơn bật lên để mở khi nhấp vào đối tượng. Mỗi mục trong trình đơn có thể chỉ định một thao tác sẽ được kích hoạt khi được nhấp vào. Không hỗ trợ trình đơn lồng nhau, các thao tác cho mục trong trình đơn không được chỉ định trình đơn mục bổ sung.

Chỉ dành cho ứng dụng Google Chat. Không dùng được cho các tiện ích bổ sung của Google Workspace.

const overflowMenuItem =
    CardService.newOverflowMenuItem()
        .setStartIcon(
            CardService.newIconImage().setIconUrl(
                'https://www.google.com/images/branding/googleg/1x/googleg_standard_color_64dp.png',
                ),
            )
        .setText('Open Link')
        .setOpenLink(
            CardService.newOpenLink().setUrl('https://www.google.com'));

const overflowMenu =
    CardService.newOverflowMenu().addMenuItem(overflowMenuItem).build();

Thông số

TênLoạiMô tả
menuOverflowMenuĐối tượng chỉ định trình đơn mục bổ sung sẽ hiển thị khi người dùng nhấp vào phần tử này.

Cầu thủ trả bóng

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