プロパティ サービスを使用すると、1 つのスクリプト、1 人のユーザーのスクリプトのユーザー、1 つのアドオンが使用されている 1 つのドキュメントにスコープが設定された Key-Value ペア形式の単純なデータを保存できます。通常は、デベロッパーの構成やユーザーの設定を保存するために使用されます。プロパティがスクリプト間で共有されることはありません。
プロパティ サービスの 1 日あたりの割り当てとストレージ上限については、Google サービスの割り当てをご覧ください。
不動産店の比較
次の表に示すように、PropertiesService
グローバル オブジェクトにはメソッドが 3 つあります。どのメソッドも同様の Properties
オブジェクトを返しますが、アクセス権は異なります。
スクリプト プロパティ | ユーザー プロパティ | ドキュメント プロパティ | |
---|---|---|---|
アクセス方法 | getScriptProperties() |
getUserProperties() |
getDocumentProperties() |
データの共有相手 | スクリプト、アドオン、またはウェブアプリのすべてのユーザー | スクリプト、アドオン、またはウェブアプリの現在のユーザー | 開いているドキュメント内のアドオンのすべてのユーザー |
一般的な用途 | アプリ全体の構成データ(デベロッパーの外部データベースのユーザー名やパスワードなど) | ユーザー固有の設定(指標やヤードポンド単位など) | ドキュメント固有のデータ(埋め込みグラフのソース URL など) |
データ形式
プロパティ サービスは、すべてのデータを文字列として 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()
を呼び出します。
スクリプト プロパティを手動で管理する
[プロジェクトの設定] ページから、Key-Value ペアの文字列として最大 50 個のカスタム プロパティを手動で追加できます。50 個を超えるプロパティを追加するには、上記のデータの保存で説明した方法で、プログラムで追加する必要があります。プロジェクト設定ページでスクリプト プロパティを設定する場合、スクリプト変数を参照することはできません。
スクリプト プロパティを追加する
- Apps Script プロジェクトを開きます。
- 左側にあるプロジェクト設定アイコン
をクリックします。
- 1 つ目のプロパティを追加するには、[スクリプト プロパティ] で [スクリプト プロパティを追加] をクリックします。
- 2 つ目のプロパティとそれ以降のプロパティを追加するには、[スクリプト プロパティ] で [スクリプト プロパティを編集] > [スクリプト プロパティを追加] をクリックします。
- [プロパティ] にキー名を入力します。
- [値] にキーの値を入力します。
- (省略可)プロパティをさらに追加するには、[スクリプト プロパティを追加] をクリックします。
- [スクリプトのプロパティを保存] をクリックします。
スクリプト プロパティの編集
- Apps Script プロジェクトを開きます。
- 左側にあるプロジェクト設定アイコン
をクリックします。
- [スクリプト プロパティ] で [スクリプトのプロパティを編集] をクリックします。
- 変更する各プロパティのキー名とキー値を変更します。
- [スクリプトのプロパティを保存] をクリックします。
スクリプト プロパティの削除
- Apps Script プロジェクトを開きます。
- 左側にあるプロジェクト設定アイコン
をクリックします。
- [スクリプト プロパティ] で [スクリプトのプロパティを編集] をクリックします。
- 削除するプロパティの横にある [削除] をクリックします。
- [スクリプトのプロパティを保存] をクリックします。