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