Trang này giải thích cách định cấu hình và triển khai ứng dụng Google Chat dưới dạng Tiện ích bổ sung của 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 ứng dụng Chat bằng API Google Chat. Chế độ cài đặt cấu hình API Chat là nơi bạn chỉ định tất cả thông tin chi tiết về ứng dụng Chat, bao gồm tên, hình đại diện, cách 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
HTTP
- Tài khoản Google Workspace dành cho doanh nghiệp hoặc doanh nghiệp lớn có quyền truy cập vào Google Chat.
- Tạo dự án trên Google Cloud.
- Định cấu hình màn hình xin phép bằng OAuth.
- Bật các API Google Workspace sau:
- Google Chat API
- API Tiện ích bổ sung của Google Workspace
- Một điểm cuối HTTP lưu trữ cấu trúc dịch vụ cho ứng dụng Chat.
Apps Script
- Tài khoản Google Workspace dành cho doanh nghiệp hoặc doanh nghiệp lớn có quyền truy cập vào Google Chat.
- Tạo dự án trên Google Cloud.
- Định cấu hình màn hình xin phép bằng OAuth.
- Bật API Google Chat.
- Tạo một dự án Apps Script độc lập và bật Dịch vụ trò chuyện nâng cao.
- Định cấu hình tính năng Chat trong tệp kê khai bằng cách thêm đối tượng
addons.chat
và mọi phạm vi bắt buộc (oauthScopes
) hoặc tiền tố URL HTTPS (urlFetchWhitelist
).
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ẽ được hiển thị cho 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 xem hoặc sử dụng thông tin này theo các cách sau:
- @đề cập đến ứng dụng Chat để thêm ứng dụng đó 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 thư, người dùng có thể duyệt qua các ứng dụng Chat và xem tên, hình đại diện và nội dung mô tả của ứ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 hiển thị dưới dạng hình đại diện của ứng dụng Chat. | URL HTTPS trỏ đến một hình ảnh đồ hoạ hình 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 sẽ chỉ định thông tin này trong phần cài đặt cấu hình trong API Chat.
Định cấu hình ứng dụng Chat trong Google Cloud Console
Khi bạn có thông tin chi tiết về ứng dụng Chat, hãy mở dự án trên Google Cloud và định cấu hình API Chat:
Trong Google Cloud Console, hãy chuyển đến trang Chat API rồi nhấp vào trang Cấu hình:
Trong mục Thông tin ứng dụng, hãy điền vào các trường Tên ứng dụng, URL hình đại diện và Nội dung mô tả.
Trong phần Tính năng tương tác, hãy nhấp vào nút 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 một hoặc nhiều hộp đánh dấu để cho phép cài đặt và sử dụng ứng dụng Chat:
Nhận tin nhắn 1:1: 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 dành riêng cho người dùng và ứng dụng Chat.
Tham gia không gian và cuộc trò chuyện nhóm: Người dù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 phần Cài đặt kết nối, hãy chọn cấu trúc mà bạn muốn sử 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 dự án Google Apps Script, hãy chọn Apps Script rồi cung cấp mã triển khai cho dự án.
Không bắt buộc: Để nhận đối tượng sự kiện cho nhiều điểm cuối hoặc hàm, hãy chuyển đến phần Cài đặt nâng cao > Điều kiện kích hoạt rồi cung cấp hoặc cập nhật các hàm gọi lại cho Điều kiện kích hoạt cuộc trò chuyện sau:
- ADDED_TO_SPACE: Người dùng thêm ứng dụng Chat vào một cuộc trò chuyện nhóm hoặc không gian, hoặc cài đặt ứng dụng Chat để gửi tin nhắn 1:1.
- MESSAGE (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.
- REMOVED_FROM_SPACE: Người dùng gỡ cài đặt hoặc xoá ứng dụng Chat khỏi một không gian.
Không bắt buộc: Thêm các tính năng tương tác khác như lệnh gạch chéo hoặc bản xem trước đường liên kết.
Trong phần Chế độ hiển thị, hãy chỉ định email của bạn để bạn có thể cài đặt và kiểm thử ứng dụng Chat trước khi phát hành 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 phần 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ề API Chat.
Nhấp vào Lưu.
Sau khi bạn lưu cấu hình, bất kỳ ai 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 Chat yêu cầu 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 SDK Google Workspace Marketplace.
- Ứng dụng Chat 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 Google Workspace khác trong đối tượng
addons.common
của manifest. - Đối với các tiện ích bổ sung được phát hành trên Google Workspace Marketplace, bạn không thể lưu bản nháp của mọi thay đổi đối với chế độ cài đặt cấu hình API Google Chat. Sau khi bạn cập nhật và lưu chế độ cài đặt cấu hình Chat API, tất cả người dùng hiện tại đều có thể sử dụng ứng dụng Chat đã cập nhật. Để cập nhật trang thông tin trên trang web thương mại, bạn có thể tạo bản nháp trước khi gửi nội dung thay đổi.
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ã triển khai Apps Script mà bạn sử dụng cho phần cấu hình bổ sung còn lại.
- Bạn không thể sử dụng trình chỉnh sửa Apps Script để cài đặt các bản triển khai kiểm thử trong Chat. Thay vào đó, bạn phải cài đặt trực tiếp các tiện ích đó 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 cấu hình ứng dụng Chat trong tệp kê khai và các bản triển khai mà bạn tạo bằng API tiện ích bổ sung của Google Workspace. Các lượt triển khai HTTP mà bạn chỉ định trong SDK Google Workspace Marketplace chỉ được dùng cho các ứng dụng Google Workspace khác.
Chủ đề có liên quan
- Để quản lý quyền truy cập vào API Chat, hãy xem phần Định cấu hình API Google Chat trong tài liệu về API Google Chat.
- Kiểm thử các tính năng tương tác cho ứng dụng Google Chat
- Xuất bản ứng dụng Google Chat