Library

Library adalah project skrip yang fungsinya dapat digunakan kembali dalam skrip lain.

Mendapatkan akses ke library

Untuk menyertakan library dalam project, Anda harus memiliki setidaknya akses tingkat tampilan ke library tersebut. Jika Anda bukan penulis library yang ingin Anda sertakan, hubungi penulis dan minta akses.

Anda memerlukan ID skrip library yang ingin disertakan. Jika memiliki akses ke library, Anda dapat menemukan ID skrip di halaman Project Settings .

Menambahkan library ke project skrip

  1. Di sebelah kiri editor Apps Script, di samping "Library", klik Tambahkan library .
  2. Di kolom "ID Skrip", tempel ID skrip library.
  3. Klik Cari.
  4. Klik dropdown Version dan pilih versi library yang akan digunakan.
  5. Periksa apakah nama "ID" default adalah nama yang ingin Anda gunakan dengan library ini. Ini adalah nama yang digunakan skrip Anda untuk merujuk ke library. Misalnya, jika menetapkannya ke Test, Anda dapat memanggil metode library tersebut sebagai berikut: Test.libraryMethod().
  6. Klik Tambahkan.

Menggunakan library

Gunakan library yang disertakan seperti Anda menggunakan layanan default. Misalnya, jika Test adalah ID untuk library Anda, ketik Test langsung diikuti dengan titik untuk melihat daftar metode di library.

Dokumentasi referensi untuk library yang disertakan dapat dibuka dengan mengikuti langkah-langkah berikut:

Di sebelah kiri editor skrip, di samping nama library, klik Lainnya > Buka di tab baru.

Menghapus library

Di sebelah kiri editor skrip, di samping nama library, klik Lainnya > Hapus > Hapus library.

Mengupdate library

Anda dapat mengubah versi library atau memperbarui ID-nya.

  1. Di sebelah kiri editor, di bagian "Library", klik nama library.
  2. Lakukan perubahan, lalu klik Simpan.

Membuat dan membagikan library

Untuk menggunakan dan membagikan project skrip sebagai library, ikuti langkah-langkah di bawah.

  1. Buat deployment berversi skrip Anda.
  2. Bagikan setidaknya akses tingkat tampilan kepada semua calon pengguna library.
  3. Berikan ID skrip kepada pengguna tersebut, yang dapat ditemukan di halaman Setelan project.

Praktik terbaik

Berikut adalah beberapa panduan yang harus diikuti saat menulis library:

  1. Pilih nama yang bermakna untuk project Anda karena nama tersebut digunakan sebagai ID default saat library Anda disertakan oleh orang lain.
  2. Jika Anda ingin satu atau beberapa metode skrip tidak terlihat (atau tidak dapat digunakan) oleh pengguna library, Anda dapat mengakhiri nama metode dengan garis bawah. Misalnya, myPrivateMethod_().
  3. Hanya properti global yang dapat dihitung yang dapat dilihat oleh pengguna library. Hal ini mencakup deklarasi fungsi, variabel yang dibuat di luar fungsi dengan var, dan properti yang ditetapkan secara eksplisit pada objek global. Misalnya, Object.defineProperty() dengan enumerable ditetapkan ke false akan membuat simbol yang dapat Anda gunakan di library, tetapi simbol ini tidak dapat diakses oleh pengguna.

  4. Jika ingin pengguna library menggunakan pelengkapan otomatis editor skrip dan dokumentasi yang dibuat secara otomatis, Anda harus memiliki dokumentasi gaya JSDoc untuk semua fungsi. Berikut contohnya:

    /**
 * Raises a number to the given power, and returns the result.
 *
 * @param {number} base the number we're raising to a power
 * @param {number} exp the exponent we're raising the base to
 * @return {number} the result of the exponential calculation
 */
function power(base, exp) { ... }

Cakupan resource

Ada dua jenis resource saat Anda menggunakan library: bersama dan tidak bersama. Resource bersama berarti library dan skrip yang menyertakan memiliki akses bawaan ke instance resource yang sama. Diagram berikut mengilustrasikan resource bersama menggunakan contoh Properti Pengguna:

Referensi Bersama

Resource yang tidak dibagikan berarti library dan skrip yang menyertakan hanya memiliki akses bawaan ke instance resource-nya. Namun, library dapat memberikan akses ke resource yang tidak dibagikan dengan memiliki fungsi eksplisit yang beroperasi di atasnya. Berikut adalah contoh fungsi yang akan Anda sertakan dalam library untuk mengekspos Properti Skripnya:

  function getLibraryProperty(key) {
    const scriptProperties = PropertiesService.getScriptProperties();
    return scriptProperties.getProperty(key);
  }

Diagram berikut mengilustrasikan resource yang tidak dibagikan menggunakan contoh Properti Skrip:

Resource yang Tidak Dibagikan

Tabel ini mencantumkan resource yang dibagikan dan tidak dibagikan untuk referensi Anda:

Resource Dibagikan* Tidak Dibagikan** Catatan
Kunci Instance yang sama dapat dilihat oleh semua orang, termasuk skrip saat dibuat di library.
Properti Skrip Instance yang sama dapat dilihat oleh semua orang termasuk skrip saat dibuat di library.
Cache Instance yang sama dapat dilihat oleh semua orang termasuk skrip saat dibuat di library.
Pemicu Pemicu sederhana yang dibuat di library tidak dipicu oleh skrip yang menyertakan.
ScriptApp
UiApp
Properti Pengguna
Logger dan transkrip eksekusi
Situs, Spreadsheet, dan penampung lainnya Panggilan ke getActive() menampilkan penampung skrip yang menyertakan.
MailApp dan GmailApp
* Artinya, library tidak memiliki instance fitur/resourcenya sendiri, tetapi menggunakan instance yang dibuat oleh skrip yang memanggilnya.
** Ini berarti library memiliki instance resource/fitur sendiri dan semua skrip yang menggunakan library berbagi dan memiliki akses ke instance yang sama.

Menguji library

Untuk menguji library, gunakan deployment head. Siapa pun yang memiliki akses tingkat editor ke skrip dapat menggunakan deployment head.

Men-debug library

Saat menggunakan debugger dalam project yang menyertakan library, Anda dapat masuk ke fungsi library yang disertakan. Kode akan muncul di debugger dalam mode hanya lihat dan pada versi yang tepat.