Class Properties

Properti

Objek properti berfungsi sebagai antarmuka untuk mengakses properti pengguna, dokumen, atau skrip. Tujuan jenis properti tertentu bergantung pada metode PropertiesService mana yang skrip yang disebut: PropertiesService.getDocumentProperties(), PropertiesService.getUserProperties(), atau PropertiesService.getScriptProperties(). Properti tidak dapat dibagikan di antara skrip. Untuk informasi selengkapnya tentang jenis properti, lihat panduan layanan Properti.

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
deleteAllProperties()PropertiesMenghapus semua properti di penyimpanan Properties saat ini.
deleteProperty(key)PropertiesMenghapus properti dengan kunci yang diberikan di penyimpanan Properties saat ini.
getKeys()String[]Mendapatkan semua kunci di penyimpanan Properties saat ini.
getProperties()ObjectMendapatkan salinan semua key-value pair di penyimpanan Properties saat ini.
getProperty(key)StringMendapatkan nilai yang terkait dengan kunci yang diberikan dalam penyimpanan Properties saat ini, atau null jika tidak ada kunci tersebut.
setProperties(properties)PropertiesMenetapkan semua pasangan nilai kunci dari objek yang diberikan di penyimpanan Properties saat ini.
setProperties(properties, deleteAllOthers)PropertiesMenetapkan semua pasangan nilai kunci dari objek yang diberikan di penyimpanan Properties saat ini, atau menghapus semua properti lain di toko secara opsional.
setProperty(key, value)PropertiesMenetapkan pasangan nilai kunci yang ditentukan 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();

Pulang pergi

Properties — toko Properties ini, untuk rantai


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

NamaJenisDeskripsi
keyStringkunci untuk properti yang akan dihapus

Pulang pergi

Properties — toko Properties ini, untuk rantai


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]);
}

Pulang pergi

String[] — array semua kunci di penyimpanan Properties saat ini


getProperties()

Mendapatkan salinan semua key-value pair di penyimpanan Properties saat ini. Perhatikan bahwa yang ditampilkan bukan merupakan tampilan langsung dari toko. Akibatnya, mengubah properti pada yang dikembalikan tidak akan memperbaruinya secara otomatis 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]);
}

Pulang pergi

Object — salinan semua pasangan nilai kunci di penyimpanan Properties saat ini


getProperty(key)

Mendapatkan nilai yang terkait dengan kunci yang diberikan dalam penyimpanan Properties saat ini, atau null jika tidak ada kunci tersebut.

// Gets the user property 'nickname'.
var userProperties = PropertiesService.getUserProperties();
var nickname = userProperties.getProperty('nickname');
Logger.log(nickname);

Parameter

NamaJenisDeskripsi
keyStringkunci untuk nilai properti yang akan diambil

Pulang pergi

String — nilai yang terkait dengan kunci yang diberikan di penyimpanan Properties saat ini


setProperties(properties)

Menetapkan semua pasangan nilai kunci dari objek yang diberikan 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

NamaJenisDeskripsi
propertiesObjectobjek yang berisi pasangan nilai-kunci untuk diatur

Pulang pergi

Properties — toko Properties ini, untuk rantai


setProperties(properties, deleteAllOthers)

Menetapkan semua pasangan nilai kunci dari objek yang diberikan di penyimpanan Properties saat ini, atau menghapus semua properti lain di toko secara opsional.

// 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

NamaJenisDeskripsi
propertiesObjectobjek yang berisi pasangan nilai-kunci untuk diatur
deleteAllOthersBooleantrue untuk menghapus semua key-value pair lainnya di properti object; false ke tidak

Pulang pergi

Properties — toko Properties ini, untuk rantai


setProperty(key, value)

Menetapkan pasangan nilai kunci yang ditentukan di penyimpanan Properties saat ini.

// Sets the user property 'nickname' to 'Bobby'.
var userProperties = PropertiesService.getUserProperties();
userProperties.setProperty('nickname', 'Bobby');

Parameter

NamaJenisDeskripsi
keyStringkunci untuk properti
valueStringnilai yang akan dikaitkan dengan kunci

Pulang pergi

Properties — toko Properties ini, untuk rantai