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 nà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 áp dụng 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ằng 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 ổ đĩa dùng chung. Trước khi viết mã cho 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. 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 những 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 được liên kết.
Mở rộng Google Workspace, đừng sao chép
Tiện ích bổ sung được thiết kế để 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. Những 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 bổ sung không cải thiện đáng kể quy trình làm việc 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 phạm vi một cách rõ ràng, hãy luôn chọn tập hợp phạm vi ít hạn chế nhất có thể. Ví dụ: đừng để tiện ích bổ sung của bạn yêu cầu quyền truy cập đầy đủ vào Lịch của người dùng bằng phạm vi https://www.googleapis.com/auth/calendar nếu tiện ích đó 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 phụ thuộc quá nhiều vào các 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ả mã Apps Script nằm trong một dự án tập lệnh duy nhất. 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 này. Tránh đưa các thư viện không cần thiết vào dự án của bạn và cân nhắc những 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 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 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 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ỉ nên tạo đối tượng và trả về đối tượng đó. Nhờ đó, bạn có thể nhanh chóng tạo lại đối tượng đó bất cứ khi nào giao diện người dùng phải được làm mới. Đừng quên gọi build() sau khi sử dụng các lớp trình tạo trong Dịch vụ thẻ.
Đảm bảo tính đơn giản của thẻ
Nếu một thẻ nhất định có quá nhiều tiện ích, thẻ đó có thể chiếm quá nhiều không gian trên màn hình và trở nên kém hữu ích. Mặc dù các phần thẻ lớn hiển thị dưới dạng các phần tử 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 cố gắng đơn giản hoá tiện ích bổ sung và cung cấp chính xác những gì người dùng cần, không hơn không kém.
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 gặp lỗi, thì tiện ích đó sẽ hiển thị một thẻ chứa thông tin lỗi và hướng dẫn về 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 do 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 bài 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 dùng các hàm gọi lại hành động, 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 đúng cách:
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 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 xuất bản để 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 bổ sung mở rộng Gmail, bạn có thể cần một vài email kiểm thử và mã thư của chúng để đả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 nhau. Bạn có thể lấy mã thư cho một thư nhất định bằng cách liệt kê thư bằng phương thức API Gmailusers.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 khi sử dụng 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 lựa 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 những phương pháp hay bổ sung sau:
Luôn bật đèn 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 đó. Đảm bảo những hàm này chỉ thực hiện lượng công việc tối thiểu cần thiết để tạo hội nghị. Việc thực hiện quá nhiều thao tác trong các hàm này có thể khiến người dùng có trải nghiệm chậm khi dùng tiện ích bổ sung của bạn.
Sử dụng các trường ConferenceData phù hợp cho dữ liệu hội nghị
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ị (mã truy cập, số điện thoại, mã PIN, URI, v.v.). Hãy nhớ sử dụng trường EntryPoint tương ứng cho thông tin này. Đừng nhập những thông tin này vào trường ConferenceData ghi chú.
Không thêm thông tin chi tiết về hội nghị truyền hình vào sự kiện trên Lịch
Tiện ích bổ sung của bạn không cần thêm thông tin về các hội nghị truyền hình do bên thứ ba tạo vào phần mô tả sự kiện trên Lịch. Lịch sẽ tự động thực hiện việc này khi cần.