このサービスを使用すると、スクリプトは 1 つのスクリプト、1 つのスクリプトの 1 人のユーザー、エディタ アドオンが使用されている 1 つのドキュメントをスコープとする Key-Value ペアとして文字列を保存できます。各タイプのプロパティをどのような場合に使用するかについて詳しくは、プロパティ サービスのガイドをご覧ください。
クラス
名前 | 概要 |
---|---|
Properties | プロパティ オブジェクトは、ユーザー、ドキュメント、スクリプトのプロパティにアクセスするためのインターフェースとして機能します。 |
PropertiesService | 1 つのスクリプト、1 つのスクリプトの 1 人のユーザー、アドオンが使用されている 1 つのドキュメントをスコープとする Key-Value ペアで、シンプルなデータを保存できます。 |
| スクリプト プロパティは、スクリプトによって永続ストアに保存される Key-Value ペアです。 |
| ユーザー プロパティは、ユーザーに固有の 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 | 現在のユーザーのみがこのスクリプト内でのみアクセスできるプロパティ ストアを取得します。 |