Trang này giải thích cách tạo tiện ích bổ sung của Google Workspace hoạt động trong Google Chat bằng dịch vụ HTTP.
Hướng dẫn khởi động nhanh này chỉ cho bạn cách tạo dịch vụ HTTP bằng các dịch vụ của Google Cloud. Để tạo ứng dụng Chat, bạn sẽ viết và triển khai một hàm Cloud Run mà ứng dụng Chat dùng để phản hồi tin nhắn của người dùng.
Với kiến trúc HTTP, bạn sẽ định cấu hình Chat để tích hợp với Google Cloud hoặc một máy chủ tại chỗ bằng HTTP, như minh hoạ trong sơ đồ sau:
Trong sơ đồ trước đó, một người dùng tương tác với ứng dụng Chat HTTP có luồng thông tin như sau:
- Người dùng gửi tin nhắn trong Chat đến một ứng dụng Chat, có thể là trong tin nhắn trực tiếp hoặc trong một không gian Chat.
- Một yêu cầu HTTP được gửi đến một máy chủ web (có thể là hệ thống trên đám mây hoặc hệ thống tại chỗ) chứa logic của ứng dụng Chat.
- Tuỳ chọn: Logic của ứng dụng Chat có thể tích hợp với các dịch vụ của Google Workspace (như Lịch và Trang tính), các dịch vụ khác của Google (như Maps, YouTube và Vertex AI) hoặc các dịch vụ web khác (như hệ thống quản lý dự án hoặc công cụ tạo phiếu yêu cầu hỗ trợ).
- Máy chủ web gửi phản hồi HTTP trở lại dịch vụ ứng dụng Chat trong Chat.
- Phản hồi được gửi đến người dùng.
- Tuỳ chọn: Ứng dụng Chat có thể gọi API Chat để đăng tin nhắn không đồng bộ hoặc thực hiện các thao tác khác.
Kiến trúc này giúp bạn linh hoạt sử dụng các thư viện và thành phần đã có trong hệ thống vì các ứng dụng Chat này có thể được thiết kế bằng nhiều ngôn ngữ lập trình.
Mục tiêu
- Thiết lập môi trường.
- Tạo và triển khai hàm Cloud Run.
- Định cấu hình tiện ích bổ sung của Google Workspace cho ứng dụng Chat.
- Kiểm thử ứng 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.
- Dự án trên Google Cloud đã bật tính năng thanh toán. Để kiểm tra xem một dự án hiện có đã bật tính năng thanh toán hay chưa, hãy xem bài viết Xác minh trạng thái thanh toán của dự án. Để tạo dự án trên đám mây và thiết lập tính năng thanh toán, hãy xem bài viết Tạo dự án trên Google Cloud.
Thiết lập môi trường
Trước khi sử dụng API của Google, bạn cần bật các API đó trong một dự án trên Google Cloud. Bạn có thể bật một hoặc nhiều API trong một dự án trên Google Cloud.Trong bảng điều khiển Google Cloud, hãy bật Cloud Build API, Cloud Functions API, Cloud Pub/Sub API, Cloud Logging API, Artifact Registry API và Cloud Run API.
Tạo và triển khai hàm Cloud Run
Tạo và triển khai một hàm Cloud Run tạo thẻ Chat có tên hiển thị và hình đại diện của người gửi. Khi nhận được tin nhắn, ứng dụng Chat sẽ chạy hàm và phản hồi bằng thẻ.
Để tạo và triển khai hàm cho ứng dụng Chat, hãy hoàn tất các bước sau:
Node.js
Trong bảng điều khiển Cloud, hãy chuyển đến trang Cloud Run:
Đảm bảo bạn đã chọn dự án cho ứng dụng Chat.
Nhấp vào Write a function (Viết hàm).
Trên trang Create service (Tạo dịch vụ), hãy thiết lập hàm:
- Trong trường Service name (Tên dịch vụ), hãy nhập
addonchatapp. - Trong danh sách Region (Khu vực), hãy chọn một khu vực.
- Trong danh sách Runtime (Thời gian chạy), hãy chọn phiên bản Node.js mới nhất.
- Trong phần Authentication (Xác thực), hãy chọn Require authentication (Yêu cầu xác thực).
- Nhấp vào Create (Tạo) rồi đợi Cloud Run tạo dịch vụ. Bảng điều khiển sẽ chuyển hướng bạn đến thẻ Source (Nguồn).
- Trong trường Service name (Tên dịch vụ), hãy nhập
Trong thẻ Source (Nguồn):
- Trong Entry point (Điểm nhập), hãy xoá văn bản mặc định rồi nhập
avatarApp. - Thay thế nội dung của
index.jsbằng mã sau:
- Nhấp vào Save and redeploy (Lưu và triển khai lại).
- Trong Entry point (Điểm nhập), hãy xoá văn bản mặc định rồi nhập
Python
Trong bảng điều khiển Cloud, hãy chuyển đến trang Cloud Run:
Đảm bảo bạn đã chọn dự án cho ứng dụng Chat.
Nhấp vào Write a function (Viết hàm).
Trên trang Create service (Tạo dịch vụ), hãy thiết lập hàm:
- Trong trường Service name (Tên dịch vụ), hãy nhập
addonchatapp. - Trong danh sách Region (Khu vực), hãy chọn một khu vực.
- Trong danh sách Runtime (Thời gian chạy), hãy chọn phiên bản Python mới nhất.
- Trong phần Authentication (Xác thực), hãy chọn Require authentication (Yêu cầu xác thực).
- Nhấp vào Create (Tạo) rồi đợi Cloud Run tạo dịch vụ. Bảng điều khiển sẽ chuyển hướng bạn đến thẻ Source (Nguồn).
- Trong trường Service name (Tên dịch vụ), hãy nhập
Trong thẻ Source (Nguồn):
- Trong Entry point (Điểm nhập), hãy xoá văn bản mặc định rồi nhập
avatar_app. - Thay thế nội dung của
main.pybằng mã sau:
- Nhấp vào Save and redeploy (Lưu và triển khai lại).
- Trong Entry point (Điểm nhập), hãy xoá văn bản mặc định rồi nhập
Java
Trong bảng điều khiển Cloud, hãy chuyển đến trang Cloud Run:
Đảm bảo bạn đã chọn dự án cho ứng dụng Chat.
Nhấp vào Write a function (Viết hàm).
Trên trang Create service (Tạo dịch vụ), hãy thiết lập hàm:
- Trong trường Service name (Tên dịch vụ), hãy nhập
addonchatapp. - Trong danh sách Region (Khu vực), hãy chọn một khu vực.
- Trong danh sách Runtime (Thời gian chạy), hãy chọn phiên bản Java mới nhất.
- Trong phần Authentication (Xác thực), hãy chọn Require authentication (Yêu cầu xác thực).
- Nhấp vào Create (Tạo) rồi đợi Cloud Run tạo dịch vụ. Bảng điều khiển sẽ chuyển hướng bạn đến thẻ Source (Nguồn).
- Trong trường Service name (Tên dịch vụ), hãy nhập
Trong thẻ Source (Nguồn):
- Trong Entry point (Điểm nhập), hãy xoá văn bản mặc định rồi nhập
App. - Đổi tên tệp Java mặc định thành
src/main/java/com/google/chat/avatar/App.java. - Thay thế nội dung của
App.javabằng mã sau:
- Trong Entry point (Điểm nhập), hãy xoá văn bản mặc định rồi nhập
Thay thế nội dung của
pom.xmlbằng mã sau:- Nhấp vào Save and redeploy (Lưu và triển khai lại).
Trang thông tin chi tiết về dịch vụ Cloud Run sẽ mở ra. Đợi hàm triển khai.
Định cấu hình tiện ích bổ sung
Sau khi triển khai hàm Cloud Run, hãy làm theo các bước sau để tạo tiện ích bổ sung và triển khai ứng dụng Google Chat:
Trong bảng điều khiển Cloud, hãy chuyển đến trang Cloud Run:
Đảm bảo bạn đã chọn dự án mà bạn đã bật Cloud Run.
Trong danh sách hàm, hãy nhấp vào addonchatapp.
Trên trang Service details (Thông tin chi tiết về dịch vụ), hãy sao chép URL cho hàm. URL kết thúc bằng
run.app.Trong trường tìm kiếm của Google Cloud, hãy tìm "Google Chat API", sau đó nhấp vào Google Chat API rồi nhấp vào Manage (Quản lý).
Nhấp vào Configuration (Cấu hình) rồi thiết lập ứng dụng Google Chat:
- Trong App name (Tên ứng dụng), hãy nhập
Add-on Chat app. - Trong Avatar URL (URL hình đại diện), hãy nhập
https://developers.google.com/workspace/add-ons/images/quickstart-app-avatar.png. - Trong Description (Nội dung mô tả), hãy nhập
Add-on Chat app. - Trong phần Functionality (Chức năng), hãy chọn Join spaces and group conversations (Tham gia không gian và cuộc trò chuyện nhóm).
- Trong phần Connection settings (Cài đặt kết nối), hãy chọn HTTP endpoint URL (URL điểm cuối HTTP).
- Trong phần Triggers (Trình kích hoạt), hãy chọn Use a common HTTP endpoint URL for all triggers (Sử dụng URL điểm cuối HTTP chung cho tất cả trình kích hoạt) rồi dán URL cho trình kích hoạt hàm Cloud Run vào hộp.
- Trong phần Visibility (Chế độ hiển thị), hãy chọn Make this Google Chat app available to specific people and groups (Cho phép những người và nhóm cụ thể sử dụng ứng dụng Google Chat này) trong miền của bạn rồi nhập địa chỉ email của bạn.
- Trong phần Logs (Nhật ký), hãy chọn Log errors to Logging (Ghi lỗi vào Logging).
- Trong App name (Tên ứng dụng), hãy nhập
Nhấp vào Save (Lưu).
Trong phần Connection settings (Cài đặt kết nối), hãy sao chép Service account email (Email tài khoản dịch vụ). Bạn cần email này khi uỷ quyền cho tiện ích bổ sung gọi hàm.
Tiếp theo, hãy uỷ quyền cho ứng dụng Chat gọi hàm Cloud Run.
Uỷ quyền cho Google Chat gọi hàm
Để uỷ quyền cho tiện ích bổ sung của Google Workspace gọi hàm, hãy thêm tài khoản dịch vụ tiện ích bổ sung của Google Workspace có vai trò Cloud Run Service Invoker (Trình gọi dịch vụ Cloud Run).
Trong bảng điều khiển Cloud, hãy chuyển đến trang Cloud Run:
Trong danh sách dịch vụ Cloud Run, hãy đánh dấu vào hộp bên cạnh hàm nhận. (Đừng nhấp vào chính hàm đó.)
Nhấp vào Permissions (Quyền). Bảng điều khiển Permissions (Quyền) sẽ mở ra.
Nhấp vào Add principal (Thêm bên giao đại lý).
Trong phần New principals (Bên giao đại lý mới), hãy nhập địa chỉ email của tài khoản dịch vụ tiện ích bổ sung của Google Workspace được liên kết với ứng dụng Chat.
Địa chỉ email tài khoản dịch vụ nằm trên trang cấu hình Chat API, trong phần Connection settings (Cài đặt kết nối) > HTTP endpoint URL (URL điểm cuối HTTP) > Service Account Email (Email tài khoản dịch vụ):
Trong phần Select a role (Chọn vai trò), hãy chọn Cloud Run > Cloud Run Invoker (Trình gọi Cloud Run).
Nhấp vào Save (Lưu).
Ứng dụng Chat đã sẵn sàng nhận và phản hồi tin nhắn trên Chat.
Kiểm thử ứng dụng Chat
Để kiểm thử ứng dụng Chat, hãy mở một không gian tin nhắn trực tiếp bằng ứng dụng Chat rồi gửi tin nhắn:
Mở Google Chat bằng tài khoản Google Workspace mà bạn đã cung cấp khi thêm chính mình làm người kiểm thử đáng tin cậy.
- Nhấp vào Cuộc trò chuyện mới.
- Trong trường Add 1 or more people (Thêm 1 người trở lên), hãy nhập tên của ứng dụng Chat.
Chọn ứng dụng Chat trong kết quả. Một tin nhắn trực tiếp sẽ mở ra.
- Trong tin nhắn trực tiếp mới với ứng dụng, hãy nhập
Hellorồi nhấnenter.
Tin nhắn của ứng dụng Chat chứa một thẻ hiển thị tên và hình đại diện của người gửi, như minh hoạ trong hình ảnh sau:
Để thêm người kiểm thử đáng tin cậy và tìm hiểu thêm về việc kiểm thử các tính năng tương tác, hãy xem bài viết Kiểm thử các tính năng tương tác cho ứng dụng Google Chat.
Khắc phục sự cố
Khi một ứng dụng hoặc thẻ Google Chat trả về lỗi, giao diện Chat sẽ hiển thị thông báo "Đã xảy ra lỗi." hoặc "Không thể xử lý yêu cầu của bạn." Đôi khi, giao diện người dùng Chat không hiển thị thông báo lỗi nào, nhưng ứng dụng hoặc thẻ Chat lại tạo ra kết quả không mong muốn; ví dụ: tin nhắn thẻ có thể không xuất hiện.
Mặc dù thông báo lỗi có thể không xuất hiện trong giao diện người dùng Chat, nhưng bạn có thể xem các thông báo lỗi mang tính mô tả và dữ liệu nhật ký để giúp khắc phục lỗi khi tính năng ghi nhật ký lỗi cho ứng dụng Chat được bật. Để được trợ giúp xem, gỡ lỗi và khắc phục lỗi, hãy xem bài viết Khắc phục sự cố và sửa lỗi Google Chat.
Dọn dẹp
Để tránh bị tính phí vào tài khoản Google Cloud cho các tài nguyên được sử dụng trong hướng dẫn này, bạn nên xoá dự án trên đám mây.
- Trong bảng điều khiển Cloud, hãy chuyển đến trang Manage resources (Quản lý tài nguyên). Nhấp vào trình đơn Menu > IAM & Admin > Manage Resources (IAM và quản trị > Quản lý tài nguyên).
- Trong danh sách dự án, hãy chọn dự án mà bạn muốn xoá rồi nhấp vào biểu tượng Xoá .
- Trong hộp thoại, hãy nhập mã dự án rồi nhấp vào tắt để xoá dự án.