Membuat panduan memulai Add-on Google Workspace

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

Tujuan

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

Prasyarat

Menyiapkan lingkungan Anda

Membuka project Cloud di Google Cloud Console

  1. Di Google Cloud Console, 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.

Mengonfigurasi layar izin OAuth

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

  1. Di Google Cloud Console, buka Menu > API & Layanan > Layar izin OAuth.

    Buka layar izin OAuth

  2. Pilih jenis pengguna untuk aplikasi Anda, lalu klik Create.
  3. Isi formulir pendaftaran aplikasi, lalu klik Simpan dan Lanjutkan.

  4. Untuk saat ini, Anda dapat melewati penambahan cakupan dan mengklik Simpan dan Lanjutkan. Di masa mendatang, saat membuat aplikasi untuk digunakan di luar organisasi Google Workspace, Anda harus menambahkan dan memverifikasi cakupan otorisasi yang diperlukan aplikasi.

  5. Jika Anda memilih Eksternal untuk jenis pengguna, tambahkan pengguna pengujian:
    1. Di bagian Uji pengguna, klik Tambahkan pengguna.
    2. Masukkan alamat email Anda dan pengguna uji resmi lainnya, lalu klik Simpan dan Lanjutkan.
  6. Tinjau ringkasan pendaftaran aplikasi Anda. Untuk membuat perubahan, klik Edit. Jika pendaftaran aplikasi terlihat normal, klik Kembali ke Dasbor.

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. Dalam 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 tersebut:

    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 untuk menerapkan fungsi.

Membuat deployment add-on

  1. Cari email akun layanan untuk add-on:

    gcloud workspace-add-ons get-authorization

  2. Berikan peran cloudfunctions.invoker ke akun layanan:

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

  3. Dapatkan URL dari fungsi yang di-deploy. Untuk mendapatkan URL, jalankan perintah berikut, lalu cari kolom url di 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

Menginstal 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. Pada toolbar di sebelah kanan, cari ikon gelas kimia.

  3. Klik ikon untuk membuka add-on. Jika diminta, izinkan add-on.

Opsional: Pembersihan

Agar tidak dikenai biaya pada akun, hapus resource yang Anda buat:

  1. Meng-uninstal add-on dari Akun Google Anda:

    gcloud workspace-add-ons deployments uninstall quickstart

  2. Agar tidak menimbulkan biaya untuk resource yang digunakan di 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 Google Cloud Console pada halaman Dashboard.

Langkah berikutnya

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