Properties Service

プロパティ

このサービスを使用すると、スクリプトは、1 つのスクリプト、1 つのスクリプトのユーザー、またはエディタ アドオンが使用されている 1 つのドキュメントにスコープされた Key-Value ペアとして文字列を保存できます。各タイプのプロパティを使用するタイミングの詳細については、Properties サービスのガイドをご覧ください。

クラス

名前概要
Propertiesproperties オブジェクトは、ユーザー、ドキュメント、スクリプトのプロパティにアクセスするためのインターフェースとして機能します。
PropertiesServiceスクリプトでは、1 つのスクリプト、1 人のスクリプト ユーザー、またはアドオンが使用されている 1 つのドキュメントにスコープされた Key-Value ペア形式のシンプルなデータを保存できます。
ScriptPropertiesスクリプト プロパティは、スクリプトによって永続ストアに保存される Key-Value ペアです。
UserPropertiesユーザー プロパティは、ユーザーに固有の Key-Value ペアです。

Properties

メソッド

メソッド戻り値の型概要
deleteAllProperties()Properties現在の Properties ストア内のすべてのプロパティを削除します。
deleteProperty(key)Properties現在の Properties ストアで、指定されたキーを持つプロパティを削除します。
getKeys()String[]現在の Properties ストア内のすべてのキーを取得します。
getProperties()Object現在の Properties ストア内のすべての Key-Value ペアのコピーを取得します。
getProperty(key)String現在の Properties ストアで指定されたキーに関連付けられている値を取得します。そのようなキーが存在しない場合は null を返します。
setProperties(properties)Properties指定したオブジェクトのすべての Key-Value ペアを現在の Properties ストアに設定します。
setProperties(properties, deleteAllOthers)Properties指定されたオブジェクトのすべての Key-Value ペアを現在の Properties ストアに設定します。必要に応じて、ストア内の他のすべてのプロパティを削除します。
setProperty(key, value)Properties現在の Properties ストアに指定された Key-Value ペアを設定します。

PropertiesService

メソッド

メソッド戻り値の型概要
getDocumentProperties()Properties開いているドキュメント、スプレッドシート、フォーム内ですべてのユーザーがアクセスできるプロパティ ストア（このスクリプトのみ）を取得します。
getScriptProperties()Propertiesすべてのユーザーがアクセスできるプロパティ ストアを取得します（ただし、このスクリプト内のみ）。
getUserProperties()Properties現在のユーザーのみが、このスクリプト内からアクセスできるプロパティ ストアを取得します。

ScriptProperties

UserProperties