Membuat antarmuka Google Drive

Add-on Google Workspace dapat menyediakan antarmuka yang disesuaikan saat pengguna menggunakan Google Drive. Dengan demikian, Anda dapat memberikan informasi tambahan yang relevan kepada pengguna, mengotomatiskan tugas, dan menghubungkan sistem pihak ketiga ke Google Drive.

Mengakses UI add-on

Anda dapat membuka add-on Google Workspace di Google Drive jika ikonnya muncul di kolom ikon di sisi kanan antarmuka pengguna Drive. Add-on Google Workspace dapat menentukan antarmuka halaman beranda, antarmuka pemilihan item, atau keduanya:

  • Jika pengguna mengklik ikon add-on saat berada di Google Drive, add-on akan menjalankan fungsi drive.homepageTrigger yang sesuai (jika ada). Fungsi ini mem-build dan menampilkan kartu halaman beranda ke Google Drive untuk ditampilkan. Jika tidak ada fungsi drive.homepageTrigger yang ditentukan, kartu halaman beranda umum akan ditampilkan.
  • Jika pengguna memilih satu atau beberapa item di Google Drive, lalu mengklik ikon add-on, atau memilih item saat add-on terbuka, add-on akan menjalankan fungsi kontekstual drive.onItemsSelectedTrigger yang sesuai (jika ada). Fungsi ini membuat antarmuka "item yang dipilih" kontekstual Google Drive add-on dan menampilkannya ke Google Drive.

Membuat antarmuka Drive add-on

Anda dapat membuat antarmuka yang memperluas Google Drive dengan mengikuti langkah-langkah umum berikut:

  1. Tentukan apakah Anda ingin add-on memiliki halaman beranda khusus Drive. Tentukan juga apakah Anda ingin menyediakan antarmuka kontekstual saat pengguna memilih item Drive.
  2. Tambahkan kolom addOns.common dan addOns.drive yang sesuai ke manifes project skrip add-on, termasuk cakupan Drive yang diperlukan.
  3. Jika Anda menyediakan halaman beranda khusus Drive, implementasikan fungsi drive.homepageTrigger untuk mem-build antarmuka ini. Anda juga dapat memilih untuk menggunakan antarmuka common.homepageTrigger untuk beberapa host Google Workspace.
  4. Jika menyediakan antarmuka pemilihan item kontekstual Drive, Anda harus mengimplementasikan fungsi pemicu kontekstual drive.onItemsSelectedTrigger untuk mem-build antarmuka ini. Lihat Antarmuka kontekstual Drive untuk item yang dipilih) untuk mengetahui detailnya.
  5. Terapkan fungsi callback terkait yang diperlukan untuk merespons interaksi UI pengguna, seperti klik tombol.

Halaman beranda Drive

Google Drive mendukung tampilan halaman beranda add-on Google Workspace. Untuk menampilkan halaman beranda umum add-on di Google Drive, cukup pastikan ada kolom addOns.drive di manifes add-on.

Atau, tambahkan drive.homepageTrigger ke manifes add-on untuk menyediakan halaman beranda khusus Drive.

Dalam kedua kasus tersebut, Anda harus memberikan nama fungsi pemicu halaman beranda di project skrip add-on. Fungsi ini otomatis dipanggil untuk membuat halaman beranda Drive saat diperlukan. Anda harus menerapkan fungsi ini untuk mem-build dan menampilkan satu Card atau array objek Card yang membentuk halaman beranda. Fungsi pemicu halaman beranda diteruskan objek peristiwa sebagai parameter yang berisi beberapa informasi umum seperti platform klien. Anda dapat menggunakan data objek peristiwa untuk menyesuaikan pembuatan halaman beranda.

Antarmuka kontekstual Drive untuk item yang dipilih

Google Drive mengandalkan pemicu kontekstual untuk menentukan antarmuka (jika ada) yang akan ditampilkan saat pengguna memilih satu atau beberapa item Google Drive. Saat diaktifkan, pemicu akan menjalankan fungsi pemicu kontekstual yang ditentukan oleh kolom drive.onItemsSelectedTrigger.runFunction dalam manifes add-on.

Untuk membuat antarmuka pemilihan item kontekstual untuk Drive, Anda harus melakukan hal berikut:

  1. Pastikan manifes add-on menyertakan cakupan https://www.googleapis.com/auth/drive.addons.metadata.readonly

  2. Pastikan manifes menyertakan bagian drive.onItemsSelectedTrigger.

  3. Implementasikan fungsi yang diberi nama di kolom drive.onItemsSelectedTrigger. Fungsi ini menerima objek peristiwa sebagai argumen dan harus menampilkan satu objek Card atau array objek Card.

  4. Seperti kartu lainnya, Anda harus mengimplementasikan fungsi callback yang digunakan untuk menyediakan interaksi widget untuk antarmuka. Misalnya, jika Anda menyertakan tombol di antarmuka, tombol tersebut harus memiliki Action terlampir dan fungsi callback yang diterapkan yang berjalan saat tombol diklik.

Objek peristiwa

Objek peristiwa dibuat dan diteruskan ke fungsi pemicu drive.homepageTrigger atau drive.onItemsSelectedTrigger saat fungsi tersebut dipanggil. Fungsi pemicu dapat menggunakan informasi dalam objek peristiwa ini untuk menentukan cara membuat kartu add-on atau mengontrol perilaku add-on.

Struktur lengkap objek peristiwa dijelaskan dalam Objek peristiwa. Jika Drive adalah aplikasi host yang bertindak sebagai add-on, objek peristiwa kontekstual akan menyertakan kolom objek peristiwa Drive yang membawa informasi klien khusus Drive.

Objek peristiwa Drive kontekstual untuk pemicu pemilihan item menyertakan informasi tentang item yang telah dipilih pengguna saat pemicu diaktifkan. Saat pengguna memilih lebih dari satu item di Drive, salah satu item dianggap sebagai salah satu minat utama; item ini disebut sebagai item kursor aktif.

Contoh berikut menunjukkan objek peristiwa Drive yang diteruskan ke fungsi drive.onItemsSelectedTrigger:

    {
      "commonEventObject": { ... },
      "drive": {
        "activeCursorItem":{
          "addonHasFileScopePermission": true,
          "id":"0B_sX1fXRRU6Ac3RhcnRlcl9maWxl",
          "iconUrl": "https://drive-thirdparty.googleusercontent.com...",
          "mimeType":"application/pdf",
          "title":"How to get started with Drive"
        },
        "selectedItems": [
          {
            "addonHasFileScopePermission": true,
            "id":"0B_sX1fXRRU6Ac3RhcnRlcl9maWxl",
            "iconUrl":"https://drive-thirdparty.googleusercontent.com...",
            "mimeType":"application/pdf",
            "title":"How to get started with Drive"
          },
          ...
        ]
      },
      ...
    }