Properties サービスを使用すると、1 つのスクリプト、スクリプトの 1 人のユーザー、またはアドオンが使用されている 1 つのドキュメントにスコープされた Key-Value ペア形式のシンプルなデータを保存できます。通常、デベロッパー設定やユーザー設定の保存に使用されます。プロパティがスクリプト間で共有されることはありません。
Properties サービスの 1 日あたりの割り当てとストレージの上限については、Google サービスの割り当てをご覧ください。
プロパティ ストアの比較
PropertiesService
グローバル オブジェクトには 3 つのメソッドが用意されています。これらのメソッドは、次の表に示すように、同様の Properties
オブジェクトを返しますが、アクセス権が異なります。
スクリプト プロパティ | ユーザー プロパティ | ドキュメント プロパティ | |
---|---|---|---|
アクセス方法 | getScriptProperties() |
getUserProperties() |
getDocumentProperties() |
共有されるデータ | スクリプト、アドオン、ウェブアプリのすべてのユーザー | スクリプト、アドオン、ウェブアプリの現在のユーザー | 開いているドキュメント内のアドオンのすべてのユーザー |
通常は | デベロッパーの外部データベースのユーザー名やパスワードなどのアプリ全体の構成データ | ユーザー固有の設定(メートル法またはヤードポンド法など) | ドキュメント固有のデータ(埋め込みグラフのソース URL など) |
データ形式
Properties サービスは、すべてのデータを Key-Value ペアの文字列として保存します。文字列以外のデータ型は、保存されたオブジェクトに含まれるメソッドを含め、自動的に文字列に変換されます。
データの保存
単一の値を保存するには、次の例に示すように、適切なストアのメソッド Properties.setProperty(key,
value)
を呼び出します。
データを一括で保存するには、Key-Value ペアのマップを Properties.setProperties(properties)
に渡します。パラメータ内のオブジェクトの各 Key-Value ペアは、個別のプロパティとして保存されます。
データの読み取り
以前に保存した単一の値を取得するには、Properties.getProperty(key)
を呼び出します。
現在のプロパティ ストア内のすべての値を取得するには、Properties.getProperties()
を呼び出します。
データの修正
getProperty()
メソッドと getProperties()
メソッドは、ライブビューではなく、保存されたデータのコピーを返します。そのため、返されたオブジェクトを変更しても、プロパティ ストアの値は更新されません。ストア内のデータを更新するには、もう一度保存します。
データを削除する
単一の値を削除するには、Properties.deleteProperty(key)
を呼び出します。
現在のストア内のすべてのプロパティを削除するには、Properties.deleteAllProperties()
を呼び出します。
スクリプト プロパティを手動で管理する
プロジェクト設定ページから、最大 50 個のカスタム プロパティを Key-Value ペアの文字列として手動で追加できます。50 を超えるプロパティを追加するには、データの保存で説明したメソッドを使用して、プログラムで追加する必要があります。プロジェクト設定ページからスクリプト プロパティを設定する場合、スクリプト変数への参照はできません。
スクリプト プロパティを追加する
- Apps Script プロジェクトを開きます。
- 左側の [プロジェクト設定]
をクリックします。
- 最初のプロパティを追加するには、[スクリプト プロパティ] で [スクリプト プロパティを追加] をクリックします。
- 2 つ目以降のプロパティを追加するには、[スクリプト プロパティ] で [スクリプト プロパティを編集] > [スクリプト プロパティを追加] をクリックします。
- [プロパティ] に鍵名を入力します。
- [値] に、キーの値を入力します。
- (省略可)プロパティを追加するには、[スクリプト プロパティを追加] をクリックします。
- [スクリプト プロパティを保存] をクリックします。
スクリプト プロパティを編集する
- Apps Script プロジェクトを開きます。
- 左側の [プロジェクト設定]
をクリックします。
- [スクリプト プロパティ] で、[スクリプト プロパティを編集] をクリックします。
- 変更するプロパティごとに、キー名とキー値を変更します。
- [スクリプト プロパティを保存] をクリックします。
スクリプト プロパティを削除する
- Apps Script プロジェクトを開きます。
- 左側の [プロジェクト設定]
をクリックします。
- [スクリプト プロパティ] で、[スクリプト プロパティを編集] をクリックします。
- 削除するプロパティの横にある削除アイコン をクリックします。
- [スクリプト プロパティを保存] をクリックします。