プロパティ サービスでは、1 つのスクリプト、1 つのスクリプトのユーザー、アドオンを使用する 1 つのドキュメントにスコープ設定し、Key-Value ペアにシンプルなデータを保存できます。通常は、デベロッパーの構成やユーザー設定を保存するために使用されます。プロパティがスクリプト間で共有されることはありません。
プロパティ サービスの 1 日の割り当てと保存容量の上限を確認するには、Google サービスの割り当てをご覧ください。
不動産店舗の比較
PropertiesService
グローバル オブジェクトには 3 つのメソッドがあり、それぞれが同様の Properties
オブジェクトを返しますが、アクセス権が異なります。次の表をご覧ください。
スクリプト プロパティ | ユーザー プロパティ | ドキュメント プロパティ | |
---|---|---|---|
アクセス方法 | getScriptProperties() |
getUserProperties() |
getDocumentProperties() |
データの共有先 | スクリプト、アドオン、ウェブアプリのすべてのユーザー | スクリプト、アドオン、またはウェブアプリの現在のユーザー | 開いているドキュメント内のアドオンのすべてのユーザー |
主な用途 | アプリ全体の構成データ(デベロッパーの外部データベースのユーザー名とパスワードなど) | メートル単位やヤードポンド単位など、ユーザー固有の設定 | ドキュメント固有のデータ(埋め込みグラフのソース URL など) |
データ形式
プロパティ サービスは、すべてのデータを Key-Value ペアの文字列として格納します。まだ文字列ではないデータ型は、保存されたオブジェクト内に含まれるメソッドなど、自動的に文字列に変換されます。
データの保存
値を 1 つ保存するには、次の例に示すように、適切なストアの 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 プロジェクトを開きます。
- 左側にある [プロジェクトの設定] をクリックします。
- 最初のプロパティを追加するには、[Script Properties] で [Add script property] をクリックします。
- 2 番目以降のプロパティを追加するには、[スクリプトのプロパティ] で [スクリプトのプロパティを編集] > [スクリプトのプロパティを追加] をクリックします。
- [プロパティ] にキー名を入力します。
- [値] にキーの値を入力します。
- (省略可)プロパティを追加するには、[スクリプト プロパティを追加] をクリックします。
- [スクリプトのプロパティを保存する] をクリックします。
スクリプトのプロパティを編集
- Apps Script プロジェクトを開きます。
- 左側にある [プロジェクトの設定] をクリックします。
- [スクリプトのプロパティ] で、[スクリプトのプロパティを編集] をクリックします。
- 変更する各プロパティのキー名と値に変更を加えます。
- [スクリプトのプロパティを保存する] をクリックします。
スクリプトのプロパティを削除する
- Apps Script プロジェクトを開きます。
- 左側にある [プロジェクトの設定] をクリックします。
- [スクリプトのプロパティ] で、[スクリプトのプロパティを編集] をクリックします。
- 削除するプロパティの横にある削除アイコン をクリックします。
- [スクリプトのプロパティを保存する] をクリックします。