Class Properties

Mülkler

properties nesnesi, kullanıcı, doküman veya komut dosyası özelliklerine erişmek için arayüz görevi görür. Belirli mülk türü, komut dosyasının PropertiesService yöntemlerinden hangisinin çağrı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öntemDönüş türüKısa açıklama
deleteAllProperties()PropertiesGeçerli Properties mağazasındaki tüm mülkleri siler.
deleteProperty(key)PropertiesGeçerli Properties mağazasında, belirtilen anahtara sahip mülkü siler.
getKeys()String[]Geçerli Properties mağazasındaki tüm anahtarları alır.
getProperties()ObjectGeçerli Properties mağazasındaki tüm anahtar/değer çiftlerinin bir kopyasını alır.
getProperty(key)StringGeçerli Properties mağazasında belirtilen anahtarla ilişkili değeri veya böyle bir anahtar yoksa null değerini alır.
setProperties(properties)PropertiesMevcut Properties mağazasındaki belirli nesnenin tüm anahtar/değer çiftlerini ayarlar.
setProperties(properties, deleteAllOthers)PropertiesGeçerli Properties mağazasındaki belirli bir nesnenin tüm anahtar/değer çiftlerini ayarlar ve isteğe bağlı olarak mağazadaki diğer tüm özellikleri siler.
setProperty(key, value)PropertiesMevcut Properties mağazasında belirtilen anahtar/değer çiftini ayarlar.

Ayrıntılı dokümanlar

deleteAllProperties()

Geçerli 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 mağazasında, belirtilen anahtara sahip mülkü siler.

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

Parametreler

AdTürAçıklama
keyStringSilecek mülkün anahtarı

Return

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


getKeys()

Geçerli Properties mağazasındaki 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 mağazasındaki tüm anahtarların dizisi


getProperties()

Geçerli 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. Sonuç olarak, döndürülen nesnenin özelliklerinin değiştirilmesi, depolama alanındaki özellikleri otomatik olarak güncellemez veya bunun 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 mağazasında belirtilen 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

AdTürAçıklama
keyStringAlınacak özellik değerinin anahtarı

Return

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


setProperties(properties)

Mevcut Properties mağazasındaki belirli nesnenin tüm anahtar/değer çiftlerini ayarlar.

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

Parametreler

AdTürAçıklama
propertiesObjectAyarlanacak anahtar/değer çiftlerini içeren bir nesne

Return

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


setProperties(properties, deleteAllOthers)

Geçerli Properties mağazasındaki belirli bir nesnenin tüm anahtar/değer çiftlerini ayarlar ve isteğe bağlı olarak mağazadaki 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

AdTürAçıklama
propertiesObjectAyarlanacak anahtar/değer çiftlerini içeren bir nesne
deleteAllOthersBooleantrue, mülk nesnesinde diğer tüm anahtar/değer çiftlerini silmek için; false, silmek için değil

Return

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


setProperty(key, value)

Mevcut Properties mağazasında belirtilen anahtar/değer çiftini ayarlar.

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

Parametreler

AdTürAçıklama
keyStringTesisin anahtarı
valueStringAnahtarla ilişkilendirilecek değer

Return

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