Tiện ích bổ sung của Google Workspace có thể cung cấp các giao diện tuỳ chỉnh khi người dùng đang sử dụng Google Drive. Điều này cho phép bạn cung cấp cho người dùng thông tin bổ sung có liên quan, tự động hoá các tác vụ và kết nối các hệ thống của bên thứ ba với Google Drive.
Truy cập vào giao diện người dùng của tiện ích bổ sung
Bạn có thể mở một tiện ích bổ sung của Google Workspace trong Google Drive nếu biểu tượng của tiện ích đó xuất hiện trong cột biểu tượng ở bên phải giao diện người dùng Drive. Tiện ích bổ sung của Google Workspace có thể xác định giao diện trang chủ, giao diện chọn mục hoặc cả hai:
- Nếu người dùng nhấp vào biểu tượng tiện ích bổ sung khi đang ở trong Google Drive, tiện ích bổ sung sẽ thực thi hàm
drive.homepageTrigger
tương ứng (nếu có). Hàm này tạo và trả về một thẻ trang chủ cho Google Drive để hiển thị. Nếu không có hàmdrive.homepageTrigger
nào được xác định, thì một thẻ trang chủ chung sẽ xuất hiện. - Nếu người dùng chọn một hoặc nhiều mục trong Google Drive rồi nhấp vào biểu tượng tiện ích bổ sung hoặc chọn các mục trong khi tiện ích bổ sung đang mở, thì tiện ích bổ sung sẽ thực thi hàm theo ngữ cảnh
drive.onItemsSelectedTrigger
tương ứng (nếu có). Hàm này tạo giao diện "các mục đã chọn" theo ngữ cảnh trên Google Drive của tiện ích bổ sung và trả về giao diện đó cho Google Drive để hiển thị.
Xây dựng giao diện tiện ích bổ sung cho Drive
Bạn có thể tạo các giao diện mở rộng Google Drive bằng cách làm theo các bước chung sau:
- Quyết định xem bạn có muốn tiện ích bổ sung của mình có một trang chủ dành riêng cho Drive hay không. Ngoài ra, hãy quyết định xem bạn có muốn cung cấp giao diện theo ngữ cảnh khi người dùng chọn các mục trên Drive hay không.
- Thêm các trường
addOns.common
vàaddOns.drive
thích hợp vào tệp kê khai dự án tập lệnh của tiện ích bổ sung, bao gồm cả mọi phạm vi Drive bắt buộc. - Nếu bạn đang cung cấp một trang chủ dành riêng cho Drive, hãy triển khai hàm
drive.homepageTrigger
để tạo giao diện này. Bạn c��ng có th�� chọn sử dụng giao diệncommon.homepageTrigger
cho nhiều máy chủ lưu trữ Google Workspace. - Nếu đang cung cấp một giao diện chọn mục theo bối cảnh trên Drive, bạn phải triển khai một hàm kích hoạt theo bối cảnh
drive.onItemsSelectedTrigger
để tạo giao diện này. Hãy xem phần Giao diện theo bối cảnh của Drive cho các mục đã chọn để biết thông tin chi tiết. - Triển khai các hàm gọi lại được liên kết cần thiết để phản hồi các hoạt động tương tác của người dùng với giao diện người dùng, chẳng hạn như lượt nhấp vào nút.
Trang chủ của Drive
Google Drive hỗ trợ hiển thị trang chủ của tiện ích bổ sung Google Workspace.
Để hiển thị trang chủ chung của tiện ích bổ sung trong Google Drive, bạn chỉ cần đảm bảo rằng có trường addOns.drive
trong tệp kê khai của tiện ích bổ sung.
Hoặc thêm drive.homepageTrigger
vào tệp kê khai tiện ích bổ sung để cung cấp một trang chủ dành riêng cho Drive.
Trong cả hai trường hợp, bạn phải cung cấp tên của một hàm kích hoạt trang chủ trong dự án tập lệnh của tiện ích bổ sung. Hàm này được gọi tự động để tạo trang chủ Drive khi cần. Bạn phải triển khai hàm này để tạo và trả về một Card
duy nhất hoặc một mảng các đối tượng Card
tạo nên trang chủ. Hàm kích hoạt trang chủ được truyền một đối tượng sự kiện làm tham số chứa một số thông tin chung, chẳng hạn như nền tảng của ứng dụng. Bạn có thể sử dụng dữ liệu đối tượng sự kiện để điều chỉnh cấu trúc của trang chủ.
Giao diện theo bối cảnh của Drive cho các mục đã chọn
Google Drive dựa vào một điều kiện kích hoạt theo bối cảnh để xác định giao diện (nếu có) sẽ hiển thị khi người dùng chọn một hoặc nhiều mục trên Google Drive. Khi sự kiện kích hoạt xảy ra, sự kiện này sẽ thực thi hàm kích hoạt theo bối cảnh do trường drive.onItemsSelectedTrigger.runFunction
chỉ định trong tệp kê khai tiện ích bổ sung.
Để tạo giao diện chọn mục theo bối cảnh cho Drive, bạn phải làm như sau:
Đảm bảo tệp kê khai của tiện ích bổ sung có
https://www.googleapis.com/auth/drive.addons.metadata.readonly
scopeĐảm bảo tệp kê khai có một phần
drive.onItemsSelectedTrigger
.Triển khai hàm có tên trong trường
drive.onItemsSelectedTrigger
. Hàm này chấp nhận một đối tượng sự kiện làm đối số và phải trả về một đối tượngCard
duy nhất hoặc một mảng các đối tượngCard
.Giống như mọi thẻ, bạn phải triển khai mọi hàm gọi lại được dùng để cung cấp tính tương tác của tiện ích cho giao diện. Ví dụ: nếu bạn đưa một nút vào giao diện, thì nút đó phải có một Action được đính kèm và một hàm gọi lại đã triển khai chạy khi người dùng nhấp vào nút.
Đối tượng sự kiện
Một đối tượng sự kiện được tạo và truyền đến hàm kích hoạt drive.homepageTrigger
hoặc drive.onItemsSelectedTrigger
khi các hàm đó được gọi. Hàm kích hoạt có thể sử dụng thông tin trong đối tượng sự kiện này để xác định cách tạo thẻ bổ sung hoặc kiểm soát hành vi của tiện ích bổ sung.
Cấu trúc đầy đủ của các đối tượng sự kiện được mô tả trong phần Đối tượng sự kiện. Khi Drive là ứng dụng lưu trữ đang hoạt động của tiện ích bổ sung, các đối tượng sự kiện theo bối cảnh sẽ bao gồm trường đối tượng sự kiện Drive mang thông tin cụ thể về ứng dụng Drive.
Các đối tượng sự kiện theo ngữ cảnh của Drive cho các điều kiện kích hoạt lựa chọn mục bao gồm thông tin về các mục mà người dùng đã chọn khi điều kiện kích hoạt hoạt động. Khi người dùng chọn nhiều mục trong Drive, một trong các mục đó sẽ được coi là một trong những mục mà người dùng quan tâm nhất; mục này được gọi là mục con trỏ đang hoạt động.
Ví dụ sau đây cho thấy đối tượng sự kiện trên Drive được truyền đến một hàm drive.onItemsSelectedTrigger
:
{
"commonEventObject": { ... },
"drive": {
"activeCursorItem":{
"addonHasFileScopePermission": true,
"id":"0B_sX1fXRRU6Ac3RhcnRlcl9maWxl",
"iconUrl": "https://drive-thirdparty.googleusercontent.com...",
"mimeType":"application/pdf",
"title":"How to get started with Drive"
},
"selectedItems": [
{
"addonHasFileScopePermission": true,
"id":"0B_sX1fXRRU6Ac3RhcnRlcl9maWxl",
"iconUrl":"https://drive-thirdparty.googleusercontent.com...",
"mimeType":"application/pdf",
"title":"How to get started with Drive"
},
...
]
},
...
}