Cải thiện trải nghiệm người dùng trải nghiệm chung bằng cách làm theo các hướng dẫn này về tiện ích bổ sung thiết kế của bạn.
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, vốn phải thuộc sở hữu của một tài khoản hoặc tệp khác được đặt trong 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. Đồng thời xác định những tài khoản cần hành động với tư cách cộng tác viên và đảm bảo các tài khoản đó có quyền truy cập vào tập lệnh dự án và các liên kết Dự án Cloud Platform.
Mở rộng Google Workspace, khô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à họ mở rộng, hoặc các ứng dụng khác tự động hoá các công việc phức tạp. các tiện ích bổ sung chỉ sao chép chức năng đã có trong hoặc những ứng dụng không thực hiện lặp lại những cải tiến đáng kể đối với quy trình làm việc không có khả năng vượt qua được bước xem xét tiện ích bổ sung cho ấn bản.
Thu hẹp phạm vi
Khi xác định phạm vi một cách rõ ràng,
luôn chọn tập hợp phạm vi ít cho phép nhất có thể. Ví dụ: không nên
yêu cầu tiện ích bổ sung của bạn có toàn quyền truy cập vào Lịch của người dùng bằng
https://www.googleapis.com/auth/calendar phạm vi nếu chỉ cần đọc
truy cập. Đối với quyền truy cập 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 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 sẽ xảy ra nếu tất cả mã Apps Script được chứa 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 vẫn có thể gặp phải vấn đề về hiệu suất nếu bạn sử dụng chúng. Tránh đưa các thư viện không cần thiết vào và cân nhắc các cách để giảm sự phụ thuộc vào tiện ích bổ sung của bạn.
Độ trễ mô tả ở trên chỉ áp dụng cho các dự án Apps Script đang dùng làm thư viện phía máy chủ. Bạn có thể dùng các thư viện JavaScript phía máy khách như jQuery thoải mái 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 của 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ẻ, thì cấu hình điều hướng 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 đặt mã đó vào hàm riêng.
Hàm tạo này chỉ nên tạo 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 đó mỗi khi phải làm mới giao diện người dùng. Ghi nhớ
để gọi build() sau khi sử dụng các lớp trình tạo trong
Dịch vụ thẻ.
Giữ cho thẻ đơn giản
Nếu một thẻ cụ thể 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 trên giao diện người dùng có thể thu gọn, thao tác này sẽ ẩn thông tin khỏi người dù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 và không nhiều hơn 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 gặp lỗi, hiển thị một thẻ có thông tin về lỗi và hướng dẫn cách sửa 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 ứng dụng không phải của Google dịch vụ vì quá trình cấp phép không thành công, hãy hiển thị một thẻ cho biết điều này và hỏi 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 tra kỹ tất cả các tiện ích bổ sung mà bạn tạo. Xây dựng hàm kiểm thử tạo thẻ và tiện ích bằng dữ liệu thử nghiệm, sau đó xác minh rằng các đối tượng được tạo như mong đợi.
Khi sử dụng 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 tuyên bố như sau đây để 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 trực tiếp từ Apps Script bằng cách sử dụng trình đơn Run (Chạy). Khi có một tiện ích bổ sung khả thi đang hoạt động, hãy hãy nhớ cài đặt phiên bản chưa xuất bản để bạn có thể thử nghiệm.
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 thử nghiệm và mã nhận dạng thư để bạn có thể đảm bảo rằng tiện ích bổ sung hoạt động như được mong đợi khi cung cấp nội dung thông báo khác nhau. Bạn có thể lấy mã nhận dạng của thư cho bằng cách liệt kê các thông báo bằng cách sử dụng API User.messages.list của Gmail hoặc bằng cách sử dụng Dịch vụ Gmail.
Các phương pháp hay nhất về 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 ứng dụng bên thứ ba lịch hội nghị truyền hình trong Lịch Google, hãy làm theo các phương pháp hay nhất bổ sung sau đây:
Duy trì đè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 ra một giải pháp hội nghị truyền hình thuộc loại đó. Hãy đả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 hội nghị truyền hình. Làm quá nhiều việc trong những trường hợp này
có thể khiến tiện ích bổ sung của bạn chạy chậm.
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 bản dựng
ConferenceData
bạn có thể điền sẵn thông tin về hội nghị vào nhóm đó (quyền truy cập
mã, số điện thoại, mã PIN, URI, v.v.). Hãy nhớ sử dụng thuộc tính
Trường EntryPoint
để biết thông tin này. Đừng đặt những chi tiết này trong ConferenceData
trường 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 Google
Tiện ích bổ sung của bạn không cần thêm thông tin về bên thứ ba đã tạo hội nghị truyền hình vào phần mô tả sự kiện trên Lịch Google. Lịch Google có thao tác này theo cách tự động khi cần thiết.