Beranda

Halaman beranda adalah fitur add-on Google Workspace yang memberikan kemampuan untuk menentukan satu atau beberapa kartu non-kontekstual. Kartu non-kontekstual menampilkan antarmuka pengguna saat pengguna berada di luar konteks tertentu, seperti saat melihat kotak masuk Gmail tanpa membuka pesan atau draf.

Halaman beranda memungkinkan Anda menampilkan konten non-kontekstual, mirip dengan aplikasi Google di panel samping akses cepat (Google Keep, Google Kalender, dan Google Tasks). Halaman beranda juga dapat memberikan titik awal saat pengguna pertama kali membuka add-on Anda dan berguna untuk mengajari pengguna baru cara berinteraksi dengan add-on Anda.

Tentukan halaman beranda untuk add-on Anda dengan menentukannya dalam manifest project dan menerapkan satu atau beberapa fungsi homepageTrigger (lihat Konfigurasi halaman beranda).

Anda dapat memiliki beberapa halaman beranda, satu untuk setiap aplikasi host yang diperluas oleh add-on Anda. Anda juga dapat menentukan satu halaman beranda default umum yang digunakan di host tempat Anda belum menentukan halaman beranda kustom.

Halaman beranda add-on Anda ditampilkan dalam kasus berikut:

  • Saat add-on pertama kali dibuka di host (setelah otorisasi).
  • Saat pengguna beralih dari konteks kontekstual ke konteks non-kontekstual saat add-on terbuka. Misalnya, dari mengedit acara Kalender ke Kalender utama.
  • Saat pengguna mengklik tombol kembali beberapa kali untuk memunculkan setiap kartu lain dari stack internal.
  • Saat interaksi UI dalam kartu non-kontekstual menghasilkan panggilan Navigation.popToRoot.

Sebaiknya desain halaman beranda. Jika Anda tidak menentukannya, kartu umum yang berisi nama add-on Anda akan digunakan setiap kali pengguna membuka halaman beranda.

Konfigurasi halaman beranda

Add-on Google Workspace menggunakan kolom addOns.common.homepageTrigger untuk mengonfigurasi konten add-on halaman beranda default (non-kontekstual) untuk aplikasi host dalam manifes add-on:

{
  "addOns": {
    "common": {
      "homepageTrigger": {
        "runFunction": "myFunction",
        "enabled": true
      }
    }
  }
}

  • runFunction: Nama fungsi Google Apps Script yang dipanggil framework add-on Google Workspace untuk merender kartu add-on beranda. Fungsi ini adalah fungsi pemicu beranda. Fungsi ini harus membuat dan menampilkan array objek Card yang membentuk UI halaman beranda. Jika lebih dari satu kartu ditampilkan, aplikasi host akan menampilkan header kartu dalam daftar yang dapat dipilih pengguna (lihat Menampilkan beberapa kartu).

  • enabled: Apakah kartu halaman beranda harus diaktifkan untuk cakupan ini. Kolom ini bersifat opsional, dan secara default ditetapkan ke true. Menetapkan parameter ini ke false akan menyebabkan kartu beranda dinonaktifkan untuk semua host (kecuali jika diganti untuk host tersebut; lihat konfigurasi khusus host).

Agar host dapat menggunakan halaman beranda umum, addOns.common.homepageTrigger dan resource tingkat teratas host harus ada di manifes add-on. Misalnya, jika addOns.gmail tidak ada dalam manifes, add-on akan dinonaktifkan untuk Gmail dan tidak akan menampilkan halaman beranda atau fungsi lainnya di host tersebut.

Selain konfigurasi umum, penggantian per host dengan struktur yang identik tersedia di setiap konfigurasi aplikasi host, di addOns.gmail.homepageTrigger, addOns.calendar.homepageTrigger, dan pemicu khusus host lainnya.

Contoh berikut menunjukkan manifes tempat pemicu halaman beranda umum ditentukan, tetapi diganti dengan fungsi kustom untuk Kalender dan Drive, serta dinonaktifkan untuk Gmail. Dalam konfigurasi ini, fungsi buildHomePage umum tidak pernah dieksekusi karena diganti atau host dinonaktifkan.

{
  ...
  "addOns": {
    ...
    "common": {
      "homepageTrigger": { "runFunction": "buildHomePage" }
    },
    "calendar": {
      "homepageTrigger": { "runFunction": "buildCalendarHomepage" }
    },
    "drive": {
      "homepageTrigger": { "runFunction": "buildDriveHomepage" }
    },
    "gmail": {
      "homepageTrigger": { "enabled": false }
    },
    ...
  }
}

Kutipan manifes berikut setara dengan contoh sebelumnya, meskipun homepageTrigger default dan konfigurasi Gmail tidak disertakan:

{
  "addOns": {
    "common": {},
    "calendar": {
      "homepageTrigger": { "runFunction": "myCalendarFunction" }
    },
    "drive": {
      "homepageTrigger": { "runFunction": "myDriveFunction" }
    },
    "gmail": {},
    ...
  }
}

Tidak ada bagian homepageTrigger yang wajib diisi. UI yang ditampilkan untuk add-on di produk host bergantung pada keberadaan kolom manifes yang sesuai dan apakah ada homepageTrigger terkait. Contoh berikut menunjukkan fungsi pemicu add-on mana yang dijalankan untuk membuat UI halaman beranda bagi konfigurasi manifes yang berbeda:

Diagram yang menunjukkan alur eksekusi fungsi pemicu halaman beranda add-on

Objek peristiwa halaman beranda

Saat dipanggil, fungsi pemicu halaman beranda (runFunction) yang dijelaskan sebelumnya akan menerima objek peristiwa yang berisi data dari konteks pemanggilan.

Objek peristiwa halaman beranda tidak menyertakan widget atau informasi kontekstual. Informasi yang diteruskan terbatas pada kolom objek peristiwa umum berikut:

  • commonEventObject.clientPlatform
  • commonEventObject.hostApp
  • commonEventObject.userLocale dan commonEventObject.userTimezone (lihat Mengakses lokalitas dan zona waktu pengguna untuk mengetahui informasi pembatasan).

Lihat Objek peristiwa untuk mengetahui detail selengkapnya.

Kartu non-kontekstual lainnya

UI add-on Anda dapat berisi kartu non-kontekstual tambahan yang bukan halaman beranda. Misalnya, halaman beranda Anda mungkin memiliki tombol yang membuka kartu "Setelan" untuk menyesuaikan setelan add-on (setelan tersebut biasanya tidak bergantung pada konteks).

Kartu non-kontekstual dibuat seperti kartu lainnya; satu-satunya perbedaan adalah tindakan atau peristiwa yang menghasilkan dan menampilkan kartu. Lihat Metode navigasi untuk mengetahui detail cara membuat transisi antar-kartu.