Layanan Properti memungkinkan Anda menyimpan data sederhana dalam key-value pair yang dicakupkan ke satu skrip, satu pengguna skrip, atau satu dokumen yang menggunakan add-on. Objek ini biasanya digunakan untuk menyimpan konfigurasi developer atau preferensi pengguna. Properti tidak pernah dibagikan antar-skrip.
Untuk melihat kuota harian dan batas penyimpanan untuk layanan Properti, lihat Kuota untuk Layanan Google.
Perbandingan toko properti
Objek global
PropertiesService
menawarkan tiga metode, yang masing-masing menampilkan objek
Properties
yang serupa tetapi dengan hak akses yang berbeda, seperti ditunjukkan dalam tabel berikut:
Properti Skrip | Properti Pengguna | Properti Dokumen | |
---|---|---|---|
Metode untuk mengakses | getScriptProperties() |
getUserProperties() |
getDocumentProperties() |
Data yang dibagikan di antara | Semua pengguna skrip, add-on, atau aplikasi web | Pengguna skrip, add-on, atau aplikasi web saat ini | Semua pengguna add-on di dokumen yang terbuka |
Biasanya digunakan untuk | Data konfigurasi seluruh aplikasi, seperti nama pengguna dan sandi untuk database eksternal developer | Setelan spesifik per pengguna, seperti metrik atau unit imperial | Data khusus dokumen, seperti URL sumber untuk diagram tersemat |
Format data
Layanan Properties menyimpan semua data sebagai string dalam key-value pair. Jenis data yang belum menjadi string akan otomatis dikonversi menjadi string, termasuk metode yang terdapat dalam objek tersimpan.
Menyimpan data
Untuk menyimpan satu nilai, panggil metode Properties.setProperty(key,
value)
dari penyimpanan yang sesuai, seperti ditunjukkan dalam contoh berikut:
Untuk menyimpan data secara massal, teruskan peta key-value pair ke
Properties.setProperties(properties)
.
Setiap key-value pair objek dalam parameter disimpan sebagai properti terpisah:
Membaca data
Untuk mengambil satu nilai yang telah Anda simpan sebelumnya, panggil
Properties.getProperty(key)
:
Untuk mengambil semua nilai di penyimpanan properti saat ini, panggil Properties.getProperties()
:
Mengubah data
Metode getProperty()
dan getProperties()
menampilkan salinan data yang tersimpan, bukan tampilan langsung, sehingga mengubah objek yang ditampilkan tidak akan memperbarui nilai
di penyimpanan properti. Untuk memperbarui data di toko, cukup simpan lagi:
Menghapus data
Untuk menghapus satu nilai, panggil
Properties.deleteProperty(key)
:
Untuk menghapus semua properti di toko saat ini, panggil
Properties.deleteAllProperties()
:
Mengelola properti skrip secara manual
Anda dapat menambahkan hingga lima puluh properti khusus secara manual, sebagai string dalam key-value pair, dari halaman setelan project. Untuk menambahkan lebih dari lima puluh properti, Anda harus menambahkannya secara terprogram menggunakan metode yang dijelaskan di atas dalam Menyimpan data. Jika Anda menetapkan properti skrip dari halaman setelan project, Anda tidak dapat mereferensikan variabel skrip.
Menambahkan properti skrip
- Buka project Apps Script.
- Di sebelah kiri, klik Setelan Project .
- Untuk menambahkan properti pertama, di bagian Properti Skrip, klik Tambahkan properti skrip.
- Untuk menambahkan properti kedua dan berikutnya, di bagian Properti Skrip, klik Edit properti skrip > Tambahkan properti skrip.
- Untuk Properti, masukkan nama kunci.
- Untuk Nilai, masukkan nilai untuk kunci.
- (Opsional) Untuk menambahkan properti lainnya, klik Tambahkan properti skrip.
- Klik Simpan properti skrip.
Edit properti skrip
- Buka project Apps Script.
- Di sebelah kiri, klik Setelan Project .
- Di bagian Properti Skrip, klik Edit properti skrip.
- Lakukan perubahan pada nama kunci dan nilai kunci untuk setiap properti yang ingin Anda ubah.
- Klik Simpan properti skrip.
Hapus properti skrip
- Buka project Apps Script.
- Di sebelah kiri, klik Setelan Project .
- Di bagian Properti Skrip, klik Edit properti skrip.
- Di samping properti yang ingin Anda hapus, klik Hapus .
- Klik Simpan properti skrip.