Tạo tiện ích bổ sung cho Google Workspace bằng Node.js

Tạo tiện ích bổ sung của Google Workspace trong Cloud Functions bằng môi trườ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 một Chức năng trên đá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

Thiết lập môi trường

Mở dự án trên Google Cloud trong Google Cloud Console

  1. Trong Google Cloud Console, hãy chuyển đến trang Chọn một dự án.

    Chọn một dự án trên Đám mây

  2. 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 dự án trên Google Cloud, bạn có thể cần 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 yêu cầu cấu hình màn hình yêu cầu đồ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 mà Google hiển thị cho người dùng.

  1. Trong Google Cloud Console, hãy chuyển đến Trình đơn > API và dịch vụ > Màn hình đồng ý OAuth.

    Chuyển đến màn hình xin phép bằng OAuth

  2. Đối với Loại người dùng, hãy chọn Nội bộ, sau đó nhấp vào Tạo.
  3. 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.
  4. Hiện tại, bạn có thể bỏ qua bước thêm phạm vi và 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 các phạm vi uỷ quyền mà ứng dụng của bạn yêu cầu.

  5. Xem lại thông tin tóm tắt về việc đăng ký ứng dụng. Để chỉnh sửa, hãy nhấp vào Chỉnh sửa. Nếu bạn thấy quá trình đăng ký ứng dụng đã hoàn tất, hãy nhấp vào Quay lại trang tổng quan.

Tạo và triển khai một Chức năng trên đám mây

  1. Trong một thiết bị đầu cuối cục bộ, hãy bật API tiện ích bổ sung Google Workspace, Cloud Build và Cloud Functions:

    gcloud services enable cloudfunctions cloudbuild.googleapis.com gsuiteaddons.googleapis.com
    
  2. Trong một thư mục trống, hãy tạo tệp function.js bằng 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"
                         }
                      }
                    ]
                  }
                ]
              }
            }
          ]
        }
      };
    }
    
  3. 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 chưa xác thực của hàm. Có thể mất vài phút để triển khai hàm.

Tạo quá trình triển khai tiện ích bổ sung

  1. Tìm email tài khoản dịch vụ của tiện ích bổ sung:

    gcloud workspace-add-ons get-authorization
    
  2. 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
    
  3. 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ần httpsTrigger:

    gcloud functions describe loadHomePage
    
  4. 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": {}
      }
    }
    
  5. 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

  1. Cài đặt bản triển khai ở chế độ phát triển:

    gcloud workspace-add-ons deployments install quickstart
    
  2. 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 đo.

  3. Nhấp vào biểu tượng để mở tiện ích bổ sung. Nếu được nhắc, hãy cho phép tiện ích bổ sung.

Không bắt buộc: Dọn dẹp

Để tránh bị tính phí cho tài khoản của bạn, hãy xoá các tài nguyên mà bạn đã tạo:

  1. 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
    
  2. Để tránh bị tính phí cho các tài nguyên dùng trong hướng dẫn nhanh này, hãy xoá dự án trên Cloud:

    gcloud projects delete PROJECT_ID
    

    Thay thế PROJECT_ID bằng mã của dự án trên Google Cloud mà bạn đã sử dụng cho phần hướng dẫn nhanh. Bạn có thể tìm thấy mã dự án trên Google Cloud trong trang Trang tổng quan.

Các bước tiếp theo

Để thêm chức năng vào tiện ích bổ sung của Google Workspace, hãy tham khảo các hướng dẫn sau: