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