Hãy cải thiện trải nghiệm tổng thể của người dùng bằng cách làm theo các hướng dẫn sau về thiết kế tiện ích bổ sung.
Các phương pháp hay nhất nói chung
Bạn nên làm theo các phương pháp hay nhất sau đây cho tất cả tiện ích bổ sung mà bạn phát triển.
Xác định quyền sở hữu tiện ích bổ sung trước khi bắt đầu
tiện ích bổ sung được xác định bởi các dự án Apps Script. Các tiện ích này phải thuộc sở hữu của một tài khoản cụ thể hoặc được đặt trong một bộ nhớ dùng chung. Trước khi lập trình một tiện ích bổ sung, hãy xác định tài khoản nào sẽ sở hữu dự án và tài khoản nào đóng vai trò là nhà xuất bản của dự án đó. Đồng thời, xác định những tài khoản sẽ đóng vai trò là cộng tác viên và đảm bảo rằng các tài khoản đó có quyền truy cập vào dự án tập lệnh và dự án Nền tảng đám mây được liên kết với dự án đó.
Mở rộng Google Workspace, không sao chép
tiện ích bổ sung nhằm mục đích cung cấp các chức năng mới cho các ứng dụng Google Workspace mà chúng mở rộng hoặc tự động hoá các tác vụ phức tạp. Tiện ích bổ sung chỉ sao chép chức năng đã có trong ứng dụng hoặc những tiện ích không thực hiện được những cải tiến đáng kể cho quy trình công việc sẽ không vượt qua được quy trình đánh giá tiện ích bổ sung để phát hành.
Thu hẹp phạm vi
Khi xác định rõ ràng phạm vi của bạn, hãy luôn chọn nhóm phạm vi có ít quyền nhất có thể. Ví dụ: không cấp cho tiện ích bổ sung có quyền truy cập đầy đủ vào Lịch của người dùng ở phạm vi https://www.googleapis.com/auth/calendar nếu ứng dụng đó chỉ cần quyền đọc. Đối với quyền chỉ có thể đọc, hãy sử dụng phạm vi https://www.googleapis.com/auth/calendar.readonly.
Tránh phụ thuộc quá nhiều vào thư viện
Việc sử dụng thư viện Apps Script có thể khiến tiện ích bổ sung của bạn chạy chậm hơn so với khi tất cả các mã Apps Script đều có trong một dự án tập lệnh duy nhất. Mặc dù thư viện Apps Script hoạt động trong các tiện ích bổ sung, nhưng bạn có thể bị giảm hiệu suất nếu sử dụng các tiện ích này. Tránh đưa các thư viện không cần thiết vào dự án và cân nhắc các cách giảm sự phụ thuộc vào tiện ích bổ sung.
Độ trễ được mô tả ở trên chỉ áp dụng cho các dự án Apps Script đang được dùng làm thư viện phía máy chủ. Bạn có thể thoải mái sử dụng các thư viện JavaScript phía máy khách như jQuery mà không gặp phải độ trễ này.
Các phương pháp hay nhất về Tiện ích bổ sung của Google Workspace
Các phương pháp hay nhất sau đây chỉ áp dụng cho Tiện ích bổ sung của Google Workspace và việc sử dụng dịch vụ Thẻ.
Chỉ sử dụng một vài thẻ
Nếu tiện ích bổ sung sử dụng quá nhiều thẻ, cấu hình điều hướng sẽ trở nên phức tạp và khó quản lý.
Tránh tạo nhiều thẻ hơn mức cần thiết.
Sử dụng chức năng tạo tiện ích
Khi viết mã tạo Card hoặc các đối tượng giao diện người dùng phức tạp khác, hãy cân nhắc việc đặt mã đó vào hàm riêng.
Hàm tạo này chỉ tạo đối tượng và trả về đối tượng đó. Điều này cho phép bạn nhanh chóng tạo lại đối tượng đó bất cứ khi nào cần làm mới giao diện người dùng. Hãy nhớ gọi build() sau khi sử dụng các lớp trình tạo trong Dịch vụ thẻ.
Đơn giản hoá thẻ
Nếu một thẻ nhất định có quá nhiều tiện ích, thẻ đó có thể lấp đầy quá nhiều màn hình và trở nên kém hữu ích hơn. Mặc dù các phần thẻ lớn hiển thị dưới dạng thành phần giao diện người dùng có thể thu gọn, nhưng điều này sẽ ẩn thông tin đối với người dùng. Hãy cố gắng đơn giản hoá tiện ích bổ sung của bạn và cung cấp chính xác những gì người dùng cần và không cần thêm nữa.
Sử dụng thẻ lỗi
Tạo thẻ cho các điều kiện lỗi. Nếu tiện ích bổ sung của bạn tạo ra lỗi, thì thẻ đó phải hiển thị một thẻ có thông tin về lỗi và hướng dẫn cách khắc phục lỗi đó nếu có thể. Ví dụ: nếu tiện ích bổ sung của bạn không thể kết nối với một dịch vụ không phải của Google vì uỷ quyền không thành công, hãy hiển thị một thẻ cho biết điều này và yêu cầu người dùng xác minh thông tin tài khoản đang được sử dụng.
Viết mã kiểm thử và kiểm thử thông báo
Bạn nên thử nghiệm kỹ lưỡng tất cả các tiện ích bổ sung mà bạn tạo. Xây dựng các hàm kiểm thử tạo thẻ và tiện ích bằng dữ liệu kiểm thử, sau đó xác minh rằng các đối tượng được tạo như dự kiến.
Khi sử dụng hàm gọi lại hành động, thường thì bạn phải tạo một đối tượng phản hồi. Bạn có thể sử dụng các câu lệnh như sau để xác minh rằng các phản hồi đang được tạo chính xác:
Logger.log(response.printJson());
Chạy các hàm kiểm thử mà bạn tạo ngay trong trình chỉnh sửa Apps Script bằng trình đơn Run (Chạy). Khi bạn có một tiện ích bổ sung khả thi đang hoạt động, hãy nhớ cài đặt phiên bản chưa phát hành để có thể kiểm thử.
Sử dụng dữ liệu kiểm thử phù hợp với từng ứng dụng lưu trữ mà tiện ích bổ sung mở rộng. Ví dụ: nếu tiện ích bổ sung mở rộng Gmail, có thể bạn sẽ cần một vài email kiểm thử và mã thư của các email đó để bạn có thể đảm bảo rằng tiện ích bổ sung hoạt động như mong đợi khi được cung cấp nội dung thư khác. Bạn có thể lấy mã nhận dạng của một thư nhất định bằng cách liệt kê các thư bằng phương thức Gmail API Users.messages.list hoặc bằng cách sử dụng dịch vụ Gmail của Apps Script.
Các phương pháp hay nhất về tính năng hội nghị truyền hình trên Lịch
Nếu tiện ích bổ sung của bạn tích hợp các tuỳ chọn hội nghị truyền hình trên lịch của bên thứ ba vào Lịch Google, hãy làm theo các phương pháp hay nhất sau đây:
Duy trì ánh sáng onCreateFunction
Mỗi onCreateFunction mà bạn xác định trong tệp kê khai sẽ được gọi đồng bộ khi người dùng cố gắng tạo một giải pháp hội nghị thuộc loại đó. Hãy đảm bảo rằng những bộ phận này chỉ thực hiện công việc tối thiểu cần thiết để tạo hội nghị. Việc sử dụng quá nhiều chức năng này có thể làm chậm trải nghiệm người dùng đối với tiện ích bổ sung của bạn.
Sử dụng các trường ConferenceData thích hợp cho dữ liệu hội nghị truyền hình
Khi tạo các đối tượng ConferenceData, bạn có thể điền sẵn thông tin chi tiết về hội nghị truyền hình (mã truy cập, số điện thoại, mã PIN, URI, v.v.) cho các đối tượng đó. Hãy nhớ sử dụng trường EntryPoint tương ứng cho thông tin này. Đừng đặt các thông tin chi tiết này vào trường ghi chú ConferenceData.
Không thêm thông tin của hội nghị truyền hình vào sự kiện trên Lịch Google
Tiện ích bổ sung của bạn không cần thêm thông tin về các hội nghị do bên thứ ba tạo vào phần mô tả sự kiện trên Lịch Google. Lịch Google sẽ tự động thực hiện việc này khi cần.