Google Apps Script(GAS)には、データを小規模に保存できる「プロパティサービス」があります。主にユーザー設定やスクリプトの状態などの情報を保存する際に便利です。
今回は、GASのプロパティサービスについて、3つの種類とその違い、スクリプトプロパティの使い方を中心に解説します。
その他の粋な備忘録も、合わせてご覧ください。 (参考備忘録)GAS:V8ランタイム (参考備忘録)GAS:スクリプト取り込み (参考備忘録)GAS:承認が必要です! (参考備忘録)GAS:トリガー (参考備忘録)GAS:トリガー、Installable Triggers (参考備忘録)GAS:トリガー、ボタン押下での手動実行 (参考備忘録)GAS:トリガー、メニュー選択での手動実行 (参考備忘録)GAS:スクリプトプロパティ |
■ プロパティサービスの3種類
プロパティサービスは以下の3種類に分けられます。
それぞれの役割や適用範囲が異なりますので、用途に合わせて使い分けましょう。
Script Properties:スクリプト全体で共有されるデータを保存
User Properties:各ユーザーごとのデータを保存
Document Properties:特定のドキュメントと関連付けられたデータを保存
■ スクリプトプロパティの設定方法
スクリプトプロパティは、エディタ画面から直接登録または変更でき、スクリプト内で利用可能な設定が管理できます。
(1)左側メニューの歯車アイコン「プロジェクトの設定」を選択します。
(2)プロジェクトの設定画面下(一番最後までスクロールします)のスクリプトプロパティ欄の「スクリプト プロパティを追加」をクリックします。
(すでに「プロパティ」「値」が登録されている場合は、「スクリプト プロパティを編集」と表示されます)
(3)「プロパティ」に属性名、「値」に属性値を入力します。
任意の「プロパティ」「値」を消したい場合は、該当行の最右「×」マークをクリックします。
新たに「プロパティ」「値」の組み合わせを追加したい場合は、「スクリプト プロパティを追加」をクリックします。
「スクリプト プロパティを保存」をクリックすることで、「プロパティ」「値」が登録されます。
■ スクリプトプロパティの使用例(取得と設定)
上記のコードでは、DEBUG_MODEという名前のプロパティを取得、もしくは設定する例を示しています。このように、スクリプト全体に共通の値として設定できます。
■ まとめ
Google Apps Scriptのプロパティサービスは、用途に応じた設定を簡単に行える便利な機能です。スクリプトプロパティは、全体で共通する情報の保存に最適で、設定内容をコード上に直接書かずに管理できます。
Comments