Properties Service

プロパティ

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

クラス

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