Xây dựng tiện ích bổ sung của Google Workspace

Khi bạn muốn tạo một Tiện ích bổ sung Google Workspace mới, hãy làm theo quy trình chung sau:

  1. Thiết lập dự án bổ sung của bạn và chọn chủ sở hữu cũng như 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 hoặc tài nguyên triển khai dự án 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 tiện ích bổ sung của bạn.
  6. Kiểm thử tiện ích bổ sung trong ứ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 dự án bổ sung của bạn và chọn chủ sở hữu cũng như 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 bạn tạo tiện ích bổ sung bằng một 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 các 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 của các dự án tạo và quản lý các tệp dự án cũng như các chế độ cài đặt liên kết, trong khi 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 bổ sung của mình trong 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 của bạn vào bộ nhớ dùng chung cho phép bạn dễ dàng đảm bảo rằng nhiều cộng tác viên luôn có quyền truy cập vào dự án tập lệnh.

Khi bạn xuất bản một tiện ích bổ sung, tài khoản người dùng duy nhất đóng vai trò là nhà xuất bản. Tài khoản phát hành phải có quyền chỉnh sửa dự án tập lệnh, nhưng không cần phải là chủ sở hữu.

Các dự án Google Cloud

Bạn nên thêm cộng tác viên vào dự án 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 các tiện ích bổ sung của 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ạn bắt đầu xây dựng. Hãy xem xét những trường hợp sử dụng mà tiện ích bổ sung nên cố gắng cung cấp giải pháp. Hãy bắt đầu với một thiết kế đơn giản để bắt đầu, sau đó bổ sung thêm nhãn tinh lọc.

Tham khảo Google Workspace Hướng dẫn về tiện ích bổ sung để biết các nguyên tắc về cách thiết kế trải nghiệm người dùng bổ sung của bạn.

Định cấu hình tệp kê khai 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. Công cụ 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 thư viện. Đối với Google Workspace Tiện ích bổ sung, 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 chính xác.

Hãy xem Manifests để biết thông tin chi tiết về cách định cấu hình tệp kê khai cho tiện ích bổ sung của bạn 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 cho 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 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 trong tệp kê khai bổ sung được chỉ định. Nếu tiện ích bổ sung của bạn kết nối với một bên thứ ba, không phải dịch vụ của Google bằng OAuth, thì bạn cũng phải định cấu hình OAuth cho dịch vụ đó.

Thẻ xây dựng

Bạn xác định giao diện người dùng bổ sung bằng cách tạo các đối tượng Card và điền chúng bằng 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 hoặc một mảng gồm các đối tượng Card đại diện cho nhiều # 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 hành động của người dùng.

Trong tập lệnh Ứng dụng, bạn tạo thẻ bằng cách sử dụ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 từng tiện ích bổ sung vào từng phần của thẻ để tạo nên giao diện tiện ích bổ sung. 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ụ tích hợp khác của Apps Script như CalendarApp để truy xuất thông tin cần hiển thị trong các thẻ bổ sung mà bạn tạo. Bạn có thể sử dụng dữ liệu tìm nạp từ các dịch vụ không phải của Google.

Nếu Google Workspace 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, thì bạn phải định cấu hình và kết nối với dịch vụ đó. Hãy xem phần 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 xây dựng thẻ, bạn phải xây dựng từ trên cùng. Nghĩa 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 mục thẻ.
  3. Lặp lại cho đến khi mục thẻ có tất cả các tiện ích.
  4. Thêm phần thẻ vào thẻ.

Đây là việc bắt buộc vì khi bạn thêm một tiện ích vào thẻ hoặc phần 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 đối tượng đó sẽ không được phản ánh trong thẻ cuối cùng.

Thao tác chung

Bạn có thể sử dụng thao tác chung để cung cấp chức năng độc lập theo 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 của tiện ích bổ sung, bất kể thẻ nào đang hiển thị. Tất cả các hành động 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 Thao tác chung để biết thêm chi tiết.

Xác minh phạm vi OAuth bổ sung

Phạm vi xác định những hành động mà tiện ích bổ sung được phép thay mặt người dùng thực hiện. Phương pháp hay nhất là các tiện ích bổ sung chỉ có phạm vi cho các hành động mà chúng phải có để hoạt động theo thứ tự và không có gì khác.

Trong các dự án tiện ích bổ sung, hãy đặt phạm vi tiện ích bổ sung một cách rõ ràng để đảm bảo tiện ích bổ sung sử dụng nhóm phạm vi được phép ít nhất có thể. Bạn xác định các phạm vi mà tiện ích bổ sung sử dụng trong tệp kê khai bổ sung.

Hãy xem Phạm vi để biết thêm chi tiết.

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

Bạn có thể kiểm tra các tiện ích bổ sung chưa được xuất bản bằng cách cài đặt tiện ích bổ sung chưa được xuất bản. Sau khi cài đặt và ủy 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 tra giao diện cũng như hành vi của tiện ích bổ sung đó trong các ứng dụng máy chủ 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 phần Thử nghiệm Google Workspace Tiện ích bổ sung để biết thêm thông tin chi tiết.

Xuất bản tiện ích bổ sung

Khi bạn phát hành tiện ích bổ sung, người dùng khác có thể sử dụng tiện ích này, công khai hoặc chỉ trong miền của bạn. Trước khi bắt đầu quá trình phát hành, hãy nhớ xem lại thông tin tổng quan về ấn bản. Xuất bản là một quá trình phức tạp đòi hỏi phải chuẩn bị và thời gian để hoàn thành.

Google Workspace Các tiện ích bổ sung đượ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 đánh giá ứng dụng trước khi được phát hành.

Hãy xem phần Xuất bản Google Workspace tiện ích bổ sung để biết thêm thông tin chi tiết.

Google Workspace Ví dụ về tiện ích bổ sung

 l10n-placeholder41=

Để giúp bạn hiểu cách Google Workspace các tiện ích bổ sung được tạo, phần mềm Google Workspace "Cats" và tiện ích bổ sung minh họa cách tạo một tiện ích bổ sung Google Workspace đơn giản, bao gồm trang chủ, phần điều hướng thẻ và kết nối với dịch vụ bên thứ ba. Sau khi hoàn tất quá trình bắt đầu nhanh, bạn có thể cài đặt tiện ích bổ sung và thử nghiệm bằng mã.