Membuat panduan memulai Add-on Google Workspace

Membuat Add-on Google Workspace di Cloud Functions menggunakan runtime Node.js.

Tujuan

  • Menyiapkan lingkungan Anda.
  • Membuat dan men-deploy Cloud Function.
  • Buat dan deploy add-on.
  • Instal add-on.

Prasyarat

Menyiapkan lingkungan Anda

Buka project Cloud Anda di konsol Google Cloud

  1. Di konsol Google Cloud, buka halaman Select a project.

    Memilih project Cloud

  2. Pilih project Google Cloud yang ingin Anda gunakan. Atau, klik Buat project dan ikuti petunjuk di layar. Jika membuat project Google Cloud, Anda mungkin perlu mengaktifkan penagihan untuk project tersebut.

Mengonfigurasi layar izin OAuth

Add-on Google Workspace memerlukan konfigurasi layar izin. Mengonfigurasi layar izin OAuth add-on Anda akan menentukan apa yang akan ditampilkan Google kepada pengguna.

  1. Di konsol Google Cloud, buka Menu > APIs & Services > OAuth consent screen.

    Buka layar izin OAuth

  2. Untuk Jenis pengguna, pilih Internal, lalu klik Buat.
  3. Lengkapi formulir pendaftaran aplikasi, lalu klik Simpan dan Lanjutkan.

  4. Untuk saat ini, Anda dapat melewati penambahan cakupan dan mengklik Simpan dan Lanjutkan. Pada masa mendatang, saat membuat aplikasi untuk digunakan di luar organisasi Google Workspace, Anda harus mengubah User type menjadi External, lalu tambahkan cakupan otorisasi yang diperlukan aplikasi Anda.

  5. Tinjau ringkasan pendaftaran aplikasi Anda. Untuk melakukan perubahan, klik Edit. Jika pendaftaran aplikasi terlihat baik-baik saja, klik Back to Dashboard.

Membuat dan men-deploy Cloud Function

  1. Di terminal lokal, aktifkan Cloud Functions, Cloud Build, dan Google Workspace Add-ons API:

    gcloud services enable cloudfunctions cloudbuild.googleapis.com gsuiteaddons.googleapis.com

  2. Di direktori kosong, buat file function.js dengan kode contoh berikut:

    /**
 * 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. Deploy fungsi:

    gcloud functions deploy loadHomePage --runtime nodejs12 --trigger-http

    Jika diminta, tentukan bahwa Anda tidak mengizinkan pemanggilan fungsi yang tidak diautentikasi. Mungkin perlu waktu beberapa menit hingga fungsi di-deploy.

Membuat deployment add-on

  1. Temukan email akun layanan untuk add-on tersebut:

    gcloud workspace-add-ons get-authorization

  2. Berikan peran cloudfunctions.invoker kepada akun layanan:

    gcloud functions add-iam-policy-binding loadHomePage \
    --role roles/cloudfunctions.invoker \
    --member serviceAccount:SERVICE_ACCOUNT_EMAIL

  3. Mendapatkan URL dari fungsi yang di-deploy. Untuk mendapatkan URL, jalankan perintah berikut dan cari kolom url pada bagian httpsTrigger:

    gcloud functions describe loadHomePage

  4. Buat file deployment.json dengan kode contoh berikut. Ganti URL dengan URL fungsi yang di-deploy dari langkah sebelumnya.

    {
  "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. Buat deployment:

    gcloud workspace-add-ons deployments create quickstart \
    --deployment-file=deployment.json

Instal add-on

  1. Instal deployment dalam mode pengembangan:

    gcloud workspace-add-ons deployments install quickstart

  2. Buka atau muat ulang Gmail untuk melihat add-on. Di toolbar di sebelah kanan, cari ikon gelas kimia.

  3. Klik ikon untuk membuka add-on. Jika diminta, berikan otorisasi pada add-on tersebut.

Opsional: Pembersihan

Untuk menghindari timbulnya biaya pada akun Anda, hapus resource yang Anda buat:

  1. Uninstal add-on dari Akun Google Anda:

    gcloud workspace-add-ons deployments uninstall quickstart

  2. Agar tidak menimbulkan biaya untuk resource yang digunakan dalam panduan memulai ini, hapus project Cloud:

    gcloud projects delete PROJECT_ID

    Ganti PROJECT_ID dengan ID project Cloud yang Anda gunakan untuk panduan memulai. Anda dapat menemukan project ID Cloud di Konsol Google Cloud di halaman Dasbor.

Langkah berikutnya

Untuk menambahkan lebih banyak fungsi ke Add-on Google Workspace, lihat panduan berikut: