Class Properties

Mülkler

Özellikler nesnesi, kullanıcı, doküman veya komut dosyası özelliklerine erişmek için arayüz görevi görür. Belirli özellik türü, komut dosyasının çağrıldığı üç PropertiesService yönteminden hangisinin kullanıldığına bağlıdır: PropertiesService.getDocumentProperties(), PropertiesService.getUserProperties() veya PropertiesService.getScriptProperties(). Özellikler, komut dosyaları arasında paylaşılamaz. Mülk türleri hakkında daha fazla bilgi için Özellikler Hizmeti kılavuzuna bakın.

Yöntemler

Yöntem	Dönüş türü	Kısa açıklama
deleteAllProperties()	Properties	Mevcut Properties mağazasındaki tüm mülkleri siler.
deleteProperty(key)	Properties	Geçerli Properties deposunda, belirtilen anahtara sahip mülkü siler.
getKeys()	String[]	Geçerli Properties deposundaki tüm anahtarları alır.
getProperties()	Object	Mevcut Properties mağazasındaki tüm anahtar/değer çiftlerinin bir kopyasını alır.
getProperty(key)	String	Geçerli Properties deposunda verilen anahtarla ilişkili değeri veya böyle bir anahtar yoksa null değerini alır.
setProperties(properties)	Properties	Belirtilen nesnedeki tüm anahtar/değer çiftlerini geçerli Properties deposunda ayarlar.
setProperties(properties, deleteAllOthers)	Properties	Belirtilen nesnedeki tüm anahtar-değer çiftlerini geçerli Properties deposuna ayarlar ve isteğe bağlı olarak depodaki diğer tüm özellikleri siler.
setProperty(key, value)	Properties	Geçerli Properties deposunda belirtilen anahtar/değer çiftini ayarlar.

Ayrıntılı belgeler

deleteAllProperties()

Mevcut Properties mağazasındaki tüm mülkleri siler.

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

Return

Properties: Zincirleme için bu Properties mağazası

---

deleteProperty(key)

Geçerli Properties deposunda, belirtilen anahtara sahip mülkü siler.

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

Parametreler

Ad	Tür	Açıklama
key	String	Silinecek mülkün anahtarı

Return

Properties: Zincirleme için bu Properties mağazası

---

getKeys()

Geçerli Properties deposundaki tüm anahtarları alır.

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

Return

String[] — geçerli Properties deposundaki tüm anahtarların dizisi

---

getProperties()

Mevcut Properties mağazasındaki tüm anahtar/değer çiftlerinin bir kopyasını alır. Döndürülen nesnenin, mağazanın canlı görünümü olmadığını unutmayın. Dolayısıyla, döndürülen nesnedeki özelliklerin değiştirilmesi, depolamadaki özellikleri otomatik olarak güncellemez veya bunun tam tersi de geçerli değildir.

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

Return

Object: Mevcut Properties mağazasındaki tüm anahtar/değer çiftlerinin kopyası

---

getProperty(key)

Geçerli Properties deposunda verilen anahtarla ilişkili değeri veya böyle bir anahtar yoksa null değerini alır.

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

Parametreler

Ad	Tür	Açıklama
key	String	alınacak özellik değerinin anahtarı

Return

String: Geçerli Properties mağazasında verilen anahtarla ilişkili değer

---

setProperties(properties)

Belirtilen nesnedeki tüm anahtar/değer çiftlerini geçerli Properties deposunda ayarlar.

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

Parametreler

Ad	Tür	Açıklama
properties	Object	ayarlanacak anahtar/değer çiftlerini içeren bir nesne

Return

Properties: Zincirleme için bu Properties mağazası

---

setProperties(properties, deleteAllOthers)

Belirtilen nesnedeki tüm anahtar-değer çiftlerini geçerli Properties deposuna ayarlar ve isteğe bağlı olarak depodaki diğer tüm özellikleri siler.

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

Parametreler

Ad	Tür	Açıklama
properties	Object	ayarlanacak anahtar/değer çiftlerini içeren bir nesne
deleteAllOthers	Boolean	true: Özellikler nesnesindeki diğer tüm anahtar/değer çiftlerini silmek için; false: Silmemek için

Return

Properties: Zincirleme için bu Properties mağazası

---

setProperty(key, value)

Geçerli Properties deposunda belirtilen anahtar/değer çiftini ayarlar.

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

Parametreler

Ad	Tür	Açıklama
key	String	tesisin anahtarı
value	String	anahtarla ilişkilendirilecek değer

Return

Properties: Zincirleme için bu Properties mağazası