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 dự án tiện ích bổ sung và 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 của tiện ích bổ sung hoặc tài nguyên triển khai.
- 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 lưu trữ ứng dụng nó sẽ 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 bạn 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 bạn tạo tiện ích bổ sung bằng ngôn ngữ không phải là Apps Script, 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 để sở hữu dự án và quyết định tài khoản nào khác cộng tác viên. 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. Đang đặt tiện ích bổ sung tệp tập lệnh trong một 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 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 tiện ích bổ sung Dự án trên đám mây. Việc này giúp đảm bảo thành viên trong nhóm của bạn luôn có thể truy cập vào 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
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. Bắt đầu với thiết kế đơn giản để bắt đầu hoạt động trước, sau đó bổ sung các tinh chỉnh khác.
Tham khảo Hướng dẫn về quy tắc lập trình cho tiện ích bổ sung của Google Workspace để biết các nguyên tắc về cách thiết kế tiện ích bổ sung cho người dùng của bạn.
Đị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 dành cho 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 của mình, hãy chỉnh sửa tệp kê khai nếu cần để tạo tiện ích bổ sung bắt buộc giao diện và hành vi.
Viết mã cho 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 rồi điền chúng vào
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. Thông tin
"tiện ích bổ sung" cũng có thể tạo và hiển thị thẻ mới trong
phản hồi hành động của người dùng.
Trong Apps Script, bạn tạo thẻ bằng cách sử dụng
Lớp CardBuilder. Một
thẻ yêu cầu CardHeader
và một hoặc nhiều
CardSections. Bạn nên
điền vào 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 bạn đã thêm tất cả các phần và tiện ích vào thẻ của mình 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 Apps Script tích hợp khác
các dịch vụ như
CalendarApp để truy xuất
để hiển thị trong 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 của Google Workspace cần quyền truy cập vào các API không phải của Google có yêu cầu OAuth, bạn phải định cấu hình và kết nối với dịch vụ đó—xem phần Kết nối với Hướng dẫn về các dịch vụ không phải của Google dành cho chi tiết hơn.
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 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 tiện ích vào thẻ hoặc mục thẻ, bạn thực sự đang thêm bản sao của tiện ích đó. Mọi thay đổi bạn thực hiện đối với tiện ích sau khi thêm vào 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 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ả cá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. Đó là phương pháp hay nhất để tiện ích bổ sung chỉ xác định phạm vi cho các hành động mà tiện ích bổ sung phải có trong chức năng theo thứ tự 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 nhau để đả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 được xuất bản bằng cách cài đặt đã huỷ xuất bản . Sau khi cài đặt và cho phép, bạn có thể sử dụng tiện ích bổ sung trong tài khoản của bạn, đồng thời kiểm thử giao diện và hành vi của tài khoản trong các ứng dụng lưu trữ mà nó hoạt động 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
Xuất bản tiện ích bổ sung của bạn để người khác có thể sử dụng tiện ích đó, công khai hoặc chỉ 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. Cung cấp công khai tiện ích bổ sung phải hoàn tất quy trình xem xét ứng dụng trước chúng được xuất bản.
Xem phần Xuất bản tiện ích bổ sung của Google Workspace để chi tiết hơn.