Tạo tiện ích bổ sung cho Google Workspace

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:

  1. Thiết lập các dự án của tiện ích bổ sung và chọn một chủ sở hữu và cộng tác viên.
  2. Thiết kế giao diện và hành vi của tiện ích bổ sung.
  3. Đị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.
  4. Viết mã để xác định giao diện và hành vi của tiện ích bổ sung.
  5. Xác minh phạm vi OAuth của tiện ích bổ sung.
  6. 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.
  7. Xuất bản tiện ích bổ sung.

Thiết lập các dự án của tiện ích bổ sung, đồng thời chọn một 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ông phải là Apps Script, thì 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 xem tài khoản nào khác là cộng tác viên. Chủ sở hữu dự án tạo và quản lý các tệp dự án cùng với các chế độ cài đặt liên quan, còn cộng tác viên có thể giúp 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 một 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 vào bộ nhớ dùng chung đả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 tiện ích bổ sung, một tài khoản người dùng đó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.

Các dự án trên 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. Điều 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 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 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 giao diện của tiện ích bổ sung và cách hoạt động của tiện ích bổ sung đó trước khi bắt đầu xây dựng. 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. Trước tiên, hãy bắt đầu với một thiết kế đơn giản để bắt đầu, sau đó thêm các nhãn tinh lọc khác.

Tham khảo Hướng dẫn định kiểu cho 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.

Định cấu hình tệp kê khai của dự án 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. Tệp 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 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 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 của tiện ích bổ sung bắt buộc.

Lập 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 Dịch vụ thẻ của Apps Script 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 cho 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ụ 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ẻ cấu trúc

Bạn xác định giao diện người dùng tiện ích bổ sung bằng cách tạo các đối tượng Card và điền tiện ích vào các đối tượng đó. 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 nhiều "trang" 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ị thẻ mới để phản hồi thao tác của người dùng.

Trong Apps Script, bạn sẽ tạo thẻ bằng cách sử dụng lớp CardBuilder. Mỗi thẻ yêu cầu phải có một CardHeader và một hoặc nhiều CardSections. Bạn nên điền từng tiện ích tạo nên giao diện tiện ích bổ sung vào từng phần của thẻ. Các tiện ích tương tác, thường được liên kết với các thao tác để xác định hành vi tương tác của các tiện ích đó.

Sau khi đã thêm tất 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 khác như CalendarApp để truy xuất thông tin nhằm 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 trên Google Workspace cần quyền truy cập vào các API không phải của Google mà đòi hỏi phải sử dụng OAuth, thì 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.

Lệnh 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 thứ tự xây dựng sau:

  1. Tạo tiện ích.
  2. Thêm tiện ích vào phần thẻ.
  3. Lặp lại cho đến khi phần thẻ chứa tất cả tiện ích.
  4. 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ẻ, thực ra bạn đang thêm 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 thao tác chung để cung cấp chức năng không phụ thuộc vào ngữ cảnh. Thao tác chung là các mục trong trình đơn có sẵn trong giao diện người dùng tiện ích bổ sung, bất kể thẻ nào 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 bài viết 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à tiện ích bổ sung chỉ có phạm vi cho các hành động mà chúng phải có ở hàm thứ tự và không có phạm vi nào khác.

Trong các dự án tiện ích bổ sung, hãy thiết lập rõ ràng các phạm vi tiện ích bổ sung để đảm bảo tiện ích bổ sung sử dụng nhóm phạm vi có quyền hạn chế thấp nhất có thể. Bạn xác định phạm vi mà tiện ích bổ sung của bạn sử dụng trong tệp kê khai của tiện ích bổ sung.

Hãy xem phần Phạm vi để biết thêm thông tin chi tiết.

Thử nghiệm tiện ích bổ sung

Trước tiên, 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, đồng thời kiểm tra 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 bổ sung đó mở rộng. Bạn nên xác minh rằng tiện ích bổ sung sẽ 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 Thử nghiệm tiện ích bổ sung của Google Workspace để biết thêm thông tin chi tiết.

Phát hành tiện ích bổ sung

Khi phát hành tiện ích bổ sung, bạn sẽ hiển thị tiện ích bổ sung đó cho người khác, 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 phát hành, hãy nhớ xem lại phần tổng quan về ấn bản. Phát hành là một quy trình phức tạp, cần sự chuẩn bị và thời gian để hoàn thành.

Tiện ích bổ sung của Google Workspace được phát hành lên Google Workspace Marketplace. Các tiện ích bổ sung được phát hành công khai phải hoàn tất quá trình xem xét ứng dụng trước khi phát hành.

Vui lòng xem bài viết Xuất bản tiện ích bổ sung của Google Workspace để biết thêm thông tin chi tiết.