Class Grid

Lưới

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

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

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

Phương thức

Phương thứcKiểu dữ liệu trả vềMô tả ngắn
addEventAction(eventAction)WidgetThêm hành động sự kiện có thể thực hiện trên tiện ích.
addItem(gridItem)GridThêm một mục mới vào lưới.
setAuthorizationAction(action)GridĐặt một hành động uỷ quyền mở một URL cho quy trình uỷ quyền khi đối tượng được nhấp vào.
setBorderStyle(borderStyle)GridĐặt kiểu đường viền được áp dụng cho từng mục trong lưới.
setComposeAction(action, composedEmailType)GridĐặt một hành động soạn email nháp khi đối tượng được nhấp vào.
setId(id)WidgetĐặt mã nhận dạng duy nhất được chỉ định dùng để xác định tiện ích cần thay đổi.
setNumColumns(numColumns)GridSố cột cần hiển thị trong lưới.
setOnClickAction(action)GridĐặt một hành động thực thi khi đối tượng được nhấp vào.
setOnClickOpenLinkAction(action)GridĐặt một hành động mở một URL trong thẻ khi đối tượng được nhấp vào.
setOpenLink(openLink)GridĐặt một URL sẽ được mở khi đối tượng được nhấp vào.
setTitle(title)GridĐặt văn bản tiêu đề của lưới.
setVisibility(visibility)WidgetĐặt chế độ hiển thị của tiện ích.

Tài liệu chi tiết

addEventAction(eventAction)

Thêm hành động sự kiện có thể thực hiện trên tiện ích.

Tham số

TênLoạiMô tả
eventActionEventActionEventAction cần thêm.

Cầu thủ trả bóng

Widget – Đối tượng, để tạo chuỗi.

addItem(gridItem)

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

Tham số

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

Cầu thủ trả bóng

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

setAuthorizationAction(action)

Đặt một hành động uỷ quyền mở một URL cho quy trình uỷ quyền khi đối tượng được nhấp vào. Hành động 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ể đặt một trong các đối tượng 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 phần tử này được nhấp vào.

Cầu thủ trả bóng

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

setBorderStyle(borderStyle)

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

Tham số

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

Cầu thủ trả bóng

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

setComposeAction(action, composedEmailType)

Đặt một hành động soạn email nháp khi đối tượng được nhấp vào. Một đối tượng giao diện người dùng chỉ có thể đặt một trong các đối tượ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 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 cần thực hiện khi phần tử này được nhấp vào.
composedEmailTypeComposedEmailTypeGiá trị enum chỉ định xem bản nháp đã soạn là bản nháp độc lập hay bản nháp trả lời.

Cầu thủ trả bóng

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

setId(id)

Đặt mã nhận dạng duy nhất được chỉ định dùng để xác định tiện ích cần thay đổi. Tính năng thay đổi tiện ích chỉ được hỗ trợ trong Tiện ích bổ sung.

Tham số

TênLoạiMô tả
idStringMã nhận dạng của tiện ích, có giới hạn 64 ký tự và ở định dạng `[a-zA-Z0-9-]+`.

Cầu thủ trả bóng

Widget – Đố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 đến 2 cột và giá trị mặc định là 1. Nếu hiển thị trong hộp thoại, bạn có thể hiển thị 2 đến 3 cột và giá trị mặc định là 2.

Tham số

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

Cầu thủ trả bóng

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

setOnClickAction(action)

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

// ...

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 phần tử này được nhấp vào.

Cầu thủ trả bóng

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

setOnClickOpenLinkAction(action)

Đặt một hành động mở một URL trong 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 hành động 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ể đặt một trong các đối tượ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). 

// ...

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 phần tử này được nhấp vào.

Cầu thủ trả bóng

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

Đặt một URL sẽ được mở khi đối tượng được nhấp vào. Hãy 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ể đặt một trong các đối tượng 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

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 phải là một chuỗi thuần tuý không có định dạng.

Tham số

TênLoạiMô tả
titleStringVăn bản tiêu đề.

Cầu thủ trả bóng

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

setVisibility(visibility)

Đặt chế độ hiển thị của tiện ích. Giá trị mặc định là `VISIBLE`.

Tham số

TênLoạiMô tả
visibilityVisibilityVisibility của tiện ích.

Cầu thủ trả bóng

Widget – Đối tượng, để tạo chuỗi.