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 đây 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
các tiện ích bổ sung được xác định bởi các dự án Apps Script. Các dự án 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 ổ dùng chung. Trước khi lập trình 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 sẽ đóng vai trò là nhà xuất bản của dự án. Ngoài ra, hãy 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 trên Google Cloud Platform liên kết với dự án đó.
Mở rộng Google Workspace, đừng sao chép
Tiện ích bổ sung nhằm cung cấp các tính 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. Những tiện ích bổ sung chỉ sao chép chức năng đã có trong ứng dụng hoặc không cải thiện đáng kể quy trình công việc có thể sẽ không vượt qua được quy trình xem xét tiện ích bổ sung để xuất bản.
Giữ phạm vi hẹp
Khi xác định rõ ràng phạm vi của bạn, hãy luôn chọn tập hợp phạm vi ít cho phép nhất có thể. Ví dụ: đừng yêu cầu tiện ích bổ sung quyền truy cập đầy đủ vào Lịch của người dùng với phạm vi https://www.googleapis.com/auth/calendar nếu tiện ích bổ sung chỉ cần quyền truy cập để đọc. Để có quyền chỉ đọc, hãy sử dụng phạm vi https://www.googleapis.com/auth/calendar.readonly.
Tránh quá phụ thuộc vào thư viện
Việc sử dụng thư viện Apps Script có thể khiến tiện ích bổ sung chạy chậm hơn so với khi tất cả mã Apps Script được chứa trong một dự án tập lệnh. Mặc dù các thư viện Apps Script hoạt động trong tiện ích bổ sung, nhưng bạn có thể gặp phải tình trạng giảm hiệu suất nếu sử dụng các thư viện đó. 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 của tiện ích bổ sung vào các thư viện đó.
Độ trễ được mô tả ở trên chỉ áp dụng cho các dự án Apps Script đang được sử dụng làm thư viện phía máy chủ. Bạn có thể tự do 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 các 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 các hàm 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ỉ cần 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 ít hữu ích hơn. Mặc dù các phần thẻ lớn hiển thị dưới dạng các 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 khỏi người dùng. Hãy hướng đến việc đơn giản hoá tiện ích bổ sung và cung cấp đúng những gì người dùng cần và không hơn thế.
Sử dụng thẻ lỗi
Tạo thẻ cho các điều kiện lỗi. Nếu xảy ra lỗi, tiện ích bổ sung sẽ hiển thị một thẻ có thông tin lỗi và hướng dẫn cách khắc phục 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ì không được uỷ quyền, hãy hiển thị một thẻ nêu rõ đ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à thông báo kiểm thử
Bạn nên kiểm thử kỹ lưỡng tất cả các tiện ích bổ sung mà bạn tạo. Tạo 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 thao tác, bạn thường 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 hoạt động hiệu quả, hãy nhớ cài đặt phiên bản chưa phát hành để có thể kiểm thử tiện ích đó.
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 mở rộng Gmail, bạn có thể cần một vài email thử nghiệm và mã thư của chúng để đảm bảo rằng tiện ích hoạt động như dự kiến khi được cung cấp nội dung thư khác nhau. Bạn có thể lấy mã thư cho một thư cụ thể bằng cách liệt kê 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 để tổ chức hội nghị 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ị 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 bổ sung sau:
Giữ cho onCreateFunction sáng
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 giải pháp hội nghị thuộc loại đó. Đảm bảo rằng các hàm này chỉ thực hiện công việc tối thiểu cần thiết để tạo cuộc họp. Việc làm quá nhiều trong các hàm này có thể khiến người dùng trải nghiệm chậm khi sử dụng tiện ích bổ sung.
Sử dụng các trường ConferenceData phù hợp cho dữ liệu hội nghị
Khi tạo đối tượng ConferenceData, bạn có thể điền thông tin chi tiết về hội nghị (mã truy cập, số điện thoại, ghim, URI, v.v.) vào 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 những thông tin chi tiết này vào trường ghi chú ConferenceData.
Không thêm thông tin chi tiết về cuộc họp 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 cuộc họp do bên thứ ba tạo vào nội dung 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.