Properties Service

プロパティ

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

クラス

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

Properties

Methods

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

PropertiesService

Methods

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

ScriptProperties

UserProperties