Khi bạn muốn tạo một tiện ích bổ sung mới cho Google Workspace, hãy làm theo hướng dẫn chung sau quy trình:
- Thiết lập các dự án của tiện ích bổ sung và chọn chủ sở hữu cũng như cộng tác viên.
- Thiết kế giao diện và hoạt động của tiện ích bổ sung.
- Định cấu hình tệp kê khai dự án hoặc tài nguyên triển khai của tiện ích bổ sung.
- Viết mã để xác định giao diện của tiện ích bổ sung và hành vi.
- Xác minh phạm vi OAuth của tiện ích bổ sung.
- Kiểm thử tiện ích bổ sung trong các ứng dụng lưu trữ mà tiện ích bổ sung đó mở rộng.
- Xuất bản tiện ích bổ sung.
Thiết lập dự án tiện ích bổ sung rồi chọn chủ sở hữu và cộng tác viên
Nếu tạo tiện ích bổ sung trong Apps Script, bạn sẽ tạo cả dự án Apps Script và dự án Google Cloud. Nếu tạo tiện ích bổ sung bằng ngôn ngữ khác với Apps Script, bạn chỉ cần tạo một dự án Google Cloud.
Trước khi bắt đầu phát triển tiện ích bổ sung, hãy chọn một tài khoản người dùng để sở hữu dự án và quyết định tài khoản nào khác cộng tác viên của mình. Chủ sở hữu dự án tạo và quản lý các tệp dự án và các chế độ cài đặt liên quan, còn cộng tác viên có thể hỗ trợ lập trình và kiểm thử.
Dự án Apps Script
Bạn có thể tạo Apps Script cho tiện ích bổ sung của mình các tệp dự án trong một tệp được chia sẻ lái xe để không tài khoản duy nhất có quyền sở hữu duy nhất. Việc đặt tệp tập lệnh bổ trợ vào một bộ nhớ dùng chung sẽ đảm bảo rằng nhiều cộng tác viên có quyền truy cập vào dự án tập lệnh.
Khi bạn phát hành một tiện ích bổ sung, một tài khoản người dùng sẽ hoạt động nhà xuất bản. Tài khoản xuất bản phải có quyền chỉnh sửa tập lệnh dự án mà không nhất thiết phải là chủ sở hữu.
Để tạo một dự án Apps Script, hãy xem phần Dự án tập lệnh.
Dự án trong Google Cloud
Bạn nên thêm cộng tác viên vào dự án trên đám mây của tiện ích bổ sung. Điều này giúp đảm bảo rằng một người nào đó trong nhóm của bạn luôn có thể truy cập vào chế độ cài đặt trên đám mây của tiện ích bổ sung.
Để tạo dự án trên Google Cloud, hãy xem bài viết Tạo dự án trên Google Cloud.
Thiết kế giao diện và hành vi của tiện ích bổ sung
Quyết định hình thức và hình thức hiển thị của tiện ích bổ sung ứng dụng sẽ hoạt động trước khi bắt đầu tạo. Cân nhắc xem những trường hợp sử dụng nào tiện ích bổ sung sẽ cố gắng cung cấp giải pháp. Trước tiên, hãy bắt đầu bằng một thiết kế đơn giản để có thể hoạt động, sau đó thêm các điểm tinh chỉnh khác.
Tham khảo Hướng dẫn về kiểu tiện ích bổ sung của Google Workspace để biết các nguyên tắc về cách thiết kế trải nghiệm người dùng của tiện ích bổ sung.
Định cấu hình tệp kê khai dự án của tiện ích bổ sung
Trong các dự án Apps Script, tệp kê khai dự án là một tệp JSON đặc biệt. Thuộc tính này chỉ định nhiều thông tin chi tiết về dự án, chẳng hạn như thư viện phần phụ thuộc. Đối với Tiện ích bổ sung của Google Workspace, tệp kê khai cũng cung cấp thông tin mà ứng dụng lưu trữ cần để hiển thị tiện ích bổ sung đúng cách.
Xem Tệp kê khai để biết chi tiết về cách định cấu hình tệp kê khai của tiện ích bổ sung trong Apps Script.
Khi bạn thêm mã và tính năng vào tiện ích bổ sung, hãy chỉnh sửa tệp kê khai nếu cần để tạo giao diện và hành vi bắt buộc của tiện ích bổ sung.
Mã hoá tiện ích bổ sung
Bạn phải triển khai giao diện dựa trên thẻ cho tiện ích bổ sung. Sử dụng tập lệnh Apps Script Dịch vụ thẻ hoặc nếu bạn đang viết bằng ngôn ngữ mã khác, hãy trả về JSON được định dạng đúng cách để giao diện hiển thị dưới dạng thẻ.
Bạn cũng phải triển khai bất kỳ điều kiện kích hoạt nào hàm được chỉ định trong tệp kê khai tiện ích bổ sung. Nếu tiện ích bổ sung kết nối với một dịch vụ của bên thứ ba, không phải của Google khi sử dụng OAuth, bạn phải định cấu hình OAuth cho .
Thẻ dựng
Bạn xác định giao diện người dùng của tiện ích bổ sung bằng cách tạo các đối tượng Card và điền các đối tượng đó bằng tiện ích. Hàm kích hoạt được chỉ định trong
tệp kê khai của bạn phải trả về một
đối tượng Card hoặc một mảng
Đối tượng Card biểu thị
các "trang" khác nhau của giao diện tiện ích bổ sung. Tiện ích bổ sung cũng có thể tạo và hiển thị thẻ mới để phản hồi các hành động của người dùng.
Trong Apps Script, bạn tạo thẻ bằng
Lớp CardBuilder. Mỗi thẻ cần có một CardHeader và một hoặc nhiều CardSections. Bạn nên điền sẵn từng phần thẻ bằng các tiện ích riêng lẻ tạo nên giao diện tiện ích bổ sung. Tương tác
các tiện ích là
thường được liên kết với hành động để xác định
hành vi tương tác của họ.
Sau khi thêm tất cả các phần và tiện ích vào thẻ thông qua CardBuilder, bạn phải gọi CardBuilder.build() để tạo đối tượng Card tương ứng.
Bạn có thể sử dụng các dịch vụ Apps Script tích hợp sẵn khác như CalendarApp để truy xuất thông tin hiển thị trong các thẻ bổ sung mà bạn tạo.
Bạn có thể sử dụng dữ liệu được tìm nạp từ các dịch vụ không phải của Google.
Nếu tiện ích bổ sung của bạn cần quyền truy cập vào các API không phải của Google yêu cầu OAuth, bạn phải định cấu hình và kết nối với dịch vụ đó. Hãy xem Hướng dẫn kết nối với các dịch vụ không phải của Google để biết thêm thông tin chi tiết.
Đơn đặt hàng xây dựng
Khi tạo thẻ, bạn phải tạo từ trên lên. Tức là bạn phải sử dụng lệnh xây dựng:
- Tạo tiện ích.
- Thêm tiện ích vào phần thẻ.
- Lặp lại cho đến khi phần thẻ có tất cả tiện ích.
- Thêm phần thẻ vào thẻ.
Điều này là bắt buộc vì khi thêm một tiện ích vào thẻ hoặc phần thẻ, bạn thực sự đang thêm một bản sao của tiện ích đó. Mọi thay đổi mà bạn thực hiện đối với đối tượng tiện ích sau khi thêm đối tượng đó sẽ không được phản ánh trong thẻ cuối cùng.
Thao tác chung
Bạn có thể dùng các thao tác chung để cung cấp chức năng độc lập với ngữ cảnh. Thao tác chung là các mục trong trình đơn có trong giao diện người dùng của tiện ích bổ sung, bất kể đó là thẻ nào được hiển thị. Tất cả thao tác chung đã xác định luôn xuất hiện trong trình đơn thẻ của tiện ích bổ sung.
Xem Hành động chung để tìm hiểu thêm chi tiết.
Xác minh phạm vi OAuth của tiện ích bổ sung
Phạm vi xác định những hành động mà được phép tải thay mặt người dùng. Tiện ích bổ sung chỉ nên có phạm vi cho các hành động mà chúng phải có để hoạt động và không có gì khác.
Trong các dự án tiện ích bổ sung, hãy thiết lập rõ ràng tiện ích bổ sung các phạm vi khác để đảm bảo tiện ích bổ sung này sử dụng tập hợp phạm vi ít cho phép nhất nhất có thể. Bạn xác định những phạm vi mà tiện ích bổ sung của bạn sử dụng tiện ích bổ sung tệp kê khai.
Xem phần Phạm vi để biết thêm thông tin chi tiết.
Kiểm thử tiện ích bổ sung
Bạn có thể kiểm thử các tiện ích bổ sung chưa phát hành bằng cách cài đặt tiện ích bổ sung chưa phát hành. Sau khi cài đặt và uỷ quyền, bạn có thể sử dụng tiện ích bổ sung trong tài khoản của mình và kiểm thử giao diện cũng như hành vi của tiện ích bổ sung đó trong các ứng dụng lưu trữ mà tiện ích bổ sung đó mở rộng. Bạn nên xác minh rằng tiện ích bổ sung hoạt động như được mong đợi cho ngữ cảnh và hành động của người dùng.
Hãy xem bài viết Kiểm thử tiện ích bổ sung của Google Workspace để biết thêm thông tin.
Phát hành tiện ích bổ sung
Khi bạn phát hành tiện ích bổ sung, tiện ích đó sẽ được cung cấp cho người khác, công khai hoặc chỉ cho người dùng trong miền của bạn. Trước khi bạn bắt đầu xuất bản hãy nhớ xem lại thông tin tổng quan về việc xuất bản. Xuất bản là một quy trình phức tạp, cần đến sự chuẩn bị và hoàn thành.
Các tiện ích bổ sung của Google Workspace được xuất bản lên Google Workspace Marketplace. Các tiện ích bổ sung có sẵn công khai phải hoàn tất quy trình xem xét ứng dụng trước khi được phát hành.
Hãy xem bài viết Xuất bản tiện ích bổ sung dành cho Google Workspace để biết thêm thông tin chi tiết.