Class Properties

Mülkler

Özellikler nesnesi; kullanıcı, doküman veya komut dosyası özelliklerine erişmek için arayüz işlevi görür. Özel özellik türü, komut dosyasının üç PropertiesService yönteminden hangisinin PropertiesService.getDocumentProperties(), PropertiesService.getUserProperties() veya PropertiesService.getScriptProperties() olarak adlandırıldığına bağlıdır. Özellikler, komut dosyaları arasında paylaşılamaz. Mülk türleri hakkında daha fazla bilgi için Mülkler hizmeti rehberine bakın.

Yöntemler

YöntemDönüş türüKısa açıklama
deleteAllProperties()PropertiesMevcut Properties mağazasındaki tüm mülkleri siler.
deleteProperty(key)PropertiesGeçerli Properties deposunda belirtilen anahtara sahip mülkü siler.
getKeys()String[]Geçerli Properties mağazasındaki tüm anahtarları alır.
getProperties()ObjectGeçerli Properties deposundaki tüm anahtar/değer çiftlerinin bir kopyasını alır.
getProperty(key)StringGeçerli Properties deposunda belirtilen anahtarla ilişkilendirilen değeri veya böyle bir anahtar yoksa null değerini alır.
setProperties(properties)PropertiesGeçerli Properties deposunda belirtilen nesneden tüm anahtar/değer çiftlerini ayarlar.
setProperties(properties, deleteAllOthers)PropertiesGeçerli Properties deposunda belirtilen nesneden tüm anahtar/değer çiftlerini ayarlar (isteğe bağlı olarak mağazadaki diğer tüm özellikleri siler).
setProperty(key, value)PropertiesGeç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.
var userProperties = PropertiesService.getUserProperties();
userProperties.deleteAllProperties();

Return

Properties — bu Properties mağazası, zincirleme satış için


deleteProperty(key)

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

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

Parametreler

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

Return

Properties — bu Properties mağazası, zincirleme satış için


getKeys()

Geçerli Properties mağazasındaki tüm anahtarları alır.

// 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[]: mevcut Properties deposundaki tüm anahtarların dizisi


getProperties()

Geçerli Properties deposundaki 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 nesnedeki özellikler değiştirildiğinde bu özellikler depolama alanında otomatik olarak güncellenmez. Bunun tersi de geçerlidir.

// 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: Geçerli Properties mağazasındaki tüm anahtar/değer çiftlerinin bir kopyasıdır.


getProperty(key)

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

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

Parametreler

AdTürAçıklama
keyStringözellik değeri anahtarı

Return

String: Mevcut Properties deposunda belirtilen anahtarla ilişkilendirilmiş değerdir


setProperties(properties)

Geçerli Properties deposunda belirtilen nesneden tüm anahtar/değer çiftlerini ayarlar.

// Sets multiple user properties at once.
var userProperties = PropertiesService.getUserProperties();
var 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 — bu Properties mağazası, zincirleme satış için


setProperties(properties, deleteAllOthers)

Geçerli Properties deposunda belirtilen nesneden tüm anahtar/değer çiftlerini ayarlar (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.
var userProperties = PropertiesService.getUserProperties();
var newProperties = {nickname: 'Bob', region: 'US', language: 'EN'};
userProperties.setProperties(newProperties, true);

Parametreler

AdTürAçıklama
propertiesObjectayarlanacak anahtar/değer çiftlerini içeren bir nesne
deleteAllOthersBooleanÖzellikler nesnesindeki diğer tüm anahtar/değer çiftlerini silmek için true; silmemek için false

Return

Properties — bu Properties mağazası, zincirleme satış için


setProperty(key, value)

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

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

Parametreler

AdTürAçıklama
keyStringmülkün anahtarı
valueStringanahtarla ilişkilendirilecek değer

Return

Properties — bu Properties mağazası, zincirleme satış için