Properties Service

屬性

這項服務允許指令碼將字串儲存為鍵/值組合,這個鍵/值組合限定為單一指令碼、一位使用者,或使用編輯器外掛程式的文件。如要進一步瞭解各種屬性的使用時機,請參閱屬性服務指南

類別

名稱簡短說明
Properties屬性物件可做為存取使用者、文件或指令碼屬性的介面。
PropertiesService允許指令碼在鍵/值組合中儲存簡單資料,此鍵/值組合的範圍限定為單一指令碼、一位使用者,或是使用外掛程式的文件。
ScriptProperties指令碼屬性是由永久儲存區中的指令碼所儲存的鍵/值組合。
UserProperties使用者屬性是每位使用者專屬的鍵/值組合。

Properties

方法

方法傳回類型簡短說明
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 儲存庫中的特定鍵/值組合。

PropertiesService

方法

方法傳回類型簡短說明
getDocumentProperties()Properties取得一個屬性存放區 (僅適用於這個指令碼),所有使用者可在開啟文件、試算表或表單中存取。
getScriptProperties()Properties取得一個屬性儲存庫,供所有使用者存取,但僅限於此指令碼內。
getUserProperties()Properties取得僅限目前使用者可存取的屬性儲存庫,而且只能在此指令碼中存取。

ScriptProperties

UserProperties