Khi bạn muốn xây dựng một Google Workspace Tiện ích bổ sung mới, hãy làm theo quy trình chung sau:
- Thiết lập các dự án tiện ích bổ sung của bạn rồi chọn chủ sở hữu và cộng tác viên.
- Thiết kế giao diện và hành vi 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 ứng dụng lưu trữ mà tiện ích đó mở rộng.
- Phát hành tiện ích bổ sung.
Thiết lập các dự án tiện ích bổ sung của bạn 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 một ngôn ngữ không phải là 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 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 như các tuỳ chọn cài đặt liên kết, trong khi các cộng tác viên có thể giúp bạn lập trình và kiểm thử.
Dự án Apps Script
Bạn có thể tạo tệp dự án Apps Script của tiện ích bổ sung trong bộ nhớ dùng chung để không có 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 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, một tài khoản người dùng sẽ đó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 bạn không cần phải là chủ sở hữu.
Dự án trê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 một người trong nhóm của bạn luôn có thể truy cập vào chế độ cài đặt Cloud của tiện ích bổ sung.
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. Hãy bắt đầu với một thiết kế đơn giản để bắt đầu, sau đó thêm các tinh chỉnh khác.
Tham khảo Google Workspace Hướng dẫn về phong cách 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 tiện ích bổ sung của bạn.
Đị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. Nó 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ị chính xác tiện ích bổ sung.
Xem Tệp kê khai để biết thông tin chi tiết về cách định cấu hình tệp kê khai 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 tiện ích bổ sung bắt buộc.
Mã hóa 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. Hãy 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 cho giao diện để kết xuất 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 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ụ đó.
Tạo thẻ
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 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 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 hành động của người dùng.
Trong tập lệnh Apps, bạn tạo các 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 tiện ích bổ sung trong mỗi thẻ. Tiện ích tương tác, thường được liên kết với hành động để xác định hành vi tương tác của 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 cần 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
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 nhưng cần có 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.
Lệnh xây dựng
Khi xây dựng thẻ, bạn phải xây dựng từ trên lên. Tức là bạn phải sử dụng thứ tự xây dựng sau:
- Tạo tiện ích.
- Thêm tiện ích vào phần thẻ.
- Lặp lại cho đến khi mục thẻ có tất cả các tiện ích.
- Thêm mục thẻ vào thẻ.
Điều này là bắt buộc vì khi bạn thêm một tiện ích vào thẻ hoặc mục thẻ, bạn thực sự đang 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 với 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 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 thay mặt người dùng. Phương pháp hay nhất là các tiện ích bổ sung chỉ có phạm vi cho các thao tác phải có trong hàm 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 tập hợp 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 của tiện ích bổ sung.
Vui lòng xem nội dung Phạm vi để biết thêm thông tin chi tiết.
Thử nghiệm tiện ích bổ sung
Bạn có thể thử nghiệm 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 xuất bản trước. 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, đồng thời kiểm tra hình thức 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ư mong đợi trong ngữ cảnh và hành động của người dùng.
Hãy xem Thử nghiệm Google Workspace Tiện ích bổ sung để 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 có thể cung cấp tiện ích đó 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ắt đầu quá trình phát hành, hãy nhớ xem lại phần tổng quan về ấn bản. Ấn bản là một quy trình phức tạp, đòi hỏi bạn phải chuẩn bị và dành thời gian để hoàn tất.
Google Workspace Tiện ích bổ sung được phát hành trên Google Workspace Marketplace. Các tiện ích bổ sung công khai phải hoàn tất quá trình xem xét ứng dụng trước khi được phát hành.
Xem Tiện ích Google Workspace phát hành để biết thêm thông tin chi tiết.
Google Workspace Ví dụ về tiện ích bổ sung
Để giúp bạn hiểu cách Google Workspace tạo các tiện ích bổ sung, Google Workspace tiện ích bổ sung"Mèo" sẽ hướng dẫn cách tạo một tiện ích bổ sung Google Workspace đơn giản, bao gồm trang chủ, chế độ điều hướng thẻ và các kết nối với dịch vụ của 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 với mã.