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

Trang này cung cấp thông tin tổng quan về cách thiết kế, tạo và phát hành tiện ích bổ sung cho Google Workspace. Phần tổng quan này giải thích các bước sau:

1. Xác định các ứng dụng Google Workspace mà bạn muốn người dùng sử dụng tiện ích bổ sung.
2. Thiết lập dự án của tiện ích bổ sung và chọn chủ sở hữu cũng như cộng tác viên.
3. Thiết kế và định cấu hình giao diện và hành vi của tiện ích bổ sung.
4. Tạo 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 một hoặc nhiều ứng dụng Google Workspace.
7. Xuất bản tiện ích bổ sung.

Chọn ứng dụng lưu trữ trên Google Workspace

Bạn có thể định cấu hình tiện ích bổ sung của Google Workspace để xuất hiện trong các ứng dụng lưu trữ Google Workspace sau:

• Gmail
• Lịch Google
• Google Chat (Bản dùng thử cho nhà phát triển)
• Google Tài liệu
• Google Drive
• Google Trang tính
• Google Trang trình bày

Để tìm hiểu cách tạo ứng dụng cho Google Workspace, hãy xem bài viết Mở rộng giao diện người dùng Google Workspace.

Thiết lập dự án của tiện ích bổ sung 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 tạo tiện ích bổ sung bằng ngôn ngữ khác với 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 các dự án và quyết định những 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 chế độ cài đặt liên quan, trong khi cộng tác viên có thể giúp lập trình và kiểm thử.

Cảnh báo: Nếu không thêm cộng tác viên vào dự án tiện ích bổ sung, bạn cần phải chuyển quyền sở hữu dự án cho họ trước khi tài khoản của chủ sở hữu bị đóng hoặc bị xoá. Nếu không, bạn có thể mất toàn bộ quyền truy cập vào mã tiện ích bổ sung và chế độ cài đặt.

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 ổ đĩa dùng chung để không có tài khoản nào có quyền sở hữu riêng. Việc đặt tệp tập lệnh bổ trợ vào một bộ nhớ dùng chung sẽ đảm bảo 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 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.

Để tạo dự án Apps Script, hãy xem phần Dự án tập lệnh.

Dự án trên Google Cloud

Bạn nên thêm cộng tác viên vào dự án trên đám mây của tiện ích bổ sung. Điều này giúp đảm bảo rằng một người nào đó trong nhóm của bạn luôn có thể truy cập vào chế độ cài đặt trên đám mây của tiện ích bổ sung.

Để tạo dự án trên Google Cloud, hãy xem bài viết Tạo dự án trên Google Cloud.

Thiết kế và định cấu hình giao diện và hành vi của tiện ích bổ sung

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

Mẹo: Bắt đầu bằng một thẻ trang chủ đơn giản, sau đó thêm các tiện ích, thẻ, thành phần điều hướng và hành vi khác. Bạn cũng có thể cân nhắc sử dụng thẻ theo ngữ cảnh được kích hoạt bằng hành động của người dùng trong ứng dụng lưu trữ, chẳng hạn như mở luồng thư trên Gmail hoặc sự kiện trên Lịch.

Tham khảo hướng dẫn về kiểu 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 của tiện ích bổ sung.

Định cấu hình tệp kê khai tiện ích bổ sung

Sau khi thiết kế tiện ích bổ sung, bạn có thể bắt đầu triển khai thiết kế đó trong tệp kê khai tiện ích bổ sung. Tệp kê khai là nơi bạn định cấu hình hầu hết giao diện và hành vi của tiện ích bổ sung, bao gồm cả các ứng dụng lưu trữ Google Workspace mà tiện ích bổ sung mở rộng.

Để biết thông tin chi tiết, hãy xem phần Tệp kê khai cho tiện ích bổ sung của Google Workspace.

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 bắt buộc của tiện ích bổ sung.

Định cấu hình giao diện và hành vi của ứng dụng Google Chat

Bản dùng thử cho nhà phát triển: Có trong Chương trình Bản dùng thử cho nhà phát triển Google Workspace, cung cấp quyền truy cập sớm vào một số tính năng.

Nếu đã thiết kế một tiện ích bổ sung mở rộng Google Chat, bạn phải sử dụng API Google Chat để định cấu hình giao diện và hành vi của ứng dụng Chat. Để biết các bước, hãy xem phần Định cấu hình ứng dụng Google Chat.

Tạo 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 một 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 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ụ đó.

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 các đối tượ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ũng có thể tạo và hiển thị thẻ mới để phản hồi hành động của người dùng.

Trong Apps Script, bạn tạo 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 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. 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 chúng.

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.

Lưu ý: Việc không gọi được build() sau khi sử dụng các lớp trình tạo trong dịch vụ Thẻ sẽ dẫn đến lỗi loại. Ví dụ: các hàm kích hoạt phải trả về đối tượng Card. Việc trả về các đối tượng CardBuilder sẽ dẫn đến lỗi.

Bạn có thể sử dụng các dịch vụ Apps Script tích hợp sẵn khác như CalendarApp để truy xuất thông tin hiển thị trong các thẻ 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 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, 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.

Đơn đặt hàng xây dựng

Khi tạo thẻ, bạn phải tạo từ khoản nạp tiền. Nghĩa là, bạn phải sử dụng thứ tự xây dựng này:

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 phần thẻ có tất cả cá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ẻ, bạn thực sự đang thêm một bản sao của tiện ích đó. Mọi thay đổi mà 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.

Cảnh báo: Chỉ thêm tiện ích vào thẻ hoặc phần thẻ sau khi bạn hoàn tất việc tạo thẻ. Chỉ thêm mục thẻ vào thẻ sau khi thẻ đó đã được điền đầy đủ các tiện ích. Không thay đổi tiện ích hoặc mục sau khi thêm. Nếu muốn thay đổi một tiện ích đã thêm, bạn phải tạo lại phần hoặc thẻ mà tiện ích đó được thêm vào.

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 trình đơn có 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ả 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 cho người dùng. Tiện ích bổ sung chỉ nên có phạm vi cho các hành động mà chúng phải có để hoạt động và không có gì khác.

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

Hãy xem phần Phạm vi để biết thêm 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 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 và kiểm thử giao diện cũng như 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 hoạt động như dự kiến đối với các ngữ cảnh và hành động của người dùng.

Để bắt đầu kiểm thử tiện ích bổ sung, hãy xem các hướng dẫn sau:

• Kiểm thử và gỡ lỗi tiện ích bổ sung Google Workspace cho Apps Script
• Kiểm thử và gỡ lỗi tiện ích bổ sung HTTP của Google Workspace
• Kiểm thử các tính năng tương tác cho ứng dụng Google Chat

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

Khi bạn phát hành tiện ích bổ sung, tiện ích đó sẽ được cung cấp 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 quy trình xuất bản, hãy nhớ xem lại tổng quan về ấn bản. Việc phát hành 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.

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

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