Class Properties

Properti

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

Metode

Metode	Jenis nilai yang ditampilkan	Deskripsi singkat
deleteAllProperties()	Properties	Menghapus semua properti di toko 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 tidak ada kunci tersebut.
setProperties(properties)	Properties	Menetapkan semua key-value pair dari objek yang diberikan di penyimpanan Properties saat ini.
setProperties(properties, deleteAllOthers)	Properties	Menetapkan semua key-value pair dari objek yang diberikan di penyimpanan Properties saat ini, secara opsional menghapus semua properti lain di penyimpanan.
setProperty(key, value)	Properties	Menetapkan pasangan nilai kunci yang diberikan di penyimpanan Properties saat ini.

Dokumentasi mendetail

deleteAllProperties()

Menghapus semua properti di toko Properties saat ini.

// Deletes all user properties.
const userProperties = PropertiesService.getUserProperties();
userProperties.deleteAllProperties();

Pulang pergi

Properties — toko Properties ini, untuk dirangkaikan

---

deleteProperty(key)

Menghapus properti dengan kunci yang diberikan di penyimpanan Properties saat ini.

// Deletes the user property 'nickname'.
const userProperties = PropertiesService.getUserProperties();
userProperties.deleteProperty('nickname');

Parameter

Nama	Jenis	Deskripsi
key	String	kunci untuk properti yang akan dihapus

Pulang pergi

Properties — toko Properties ini, untuk dirangkaikan

---

getKeys()

Mendapatkan semua kunci di penyimpanan Properties saat ini.

// Sets several properties, then logs the value of each key.
const scriptProperties = PropertiesService.getScriptProperties();
scriptProperties.setProperties({
  cow: 'moo',
  sheep: 'baa',
  chicken: 'cluck',
});
const keys = scriptProperties.getKeys();
Logger.log('Animals known:');
for (let 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 objek yang ditampilkan bukan tampilan langsung toko. Oleh karena itu, mengubah properti pada objek yang ditampilkan tidak akan otomatis memperbaruinya di penyimpanan, atau sebaliknya.

// Sets several script properties, then retrieves them and logs them.
const scriptProperties = PropertiesService.getScriptProperties();
scriptProperties.setProperties({
  cow: 'moo',
  sheep: 'baa',
  chicken: 'cluck',
});

const animalSounds = scriptProperties.getProperties();

// Logs:
// A chicken goes cluck!
// A cow goes moo!
// A sheep goes baa!
for (const kind in animalSounds) {
  Logger.log('A %s goes %s!', kind, animalSounds[kind]);
}

Pulang pergi

Object — salinan semua key-value pair di penyimpanan Properties saat ini

---

getProperty(key)

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

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

Parameter

Nama	Jenis	Deskripsi
key	String	kunci untuk nilai properti yang akan diambil

Pulang pergi

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

---

setProperties(properties)

Menetapkan semua key-value pair dari objek yang diberikan di penyimpanan Properties saat ini.

// Sets multiple user properties at once.
const userProperties = PropertiesService.getUserProperties();
const newProperties = {
  nickname: 'Bob',
  region: 'US',
  language: 'EN'
};
userProperties.setProperties(newProperties);

Parameter

Nama	Jenis	Deskripsi
properties	Object	objek yang berisi key-value pair yang akan ditetapkan

Pulang pergi

Properties — toko Properties ini, untuk dirangkaikan

---

setProperties(properties, deleteAllOthers)

Menetapkan semua key-value pair dari objek yang diberikan di penyimpanan Properties saat ini, secara opsional menghapus semua properti lain di penyimpanan.

// Sets multiple user properties at once while deleting all other user
// properties.
const userProperties = PropertiesService.getUserProperties();
const newProperties = {
  nickname: 'Bob',
  region: 'US',
  language: 'EN'
};
userProperties.setProperties(newProperties, true);

Parameter

Nama	Jenis	Deskripsi
properties	Object	objek yang berisi key-value pair yang akan ditetapkan
deleteAllOthers	Boolean	true untuk menghapus semua key-value pair lainnya dalam objek properti; false jika tidak

Pulang pergi

Properties — toko Properties ini, untuk dirangkaikan

---

setProperty(key, value)

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

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

Parameter

Nama	Jenis	Deskripsi
key	String	kunci untuk properti
value	String	nilai yang akan dikaitkan dengan kunci

Pulang pergi

Properties — toko Properties ini, untuk dirangkaikan