Class ScriptProperties

指令碼屬性

已淘汰。這個類別已淘汰，不應在新指令碼中使用。

指令碼屬性是指令碼儲存在永久儲存空間中的鍵/值組合。無論是哪位使用者執行指令碼，指令碼屬性都會限定於特定指令碼。

已淘汰的方法

方法	傳回類型	簡短說明
deleteAllProperties()	ScriptProperties	刪除所有屬性。
deleteProperty(key)	ScriptProperties	刪除具有指定鍵的屬性。
getKeys()	String[]	取得所有可用的金鑰。
getProperties()	Object	一次取得所有可用屬性。
getProperty(key)	String|null	傳回與所提供鍵相關聯的值，如果沒有這類值，則傳回 null。
setProperties(properties)	ScriptProperties	大量設定從指定物件繪製的所有屬性。
setProperties(properties, deleteAllOthers)	ScriptProperties	大量設定從指定物件繪製的所有屬性。
setProperty(key, value)	ScriptProperties	使用提供的鍵，保存指定的值。

已淘汰的方法

deleteAllProperties()

已淘汰。這項函式已淘汰，不應在新指令碼中使用。

刪除所有屬性。

ScriptProperties.deleteAllProperties();

回攻員

ScriptProperties：這個物件，用於串連

另請參閱

• deleteProperty(key)

---

deleteProperty(key)

已淘汰。這項函式已淘汰，不應在新指令碼中使用。

刪除具有指定鍵的屬性。

ScriptProperties.deleteProperty('special');

參數

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

回攻員

ScriptProperties：這個物件，用於串連

另請參閱

• deleteAllProperties()

---

getKeys()

已淘汰。這項函式已淘汰，不應在新指令碼中使用。

取得所有可用的金鑰。

回攻員

String[]

---

getProperties()

已淘汰。這項函式已淘汰，不應在新指令碼中使用。

一次取得所有可用資源。

這會提供副本，而非即時檢視畫面，因此變更回傳物件的屬性不會更新儲存空間中的屬性，反之亦然。

ScriptProperties.setProperties({
  "cow"     : "moo",
  "sheep"   : "baa",
  "chicken" : "cluck"
});

// Logs "A cow goes: moo"
Logger.log("A cow goes: %s", ScriptProperties.getProperty("cow"));

// This makes a copy. Any changes that happen here will not
// be written back to properties.
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：包含鍵/值組合的屬性副本

---

getProperty(key)

已淘汰。這項函式已淘汰，不應在新指令碼中使用。

傳回與所提供鍵相關聯的值，如果沒有這類值，則傳回 null。

const specialValue = ScriptProperties.getProperty('special');

參數

名稱	類型	說明
key	String	要擷取的值的鍵

回攻員

String|null：與鍵相關聯的值

另請參閱

• setProperty(key, value)

---

setProperties(properties)

已淘汰。這項函式已淘汰，不應在新指令碼中使用。

從指定物件大量設定所有屬性。

ScriptProperties.setProperties({special: 'sauce', 'meaning': 42});

參數

名稱	類型	說明
properties	Object	包含要設定屬性的物件。

回攻員

ScriptProperties：這個物件，用於串連

另請參閱

• setProperty(key, value)

---

setProperties(properties, deleteAllOthers)

已淘汰。這項函式已淘汰，不應在新指令碼中使用。

從指定物件大量設定所有屬性。

// This deletes all other properties
ScriptProperties.setProperties({special: 'sauce', 'meaning': 42}, true);

參數

名稱	類型	說明
properties	Object	包含要設定屬性的物件。
deleteAllOthers	Boolean	是否要刪除所有現有屬性。

回攻員

ScriptProperties：這個物件，用於串連

另請參閱

• setProperty(key, value)

---

setProperty(key, value)

已淘汰。這項函式已淘汰，不應在新指令碼中使用。

使用提供的鍵保留指定值。與這個鍵相關聯的任何現有值都會遭到覆寫。

ScriptProperties.setProperty('special', 'sauce');

參數

名稱	類型	說明
key	String	房源的鑰匙
value	String	要與鍵建立關聯的值

回攻員

ScriptProperties：這個物件，用於串連

另請參閱

• getProperty(key)