Pustaka

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

Mendapatkan akses ke library

Untuk menyertakan library dalam project, Anda setidaknya harus memiliki akses tingkat tampilan ke library tersebut. Jika Anda bukan penulis library yang ingin disertakan, 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 Setelan Project .

Menambahkan library ke project skrip

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

Menggunakan library

Gunakan library yang disertakan seperti saat Anda menggunakan layanan default. Misalnya, jika Test adalah ID untuk library Anda, ketik Test yang langsung diikuti dengan titik untuk melihat daftar metode dalam 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 koleksi

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

Mengupdate library

Anda dapat mengubah versi library atau mengupdate ID-nya.

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

Membuat dan membagikan galeri foto

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

  1. Buat deployment berversi untuk 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 Project settings.

Praktik terbaik

Berikut ini beberapa panduan yang harus diikuti saat menulis library:

  1. Pilih nama yang bermakna untuk project Anda karena akan digunakan sebagai ID default saat library Anda disertakan oleh orang lain.
  2. Jika ingin satu atau beberapa metode skrip tidak terlihat (tidak dapat digunakan) oleh pengguna library, Anda dapat mengakhiri nama metode dengan garis bawah. Misalnya, myPrivateMethod_().
  3. Hanya properti global yang dapat dienumerasi yang terlihat 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 yang ditetapkan ke false akan membuat simbol yang dapat Anda gunakan di library, tetapi simbol ini tidak dapat diakses oleh pengguna.

  4. Jika Anda ingin pengguna library memanfaatkan pelengkapan otomatis editor skrip dan dokumentasi yang dihasilkan secara otomatis, Anda harus memiliki dokumentasi bergaya JSDoc untuk semua fungsi Anda. 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 dibagikan. Resource bersama berarti library dan skrip yang disertakan memiliki akses bawaan ke instance resource yang sama. Diagram berikut mengilustrasikan resource bersama menggunakan contoh Properti Pengguna:

Referensi Bersama

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

  function getLibraryProperty(key) {
    return ScriptProperties.getProperty(key);
  }

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

Aset yang Tidak Bersama

Tabel ini mencantumkan referensi bersama dan tidak dibagikan sebagai referensi Anda:

Resource Dibagikan* Tidak Dibagikan** Catatan
Kunci Instance yang sama dapat dilihat oleh semua skrip yang disertakan saat dibuat di library.
Properti Skrip Instance yang sama dapat dilihat oleh semua skrip yang disertakan saat dibuat di library.
Cache Instance yang sama dapat dilihat oleh semua skrip yang disertakan saat dibuat di library.
Pemicu Pemicu sederhana yang dibuat di library tidak dipicu oleh skrip yang disertakan.
ScriptApp
UiApp
Properti Pengguna
Pencatat log dan transkrip eksekusi
Sites, Spreadsheet, dan penampung lainnya Panggilan ke getActive() akan menampilkan penampung skrip yang disertakan.
MailApp dan GmailApp
* Artinya, library tidak memiliki instance fitur/resource-nya sendiri, dan sebagai gantinya menggunakan instance yang dibuat oleh skrip yang memanggilnya.
** Artinya, library memiliki instance resource/fiturnya sendiri, dan semua skrip yang menggunakan library tersebut berbagi dan memiliki akses ke instance yang sama.

Menguji library

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

Men-debug library

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