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