Class KeyValue

KeyValue

Không dùng nữa. Lớp này không được dùng nữa và không nên được sử dụng trong các tập lệnh mới.

Lớp này không được dùng nữa. Thay vào đó, hãy sử dụng DecoratedText.

Phương thức

Phương thứcKiểu dữ liệu trả vềMô tả ngắn
addEventAction(eventAction)WidgetThêm thao tác sự kiện có thể thực hiện trên tiện ích.
setAuthorizationAction(action)KeyValueĐặt một thao tác uỷ quyền sẽ mở một URL cho quy trình uỷ quyền khi người dùng nhấp vào đối tượng.
setComposeAction(action, composedEmailType)KeyValueĐặt một thao tác soạn email nháp khi người dùng nhấp vào đối tượng.
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.
setOnClickAction(action)KeyValueĐặt một thao tác sẽ thực thi khi người dùng nhấp vào đối tượng.
setOnClickOpenLinkAction(action)KeyValueĐặt một thao tác mở URL trong thẻ khi người dùng nhấp vào đối tượng.
setOpenLink(openLink)KeyValueĐặt một URL sẽ mở khi người dùng nhấp vào đối tượng.
setVisibility(visibility)WidgetĐặt chế độ hiển thị của tiện ích.

Tài liệu chi tiết

addEventAction(eventAction)

Thêm thao tác 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, để liên kết.

setAuthorizationAction(action)

Đặt một thao tác uỷ quyền sẽ mở một URL cho 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 giá trị setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) hoặc setComposeAction(action, composedEmailType) được đặt. 

// ...

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

KeyValue – Đối tượng này, để liên kết.

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 giá trị setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) hoặc setComposeAction(action, composedEmailType) được đặt.

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 thao tác soạn thư cần thực hiện khi người dùng nhấp vào phần tử này.
composedEmailTypeComposedEmailTypeMột giá trị enum chỉ định xem bản nháp được tạo là bản nháp độc lập hay bản nháp trả lời.

Cầu thủ trả bóng

KeyValue – Đối tượng này, để liên kết.

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. Chỉ có Tiện ích bổ sung mới hỗ trợ thao tác thay đổi tiện ích.

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, để liên kết.

setOnClickAction(action)

Đặt một thao tác sẽ 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 giá trị setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) hoặc setComposeAction(action, composedEmailType) được đặt.

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 người dùng nhấp vào phần tử này.

Cầu thủ trả bóng

KeyValue – Đối tượng này, để liên kết.

setOnClickOpenLinkAction(action)

Đặt một thao tác mở URL trong thẻ khi người dùng nhấp vào đối tượng. 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 giá trị setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) hoặc setComposeAction(action, composedEmailType) được đặt.

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 sẽ thực hiện khi người dùng nhấp vào phần tử này.

Cầu thủ trả bóng

KeyValue – Đối tượng này, để liên kết.

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

Tham số

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

Cầu thủ trả bóng

KeyValue – Đối tượng này, để liên kết.

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, để liên kết.

Các phương thức ngừng hoạt động