Class Grid

Lưới

Lưới được sắp xếp để hiển thị một tập hợp các mục trong lưới.

var grid = CardService.newGrid()
    .setTitle("My Grid")
    .setNumColumns(2)
    .addItem(CardService.newGridItem()
        .setTitle("My item"));

Phương pháp

Phương thứcLoại dữ liệu trả vềMô tả ngắn
addItem(gridItem)GridThêm một mục lưới mới vào lưới.
setAuthorizationAction(action)GridĐặt một thao tác uỷ quyền sẽ mở URL thành luồng uỷ quyền khi đối tượng được nhấp vào.
setBorderStyle(borderStyle)GridĐặt kiểu đường viền áp dụng cho từng mục trong lưới.
setComposeAction(action, composedEmailType)GridĐặt một thao tác soạn email nháp khi đối tượng được nhấp vào.
setNumColumns(numColumns)GridSố cột cần hiển thị trong lưới.
setOnClickAction(action)GridĐặt một thao tác thực thi khi nhấp vào đối tượng.
setOnClickOpenLinkAction(action)GridĐặt thao tác mở URL trong một thẻ khi đối tượng được nhấp vào.
setOpenLink(openLink)GridĐặt URL để mở khi người dùng nhấp vào đối tượng.
setTitle(title)GridĐặt văn bản tiêu đề của lưới.

Tài liệu chi tiết

addItem(gridItem)

Thêm một mục lưới mới vào lưới.

Các tham số

TênLoạiMô tả
gridItemGridItemMục trong lưới cần thêm.

Hai chiều

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


setAuthorizationAction(action)

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

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

// ...

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

Các tham số

TênLoạiMô tả
actionAuthorizationActionĐối tượng chỉ định thao tác ủy quyền cần thực hiện khi nhấp vào phần tử này.

Hai chiều

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


setBorderStyle(borderStyle)

Đặt kiểu đường viền áp dụng cho từng mục trong lưới. Mặc định là NO_BORDER.

Các tham số

TênLoạiMô tả
borderStyleBorderStyleKiểu đường viền sẽ được áp dụng.

Hai chiều

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


setComposeAction(action, composedEmailType)

Đặt một thao tác soạn email nháp khi đối tượng được nhấp vào. Đối tượng giao diện người dùng chỉ được đặt một trong các giá trị cho 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 ComposeActionResponse được định cấu hình bằng 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();
}

Các 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 cho biết bản nháp là bản nháp hay là thư trả lời.

Hai chiều

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


setNumColumns(numColumns)

Số cột cần hiển thị trong lưới. Nếu hiển thị trong bảng điều khiển bên phải, bạn có thể hiển thị 1-3 cột và giá trị mặc định là 1. Nếu hiển thị trong hộp thoại, bạn có thể cho hiện 2-6 cột và giá trị mặc định là 2.

Các tham số

TênLoạiMô tả
numColumnsIntegerSố cột.

Hai chiều

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


setOnClickAction(action)

Đặt một thao tác thực thi khi nhấp vào đối tượng. Bạn chỉ có thể đặt một trong các đối tượng giao diện người dùng 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.

// ...

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

Các 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.

Hai chiều

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


setOnClickOpenLinkAction(action)

Đặt thao tác mở URL trong một thẻ khi đối tượng được nhấp vào. Hãy 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 trong tiện ích bổ sung để tạo đối tượng OpenLink. Bạn chỉ có thể đặt một trong các đối tượng giao diện người dùng 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).

// ...

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

Các tham số

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

Hai chiều

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


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

Các tham số

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

Hai chiều

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


setTitle(title)

Đặt văn bản tiêu đề của lưới. Văn bản này phải là một chuỗi thuần tuý không có định dạng.

Các tham số

TênLoạiMô tả
titleStringNội dung tiêu đề.

Hai chiều

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