Trang này giải thích cách định cấu hình và triển khai một ứng dụng Google Chat dưới dạng tiện ích bổ sung cho Google Workspace.
Để triển khai và kiểm thử một tiện ích bổ sung Google Workspace mở rộng Chat, bạn phải bật và định cấu hình một ứng dụng Chat bằng Google Chat API. Chế độ cài đặt cấu hình Chat API là nơi bạn chỉ định tất cả thông tin chi tiết về ứng dụng Chat, bao gồm cả tên, hình đại diện, việc triển khai và các tính năng tương tác mà bạn muốn sử dụng.
Điều kiện tiên quyết
- Tài khoản Google Workspace Business hoặc Enterprise có quyền truy cập vào Google Chat.
- Tạo một dự án trên Google Cloud.
- Định cấu hình màn hình đồng ý OAuth.
- Bật Google Chat API.
Chọn tên hiển thị, hình đại diện và nội dung mô tả cho ứng dụng Chat
Tên, hình đại diện và nội dung mô tả của ứng dụng Chat sẽ xuất hiện với người dùng trong giao diện người dùng Chat. Để tương tác với các ứng dụng Chat, người dùng sẽ thấy hoặc sử dụng thông tin này theo những cách sau:
- @đề cập đến ứng dụng Chat để thêm ứng dụng này vào một không gian hoặc gửi tin nhắn cho ứng dụng.
- Tìm và bắt đầu một tin nhắn trực tiếp bằng ứng dụng Chat. Trong trình đơn Ứng dụng, tin nhắn trực tiếp sẽ hiển thị tên và hình đại diện của ứng dụng Chat.
- Trên thanh soạn tin, người dùng có thể duyệt xem các ứng dụng Chat và xem tên, hình đại diện cũng như nội dung mô tả của các ứng dụng đó.
Trước khi định cấu hình ứng dụng Chat, bạn phải chuẩn bị những thông tin sau:
Trường | Mô tả | Định dạng |
---|---|---|
Tên ứng dụng | Tên hiển thị của ứng dụng Chat. | Tối đa 25 ký tự chữ và số |
URL hình đại diện | Hình ảnh xuất hiện dưới dạng hình đại diện của ứng dụng Chat. | Một URL HTTPS trỏ đến hình ảnh đồ hoạ vuông (PNG hoặc JPEG). Kích thước đề xuất là 256 x 256 pixel trở lên. |
Mô tả | Nội dung mô tả ngắn gọn về mục đích của ứng dụng Chat. | Tối đa 40 ký tự bao gồm chữ và số |
Trong phần sau, bạn chỉ định thông tin này trong phần cài đặt cấu hình của Chat API.
Định cấu hình ứng dụng Chat trong Google Cloud Console
Trong Google Cloud Console, bạn định cấu hình thông tin chi tiết về ứng dụng Chat mà người dùng nhìn thấy trong Chat, bao gồm cả tên hiển thị, hình đại diện và nội dung mô tả. Những thông tin này chỉ xuất hiện trong Chat. Để xuất bản ứng dụng Chat lên Marketplace, bạn cũng phải chỉ định thông tin chi tiết xuất hiện trong trang thông tin trên Marketplace của ứng dụng Chat.
Khi bạn có thông tin chi tiết về ứng dụng Chat, hãy mở dự án trên Cloud và định cấu hình Chat API:
Trong Google Cloud Console, hãy chuyển đến trang Chat API rồi nhấp vào trang Configuration (Cấu hình):
Trong mục Thông tin ứng dụng, hãy điền thông tin vào các trường Tên ứng dụng, URL hình đại diện và Nội dung mô tả.
Trong mục Tính năng tương tác, hãy nhấp vào Bật tính năng tương tác để chuyển sang vị trí bật rồi hoàn tất các bước sau:
Trong phần Chức năng, hãy chọn Tham gia không gian và cuộc trò chuyện nhóm để cho phép cài đặt và sử dụng ứng dụng Chat.
Theo mặc định, người dùng có thể cài đặt và nhắn tin bằng ứng dụng Chat trong một không gian riêng giữa người dùng và ứng dụng Chat. Người dùng cũng có thể thêm và tương tác với ứng dụng Chat trong không gian có nhiều người.
Trong mục Connection settings (Chế độ cài đặt kết nối), hãy chọn cấu trúc mà bạn muốn dùng để nhận các đối tượng sự kiện từ Chat:
- Để sử dụng dịch vụ HTTP, hãy chọn URL điểm cuối HTTP và cung cấp một URL.
- Để sử dụng một dự án Google Apps Script, hãy chọn Apps Script rồi cung cấp một mã nhận dạng triển khai cho dự án đó.
Không bắt buộc: Để nhận các đối tượng sự kiện cho nhiều điểm cuối hoặc hàm, hãy chuyển đến phần Connection settings (Cài đặt kết nối) > Triggers (Trình kích hoạt) rồi cung cấp hoặc cập nhật các hàm gọi lại cho Chat triggers (Trình kích hoạt trò chuyện) sau đây:
- Được thêm vào không gian: Người dùng thêm ứng dụng Chat vào cuộc trò chuyện nhóm hoặc không gian, hoặc cài đặt ứng dụng Chat cho tin nhắn 1:1.
- Tin nhắn: Người dùng gửi tin nhắn đến ứng dụng Chat. Ví dụ: gửi tin nhắn trực tiếp đến ứng dụng Chat hoặc @đề cập đến ứng dụng Chat trong một không gian có nhiều người.
- Đã xoá khỏi không gian: Người dùng gỡ cài đặt hoặc xoá ứng dụng Chat khỏi một không gian.
- Lệnh ứng dụng: Người dùng sử dụng lệnh nhanh hoặc lệnh dấu gạch chéo trong ứng dụng Chat.
Không bắt buộc: Thêm các tính năng tương tác khác, chẳng hạn như lệnh nhanh, lệnh gạch chéo hoặc bản xem trước đường liên kết.
Trong mục Chế độ hiển thị, hãy chỉ định email của bạn để có thể cài đặt và kiểm thử ứng dụng Chat trước khi xuất bản lên Google Workspace Marketplace. Bạn có thể chỉ định tối đa 5 cá nhân hoặc một hoặc nhiều Nhóm Google trong tổ chức Google Workspace của mình.
Không bắt buộc: Trong mục Nhật ký, hãy chọn hộp đánh dấu Ghi lỗi vào Logging để sử dụng Google Cloud Logging. Để biết thêm thông tin, hãy xem phần Truy vấn nhật ký lỗi cho ứng dụng Chat trong tài liệu về Chat API.
Nhấp vào Lưu.
Sau khi bạn lưu cấu hình, bất kỳ người nào mà bạn chỉ định trong chế độ cài đặt Chế độ hiển thị của Chat API đều có thể cài đặt, kiểm thử hoặc sử dụng ứng dụng Chat. Để bắt đầu kiểm thử và gỡ lỗi ứng dụng Chat, hãy xem phần Kiểm thử các tính năng tương tác cho ứng dụng Google Chat trong tài liệu về Chat API.
Những điều cần cân nhắc đối với các tiện ích bổ sung hiện có của Google Workspace
Các ứng dụng trò chuyện yêu cầu một cấu hình khác so với các tiện ích bổ sung của Google Workspace mở rộng các ứng dụng khác của Google Workspace. Nếu tiện ích bổ sung của bạn mở rộng các ứng dụng khác của Google Workspace, hãy cân nhắc các yêu cầu sau để định cấu hình ứng dụng Chat:
- Cả cá nhân và quản trị viên Google Workspace đều phải có thể cài đặt tiện ích bổ sung của bạn từ Marketplace. Bạn định cấu hình các chế độ cài đặt này trong Google Workspace Marketplace SDK.
- Các ứng dụng nhắn tin không sử dụng tên và biểu trưng mà bạn định cấu hình cho các ứng dụng khác của Google Workspace trong đối tượng
addons.common
của tệp kê khai. - Đối với các tiện ích bổ sung được xuất bản lên Google Workspace Marketplace, bạn không thể lưu bản nháp của bất kỳ thay đổi nào đối với chế độ cài đặt cấu hình Google Chat API. Sau khi bạn cập nhật và lưu chế độ cài đặt cấu hình Chat API, ứng dụng Chat đã cập nhật sẽ có sẵn cho tất cả người dùng hiện tại. Để cập nhật trang thông tin của bạn trên Marketplace, bạn có thể tạo bản nháp trước khi gửi bất kỳ thay đổi nào.
Nếu bạn tạo tiện ích bổ sung bằng Apps Script:
- Bạn phải sử dụng cùng một mã nhận dạng triển khai Apps Script mà bạn dùng cho phần còn lại của cấu hình tiện ích bổ sung.
- Bạn không thể dùng trình chỉnh sửa Apps Script để cài đặt các bản triển khai thử nghiệm trong Chat. Thay vào đó, bạn phải cài đặt các tiện ích này trực tiếp từ giao diện người dùng Chat.
Nếu bạn tạo tiện ích bổ sung bằng dịch vụ HTTP, hãy bỏ qua mọi thông tin chi tiết về cấu hình ứng dụng Chat trong tệp kê khai và các hoạt động triển khai mà bạn tạo bằng API tiện ích bổ sung của Google Workspace. Các hoạt động triển khai HTTP mà bạn chỉ định trong Google Workspace Marketplace SDK chỉ được dùng cho các ứng dụng khác trên Google Workspace.
Chủ đề có liên quan
- Để quản lý quyền truy cập vào Chat API, hãy xem phần Định cấu hình Google Chat API trong tài liệu về Google Chat API.
- Kiểm thử các tính năng tương tác cho ứng dụng Google Chat