Class Properties

屬性

屬性物件可做為存取使用者、文件或指令碼屬性的介面。特定屬性類型取決於指令碼有三種 PropertiesService 方法中的哪一種：PropertiesService.getDocumentProperties()、PropertiesService.getUserProperties() 或 PropertiesService.getScriptProperties()。無法在指令碼之間共用屬性。如要進一步瞭解屬性類型，請參閱屬性服務指南。

方法

方法傳回類型簡短說明
deleteAllProperties()Properties刪除目前 Properties 儲存庫中的所有屬性。
deleteProperty(key)Properties刪除在目前 Properties 儲存庫中含有指定鍵的屬性。
getKeys()String[]取得目前 Properties 儲存庫中的所有鍵。
getProperties()Object取得目前 Properties 儲存庫中所有鍵/值組合的副本。
getProperty(key)String取得與目前 Properties 儲存庫中的指定鍵相關聯的值；如果沒有這類鍵，則會取得 null。
setProperties(properties)Properties設定目前 Properties 儲存庫中的指定物件所有鍵/值組合。
setProperties(properties, deleteAllOthers)Properties設定目前 Properties 儲存庫中的指定物件所有鍵/值組合，並視需要刪除儲存庫中的所有其他屬性。
setProperty(key, value)Properties設定在目前 Properties 儲存庫中的特定鍵/值組合。

內容詳盡的說明文件

deleteAllProperties()

刪除目前 Properties 儲存庫中的所有屬性。 

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

回攻員

Properties — 這 Properties 間商店，用於鏈結

deleteProperty(key)

刪除目前 Properties 儲存庫中含有指定鍵的屬性。

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

參數

名稱類型說明
keyString要刪除的屬性鍵

回攻員

Properties — 這 Properties 間商店，用於鏈結

getKeys()

取得目前 Properties 儲存庫中的所有鍵。

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

回攻員

String[]：目前 Properties 儲存庫中的所有鍵的陣列

getProperties()

取得目前 Properties 儲存庫中所有鍵/值組合的副本。請注意，傳回的物件並非商店的即時檢視畫面。因此，變更傳回物件的屬性，並不會在儲存空間中自動更新這些屬性，反之亦然。

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

回攻員

Object：目前 Properties 儲存庫中的所有鍵/值組合副本

getProperty(key)

取得與目前 Properties 儲存庫中的指定鍵相關聯的值；如果沒有這類鍵，則會取得 null。

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

參數

名稱類型說明
keyString要擷取的屬性值鍵

回攻員

String：與目前 Properties 儲存庫中的指定鍵相關聯的值

setProperties(properties)

設定目前 Properties 儲存庫中的指定物件所有鍵/值組合。

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

參數

名稱類型說明
propertiesObject物件包含要設定的鍵/值組合

回攻員

Properties — 這 Properties 間商店，用於鏈結

setProperties(properties, deleteAllOthers)

設定目前 Properties 儲存庫中的指定物件所有鍵/值組合，並視需要刪除儲存庫中的所有其他屬性。

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

參數

名稱類型說明
propertiesObject物件包含要設定的鍵/值組合
deleteAllOthersBooleantrue 可刪除屬性物件中的所有其他鍵/值組合，false 可以避免刪除

回攻員

Properties — 這 Properties 間商店，用於鏈結

setProperty(key, value)

設定在目前 Properties 儲存庫中的特定鍵/值組合。 

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

參數

名稱類型說明
keyString屬性的鍵
valueString要與鍵建立關聯的值

回攻員

Properties — 這 Properties 間商店，用於鏈結