Trang này cung cấp thông tin tổng quan về cách thiết kế, tạo và xuất bản tiện ích bổ sung cho Google Workspace. Phần tổng quan này giải thích các bước sau:
- 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.
- 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.
- 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.
- Tạo 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 một hoặc nhiều ứng dụng Google Workspace.
- Xuất bản tiện ích bổ sung.
Bạn có thể tạo tiện ích bổ sung bằng Apps Script hoặc HTTP. Để so sánh, hãy xem video "Apps Script so với điểm cuối HTTP: Bạn nên chọn cá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 của Google Workspace xuất hiện trong các ứng dụng lưu trữ Google Workspace sau đây:
- 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ì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 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.
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ợ việc viết mã và kiểm thử.
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 để đảm bảo thiết kế dự án của bạn tuân thủ các nguyên tắc này. Apps Script phù hợp nhất cho việc phát triển các tiện ích bổ sung cá nhân hoặc nội bộ có quy mô nhỏ. Nếu bạn dự định tạo một tiện ích bổ sung quy mô lớn cần xử lý nhiều người dùng, yêu cầu độ trễ thấp hoặc cần kiểm soát hoàn toàn cơ sở hạ tầng của mình, hãy cân nhắc phát triển trên một môi trường thời gian chạy khác.
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 duy nhất. Việc đặt tệp kịch bản của 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 kịch bản.
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ẽ đó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 đố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
Bạn nên thêm cộng tác viên vào dự án Cloud của tiện ích bổ sung. Việc này giúp đảm bảo rằng luôn có người trong nhóm của bạ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 xem bạn muốn tiện ích bổ sung của mình trông như thế nào và hoạt động ra sao trước khi bắt đầu 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ên cố gắng cung cấp giải pháp. Bắt đầu bằng một thiết kế đơn giản để bắt đầu hoạt động trước, sau đó thêm các điểm tinh chỉnh khác.
Tham khảo hướng dẫn về phong cách của tiện ích bổ sung Google Workspace để biết hướng dẫn 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ế xong 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 bài viết Tệp kê khai cho tiện ích bổ sung Google Workspace.
Khi bạn thêm mã và các tính năng vào tiện ích bổ sung, hãy chỉnh sửa tệp kê khai khi cần để tạo ra 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 đã thiết kế một tiện ích bổ sung mở rộng Google Chat, bạn phải 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 Định cấu hình ứng dụng Google Chat.
Tạo tiện ích bổ sung
Bạn phải triển khai một 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 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 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ông trình
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 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 bổ trợ. Tiện ích bổ sung cũng có thể tạo và hiển thị thẻ mới để phản hồi các 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ẻ đều cần có một CardHeader và một hoặc nhiều CardSections. Bạn nên đ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 của tiện ích bổ sung. 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 thêm tất cả các mục 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, 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 được tìm nạp từ các dịch vụ không phải của Google.
Nếu cầ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ừ trên xuống. Tức là bạn phải sử dụng thứ tự xây dựng này:
- Tạo tiện ích.
- Thêm tiện ích vào phần thẻ.
- Lặp lại cho đến khi phần thẻ có tất cả các tiện ích.
- Thêm phần thẻ vào thẻ.
Đây là yêu cầu 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.
Thao tác chung
Bạn có thể sử dụng thao tác phổ biến để 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 xuất hiện. Tất cả cá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 các 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. Tốt nhất là các tiện ích bổ sung chỉ nên có phạm vi cho những hành động cần thiết để 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 các 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ể. Bạn xác định những phạm vi mà tiện ích bổ sung của bạn sử dụng trong tệp kê khai tiện ích bổ sung.
Hãy xem phần Phạm vi để biết thêm thông tin chi tiết.
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, bạn có thể sử dụng tiện ích bổ sung này 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 này mở rộng. Bạn nên xác minh rằng tiện ích bổ sung hoạt động như mong đợi đối với các bối 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 bằng Apps Script
- 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, những người khác có thể sử dụng tiện ích bổ sung của bạn, cho dù là công khai hay chỉ dành 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 thông tin tổng quan về ấn phẩm. Xuất bản là một quy trình phức tạp, đòi hỏi bạn phải chuẩn bị và mất thời gian để hoàn tất.
Tiện ích bổ sung của Google Workspace được xuất bản trên Google Workspace Marketplace. Các tiện ích bổ sung được cung cấp công khai phải hoàn tất quy trình xem xét ứ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.