Objek properti bertindak sebagai antarmuka untuk mengakses properti pengguna, dokumen, atau skrip. Jenis properti spesifik bergantung pada ketiga metode PropertiesService
yang dipanggil oleh skrip: PropertiesService.getDocumentProperties()
, PropertiesService.getUserProperties()
, atau PropertiesService.getScriptProperties()
.
Properti tidak dapat dibagikan antar-skrip. Untuk mengetahui informasi selengkapnya tentang jenis properti, lihat panduan layanan Properti.
Metode
Metode | Jenis hasil yang ditampilkan | Deskripsi singkat |
---|---|---|
deleteAllProperties() | Properties | Menghapus semua properti di penyimpanan Properties saat ini. |
deleteProperty(key) | Properties | Menghapus properti dengan kunci yang diberikan di penyimpanan Properties saat ini. |
getKeys() | String[] | Mendapatkan semua kunci di penyimpanan Properties saat ini. |
getProperties() | Object | Mendapatkan salinan semua key-value pair di penyimpanan Properties saat ini. |
getProperty(key) | String | Mendapatkan nilai yang terkait dengan kunci yang diberikan di penyimpanan Properties saat ini, atau null jika kunci tersebut tidak ada. |
setProperties(properties) | Properties | Menetapkan semua key-value pair dari objek tertentu di penyimpanan Properties saat ini. |
setProperties(properties, deleteAllOthers) | Properties | Menetapkan semua key-value pair dari objek yang ditentukan dalam penyimpanan Properties saat ini, dan secara opsional menghapus semua properti lain di store. |
setProperty(key, value) | Properties | Menetapkan pasangan nilai kunci tertentu di penyimpanan Properties saat ini. |
Dokumentasi mendetail
deleteAllProperties()
Menghapus semua properti di penyimpanan Properties
saat ini.
// Deletes all user properties. var userProperties = PropertiesService.getUserProperties(); userProperties.deleteAllProperties();
Return
Properties
— toko Properties
ini, untuk perantaian
deleteProperty(key)
Menghapus properti dengan kunci yang diberikan di penyimpanan Properties
saat ini.
// Deletes the user property 'nickname'. var userProperties = PropertiesService.getUserProperties(); userProperties.deleteProperty('nickname');
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
key | String | kunci untuk properti yang akan dihapus |
Return
Properties
— toko Properties
ini, untuk perantaian
getKeys()
Mendapatkan semua kunci di penyimpanan Properties
saat ini.
// Sets several properties, then logs the value of each key. var scriptProperties = PropertiesService.getScriptProperties(); scriptProperties.setProperties({ 'cow': 'moo', 'sheep': 'baa', 'chicken': 'cluck' }); var keys = scriptProperties.getKeys(); Logger.log('Animals known:'); for (var i = 0; i < keys.length; i++) { Logger.log(keys[i]); }
Return
String[]
— array dari semua kunci di penyimpanan Properties
saat ini
getProperties()
Mendapatkan salinan semua key-value pair di penyimpanan Properties
saat ini. Perlu diperhatikan bahwa
objek yang ditampilkan bukan tayangan langsung toko. Akibatnya, mengubah properti pada
objek yang ditampilkan tidak akan otomatis mengupdatenya di penyimpanan, atau sebaliknya.
// Sets several script properties, then retrieves them and logs them. var scriptProperties = PropertiesService.getScriptProperties(); scriptProperties.setProperties({ 'cow': 'moo', 'sheep': 'baa', 'chicken': 'cluck' }); var animalSounds = scriptProperties.getProperties(); // Logs: // A chicken goes cluck! // A cow goes moo! // A sheep goes baa! for (var kind in animalSounds) { Logger.log('A %s goes %s!', kind, animalSounds[kind]); }
Return
Object
— salinan semua key-value pair di toko Properties
saat ini
getProperty(key)
Mendapatkan nilai yang terkait dengan kunci yang diberikan di penyimpanan Properties
saat ini, atau null
jika kunci tersebut tidak ada.
// Gets the user property 'nickname'. var userProperties = PropertiesService.getUserProperties(); var nickname = userProperties.getProperty('nickname'); Logger.log(nickname);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
key | String | kunci untuk nilai properti yang akan diambil |
Return
String
— nilai yang terkait dengan kunci yang diberikan di penyimpanan Properties
saat ini
setProperties(properties)
Menetapkan semua key-value pair dari objek tertentu di penyimpanan Properties
saat ini.
// Sets multiple user properties at once. var userProperties = PropertiesService.getUserProperties(); var newProperties = {nickname: 'Bob', region: 'US', language: 'EN'}; userProperties.setProperties(newProperties);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
properties | Object | objek yang berisi pasangan nilai-kunci untuk diatur |
Return
Properties
— toko Properties
ini, untuk perantaian
setProperties(properties, deleteAllOthers)
Menetapkan semua key-value pair dari objek yang ditentukan dalam penyimpanan Properties
saat ini, dan secara opsional menghapus semua properti lain di store.
// Sets multiple user properties at once while deleting all other user properties. var userProperties = PropertiesService.getUserProperties(); var newProperties = {nickname: 'Bob', region: 'US', language: 'EN'}; userProperties.setProperties(newProperties, true);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
properties | Object | objek yang berisi pasangan nilai-kunci untuk diatur |
deleteAllOthers | Boolean | true untuk menghapus semua key-value pair lainnya di objek properti; false untuk menghapus |
Return
Properties
— toko Properties
ini, untuk perantaian
setProperty(key, value)
Menetapkan pasangan nilai kunci tertentu di penyimpanan Properties
saat ini.
// Sets the user property 'nickname' to 'Bobby'. var userProperties = PropertiesService.getUserProperties(); userProperties.setProperty('nickname', 'Bobby');
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
key | String | kunci untuk properti |
value | String | nilai yang akan dikaitkan dengan kunci |
Return
Properties
— toko Properties
ini, untuk perantaian