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

Tìm hiểu cách thiết kế, xây dựng và xuất bản tiện ích bổ sung cho Google Workspace:

1. Xác định những ứng dụng Google Workspace mà bạn muốn người dùng có thể sử dụng tiện ích bổ sung của mình.
2. Thiết lập các 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 cũng như 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.

Tạo một tiện ích bổ sung bằng Apps Script hoặc HTTP. Để so sánh hai loại này, hãy xem video "Apps Script so với điểm cuối HTTP: Bạn nên chọn loại nào? 🤔".

Chọn các ứng dụng lưu trữ của Google Workspace

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

• Gmail
• Lịch Google
• Google Chat
• Google Tài liệu
• Google Drive
• Google Meet
• Google Trang tính
• Google Trang trình bày

Để tạo ứng dụng cho Google Workspace, hãy xem phần Mở rộng giao diện người dùng Google Workspace.

Thiết lập các 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 một ngôn ngữ khác ngoài Apps Script, bạn chỉ cần tạo một dự án trên Google Cloud.

Để tạo một tiện ích bổ sung, bạn phải định cấu hình cả dự án tập lệnh và dự án trên đám mây.

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 duy nhất để sở hữu các dự án và quyết định những tài khoản 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ể hỗ trợ lập trình và kiểm thử.

Cảnh báo: Nếu bạn không thêm cộng tác viên vào các dự án tiện ích bổ sung, hãy chuyển quyền sở hữu các dự án đó 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 quyền truy cập vào mã và chế độ cài đặt của tiện ích bổ sung.

Dự án Apps Script

Trước khi tạo tiện ích bổ sung, hãy xem hạn mức và giới hạn của Apps Script để điều chỉnh thiết kế dự án theo các nguyên tắc này. Apps Script phù hợp nhất để phát triển các tiện ích bổ sung cá nhân hoặc nội bộ có cơ sở người dùng nhỏ. Nếu tiện ích bổ sung của bạn cần hỗ trợ nhiều người dùng, độ trễ thấp hoặc toàn quyền kiểm soát cơ sở hạ tầng, hãy cân nhắc một thời gian chạy khác.

Tạo các 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 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 trong bộ nhớ dùng chung đảm bảo rằng tất cả cộng tác viên đều 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 duy nhất sẽ là nhà xuất bản. Tài khoản xuất bản phải có quyền chỉnh sửa đối với dự án tập lệnh, nhưng không cần 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 trên Google Cloud

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 đảm bảo rằng 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.

Để tạo một dự án trên Google Cloud, hãy xem phần Tạo một dự án trên Google Cloud.

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

Quyết định cách tiện ích bổ sung của bạn sẽ xuất hiện và hoạt động trước khi bạn tạo tiện ích đó. Hãy cân nhắc những trường hợp sử dụng mà tiện ích bổ sung này giải quyết. Bắt đầu bằng một thiết kế cơ bản để bắt đầu làm việc trước, sau đó thêm các điểm tinh chỉnh.

Lưu ý: Bắt đầu bằng một thẻ cơ bản trên trang chủ, sau đó thêm các tiện ích, thẻ, thành phần điều hướng và hành vi khác. Hãy cân nhắc các thẻ theo bối cảnh mà hành động của người dùng trong ứng dụng lưu trữ kích hoạt, chẳng hạn như mở một chuỗi tin nhắn trong Gmail hoặc sự kiện trên Lịch.

Hãy tham khảo Hướng dẫn về phong cách của tiện ích bổ sung 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

Triển khai thiết kế trong tệp kê khai tiện ích bổ sung. Định cấu hình giao diện và hành vi của tiện ích bổ sung trong tệp kê khai, 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 bài viết Tệp kê khai cho tiện ích bổ sung Google Workspace.

Khi bạn thêm mã và tính năng, hãy cập nhật tệp kê khai nếu cần để xác định giao diện và hành vi cần thiết 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

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

Tạo tiện ích bổ sung

Triển khai giao diện dựa trên thẻ cho tiện ích bổ sung. Sử dụng Dịch vụ thẻ hoặc nếu bạn dùng một ngôn ngữ mã khác, hãy trả về JSON được định dạng cho giao diện để hiển thị dưới dạng thẻ.

Triển khai mọi hàm kích hoạt được chỉ định trong tệp kê khai của 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 bằng OAuth, hãy định cấu hình OAuth cho dịch vụ đó.

Thẻ Công trình

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à thêm 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 duy nhất 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 này 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 Apps Script, hãy tạo thẻ bằng lớp CardBuilder. Mỗi thẻ đều yêu cầu một CardHeader và một hoặc nhiều CardSections. Đ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 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 chúng.

Sau khi bạn đã thêm tất cả các mục và tiện ích vào thẻ thông qua CardBuilder, hãy gọi CardBuilder.build để tạo đối tượng Card tương ứng.

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

Sử dụng các dịch vụ Apps Script tích hợp sẵn (/apps-script/guides/services/) như CalendarApp để truy xuất thông tin cần hiển thị trong thẻ của tiện ích bổ sung. Sử dụng dữ liệu 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, hãy đị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.

Lệnh xây dựng

Khi bạn tạo thẻ, hãy tạo từ trên xuống. Hãy 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 phần 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à do 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 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: Thêm một tiện ích vào thẻ hoặc phần thẻ sau khi bạn tạo thẻ hoặc phần thẻ đó. Thêm một phần thẻ vào thẻ sau khi thẻ đó được điền đầy đủ các tiện ích. Đừng thay đổi tiện ích hoặc phần sau khi thêm. Để thay đổi một tiện ích đã thêm, hãy tạo lại phần hoặc thẻ đó.

Thao tác chung

Sử dụng thao tác chung để cung cấp chức năng độc lập với bối 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ể thẻ nào. Tất cả các thao tác phổ biến đã xác định đều 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ó thể thực hiện thay mặt cho người dùng. Tiện ích bổ sung chỉ nên có những phạm vi cần thiết để hoạt động.

Trong các dự án tiện ích bổ sung, hãy đặt 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 hạn chế nhất có thể. Xác định các phạm vi 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.

Kiểm thử tiện ích bổ sung

Bạn có thể kiểm thử tiện ích bổ sung chưa xuất bản bằng cách trước tiên cài đặt tiện ích bổ sung chưa xuất bản. Sau khi cài đặt và uỷ quyền, hãy sử dụng tiện ích bổ sung trong tài khoản của bạn để kiểm thử giao diện và hành vi của tiện ích đó trong các ứng dụng lưu trữ mà tiện ích bổ sung mở rộng. Xác minh rằng tiện ích bổ sung hoạt động như mong đợi đố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 Apps Script cho Google Workspace
• Kiểm thử và gỡ lỗi tiện ích bổ sung HTTP cho 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 xuất bản, người khác sẽ có thể sử dụng tiện ích bổ sung của bạn. Trước khi xuất bản, hãy xem tổng quan về việc xuất bản. Xuất bản là một quy trình phức tạp đòi hỏi phải chuẩn bị.

Tiện ích bổ sung của Google Workspace được xuất bản lên Google Workspace Marketplace. Các tiện ích bổ sung được cung cấp công khai phải trải qua quy trình đánh giá ứng dụng trước khi được xuất bản.

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