Layanan Properti memungkinkan Anda menyimpan data sederhana dalam key-value pair yang dicakup dalam satu skrip, satu pengguna skrip, atau satu dokumen yang menggunakan add-on. Penting yang biasanya digunakan untuk menyimpan konfigurasi developer atau preferensi pengguna. Properti tidak pernah dibagikan di antara skrip.
Untuk melihat kuota harian dan batas penyimpanan layanan Properti, lihat Kuota untuk Layanan Google.
Perbandingan toko properti
Tujuan
PropertiesService
menawarkan tiga metode, yang masing-masing mengembalikan
Properties
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 antara | Semua pengguna skrip, add-on, atau aplikasi web | Pengguna skrip, add-on, atau aplikasi web saat ini | Semua pengguna add-on dalam dokumen yang terbuka |
Biasanya digunakan untuk | Data konfigurasi di seluruh aplikasi, seperti nama pengguna dan sandi untuk database eksternal developer | Setelan khusus pengguna, seperti metrik atau unit imperial | Data khusus dokumen, seperti URL sumber untuk diagram yang disematkan |
Format data
Layanan Properties menyimpan semua data sebagai string dalam key-value pair. Tipe data yang belum menjadi string akan otomatis dikonversi menjadi string, termasuk metode yang terkandung dalam objek yang disimpan.
Menyimpan data
Untuk menyimpan satu nilai, panggil metode Properties.setProperty(key,
value)
dari app store yang sesuai, seperti yang ditunjukkan dalam contoh berikut:
Untuk menyimpan data secara massal, teruskan peta key-value pair ke
Properties.setProperties(properties)
Setiap pasangan nilai kunci objek dalam parameter disimpan sebagai kunci terpisah
properti:
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 disimpan
data, bukan tayangan langsung, jadi mengubah objek yang ditampilkan tidak akan memperbarui nilainya
di toko properti. Untuk memperbarui data di Store, 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 kustom secara manual, sebagai string di nilai kunci berpasangan, dari laman pengaturan proyek. Untuk menambahkan lebih dari lima puluh properti, Anda menambahkannya secara terprogram menggunakan metode yang dijelaskan di atas Menyimpan data. Saat menetapkan properti skrip dari halaman setelan project, Anda tidak dapat variabel skrip referensi.
Menambahkan properti skrip
- Buka project Apps Script Anda.
- Di sebelah kiri, klik Project Settings
.
- 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.
Mengedit properti skrip
- Buka project Apps Script Anda.
- Di sebelah kiri, klik Project Settings
.
- Di bagian Properti Skrip, klik Edit properti skrip.
- Buat 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 Anda.
- Di sebelah kiri, klik Project Settings
.
- Di bagian Properti Skrip, klik Edit properti skrip.
- Di samping properti yang ingin dihapus, klik Hapus .
- Klik Simpan properti skrip.