Tạo tiện ích bổ sung của Google Workspace trong Cloud Functions bằng thời gian chạy Node.js.
Mục tiêu
- Thiết lập môi trường.
- Tạo và triển khai Chức năng đám mây.
- Tạo và triển khai tiện ích bổ sung.
- Cài đặt tiện ích bổ sung.
Điều kiện tiên quyết
- Một dự án Google Cloud.
- Nhớ bật tính năng thanh toán cho dự án của bạn trên Google Cloud. Tìm hiểu cách xác minh trạng thái thanh toán của các dự án.
- Cloud SDK được định cấu hình với dự án Cloud.
Thiết lập môi trường
Mở dự án Cloud trong bảng điều khiển Google Cloud
- Trong bảng điều khiển Google Cloud, hãy chuyển đến trang Chọn dự án.
- Chọn dự án Google Cloud mà bạn muốn sử dụng. Hoặc nhấp vào Tạo dự án rồi làm theo hướng dẫn trên màn hình. Nếu tạo một dự án trên Google Cloud, có thể bạn sẽ phải bật tính năng thanh toán cho dự án đó.
Định cấu hình màn hình xin phép bằng OAuth
Tiện ích bổ sung của Google Workspace cần bạn thiết lập màn hình đồng ý. Việc định cấu hình màn hình xin phép bằng OAuth của tiện ích bổ sung sẽ xác định nội dung Google sẽ hiển thị cho người dùng.
- Trong bảng điều khiển Google Cloud, hãy chuyển đến Trình đơn > API và Dịch vụ > màn hình xin phép bằng OAuth.
- Đối với Loại người dùng, hãy chọn Nội bộ, rồi nhấp vào Tạo.
- Hoàn tất biểu mẫu đăng ký ứng dụng, sau đó nhấp vào Lưu và tiếp tục.
Hiện tại, bạn có thể bỏ qua bước thêm phạm vi rồi nhấp vào Lưu và tiếp tục. Trong tương lai, khi tạo một ứng dụng để sử dụng bên ngoài tổ chức Google Workspace, bạn phải thay đổi Loại người dùng thành Bên ngoài, sau đó thêm phạm vi uỷ quyền mà ứng dụng yêu cầu.
- Xem lại bản tóm tắt về gói đăng ký ứng dụng của bạn. Để chỉnh sửa, hãy nhấp vào Chỉnh sửa. Nếu quá trình đăng ký ứng dụng có vẻ ổn, hãy nhấp vào Back to Dashboard (Quay lại trang tổng quan).
Tạo và triển khai Hàm đám mây
Trong một thiết bị đầu cuối cục bộ, hãy bật Cloud Functions, Cloud Build và Google Workspace Add-ons API:
gcloud services enable cloudfunctions cloudbuild.googleapis.com gsuiteaddons.googleapis.com
Trong một thư mục trống, hãy tạo tệp
function.js
với mã mẫu sau:/** * Cloud Function that loads the homepage for a * Google Workspace Add-on. * * @param {Object} req Request sent from Google * @param {Object} res Response to send back */ exports.loadHomePage = function addonsHomePage (req, res) { res.send(createAction()); }; /** Creates a card with two widgets. */ function createAction() { return { "action": { "navigations": [ { "pushCard": { "header": { "title": "Cats!" }, "sections": [ { "widgets": [ { "textParagraph": { "text": "Your random cat:" } }, { "image": { "imageUrl": "https://cataas.com/cat" } } ] } ] } } ] } }; }
Triển khai hàm:
gcloud functions deploy loadHomePage --runtime nodejs12 --trigger-http
Nếu được nhắc, hãy chỉ định rằng bạn không cho phép các lệnh gọi hàm chưa được xác thực. Có thể mất vài phút để chức năng này triển khai.
Tạo quy trình triển khai tiện ích bổ sung
Tìm email của tài khoản dịch vụ cho tiện ích bổ sung:
gcloud workspace-add-ons get-authorization
Cấp cho tài khoản dịch vụ vai trò
cloudfunctions.invoker
:gcloud functions add-iam-policy-binding loadHomePage \ --role roles/cloudfunctions.invoker \ --member serviceAccount:SERVICE_ACCOUNT_EMAIL
Lấy URL của hàm đã triển khai. Để lấy URL, hãy chạy lệnh sau và tìm trường
url
trong phầnhttpsTrigger
:gcloud functions describe loadHomePage
Tạo tệp
deployment.json
bằng mã mẫu sau. Thay thếURL
bằng URL của hàm đã triển khai ở bước trước.{ "oauthScopes": ["https://www.googleapis.com/auth/gmail.addons.execute"], "addOns": { "common": { "name": "My HTTP Add-on", "logoUrl": "https://raw.githubusercontent.com/webdog/octicons-png/main/black/beaker.png", "homepageTrigger": { "runFunction": "URL" } }, "gmail": {}, "drive": {}, "calendar": {}, "docs": {}, "sheets": {}, "slides": {} } }
Tạo quá trình triển khai:
gcloud workspace-add-ons deployments create quickstart \ --deployment-file=deployment.json
Cài đặt tiện ích bổ sung
Cài đặt hoạt động triển khai ở chế độ phát triển:
gcloud workspace-add-ons deployments install quickstart
Mở hoặc tải lại Gmail để xem tiện ích bổ sung. Trong thanh công cụ ở bên phải, hãy tìm biểu tượng cốc.
Nhấp vào biểu tượng để mở tiện ích bổ sung. Nếu được nhắc, hãy uỷ quyền tiện ích bổ sung này.
Không bắt buộc: Dọn dẹp
Để tránh làm phát sinh phí cho tài khoản của bạn, hãy xoá các tài nguyên mà bạn đã tạo:
Gỡ cài đặt tiện ích bổ sung khỏi Tài khoản Google của bạn:
gcloud workspace-add-ons deployments uninstall quickstart
Để tránh phát sinh phí cho các tài nguyên được sử dụng trong bước khởi động nhanh này, hãy xoá dự án Cloud:
gcloud projects delete PROJECT_ID
Thay thế PROJECT_ID bằng mã nhận dạng của dự án trên đám mây mà bạn đã dùng để bắt đầu nhanh. Bạn có thể tìm thấy mã dự án trên Cloud trong bảng điều khiển Google Cloud tại Trang tổng quan.
Các bước tiếp theo
Để thêm các chức năng khác vào Tiện ích bổ sung của Google Workspace, hãy tham khảo các hướng dẫn sau:
- Tạo tiện ích bổ sung bằng bất kỳ ngôn ngữ lập trình nào
- Xem trước đường liên kết bằng khối thông minh