Properties Service

プロパティ

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

クラス

名前	概要
Properties	properties オブジェクトは、ユーザー、ドキュメント、スクリプトのプロパティにアクセスするためのインターフェースとして機能します。
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