GASのスクリプトエディタ(新IDE)にスクリプトプロパティのGUI設定が復活！
Google Apps Scriptの現行スクリプトエディタでは、スクリプトプロパティがIDE上のGUI操作で設定できなくなっていました。
しかし、GASスクリプトエディタでプロジェクト設定ページからGUIでスクリプトプロパティを設定できる機能が2022年4月13日にリリースされ、順次実装されはじめています。
APIキーなど秘密情報保持にGASのスクリプトプロパティ
Google Apps Script(GAS)では、処理の中で外部サービスとのやり取りが発生することが多いです。
そうした外部サービスとのやり取りのため、APIキーやトークンといった情報をGASで取り扱う必要があります。
GASのコードによってはAPIキーやトークンを直書きしているケースもありますが、これは本来的には望ましくありません。
GitなどでGASコードのバージョン管理する際に、他人に知られてはいけないAPIキーやトークンも表示されてしまうからです。
そこでGASでAPIキーやトークンなどの秘匿しておくべき情報を保持する場所として、スクリプトプロパティが利用されます。
スクリプトプロパティにAPIキーやトークン、パスワードなどの秘密情報を格納することで、処理するスクリプトと秘密情報を分離することができます。
現行GASスクリプトエディタ(IDE)はGUI設定不可能に
元々、Google Apps Scriptのスクリプトエディタ(IDE)では、GUI操作でスクリプトプロパティを設定することができていました。
しかし、2020年12月にGASスクリプトエディタが新しいIDEにアップデートされました。
バージョンアップされたGASのスクリプトエディタは使い勝手がよくなった部分もあるものの、不便になった点もありました。
GAS利用ユーザーから多く挙がったのが、「スクリプトプロパティ」がエディタGUIで設定できなくなったことです。
GASプロジェクトのプロパティ画面からスクリプトプロパティのKey-Valueを設定できたのが、現行スクリプトエディタでは設定画面がなくなってしまいました。
GASのsetPropertyメソッド実行で設定
2020年12月にスクリプトエディタがアップデートされて以降、Google Apps Scriptでスクリプトプロパティを設定する方法は、setpropertyメソッドを使ったやり方になりました。
一時的にスクリプトプロパティを設定する関数を作成し、setPropertyメソッドでKey-Valueを引数に指定して保存する形です。
もうひとつの方法として、現行のスクリプトエディタから「クラシックエディタ(旧IDE)」に戻してスクリプトプロパティを設定する方法もあります。
しかし、いずれの方法も関数を用意したり、スクリプトエディタを切り替えたりして、ひと手間が生じるため面倒です。
GASの現行IDEでスクリプトプロパティがGUI設定できる情報
そんな中、2022年3月にGoogle Apps Script(GAS)の現行スクリプトエディタでも、GUI操作でスクリプトプロパティが設定できるという情報がTwitterに投稿されました。
情報を受けて、多くのGASユーザーが「これで従来版スクリプトエディタに戻して作業しなくて済む」や、「毎回アンケートでスクリプトプロパティの機能を使うと回答した甲斐があった」と喜びの感想をあげていました。
2022年4月13日リリースノートにスクリプトプロパティGUI設定
そんな中、2022年4月13日にGoogle Apps Script(GAS)に関するリリースノートが発表されました。
4月13日のリリースノートには5つの項目が掲載されていますが、2番目の項目が「プロジェクト設定ページからスクリプトプロパティの追加・編集・削除」とあります。
クラシックエディタ切り替え時のGoogleフォームのユーザーアンケートの声を受け、2年ぶりにスクリプトプロパティのGUI設定が復活しました。
2022年4月16日時点では一部のユーザーのみ
2022年4月13日にGoogle Apps Scriptのプロジェクト設定ページからスクリプトプロパティ設定ができるようになったとリリース発表されましたが、現時点では一部のユーザーしか利用することはできません。
私が保有している各GoogleアカウントでGASスクリプトエディタからプロジェクト設定ページを確認したところ、現時点でスクリプトプロパティが設定できたのは１アカウントのみでした。
これまでのリリース同様、恐らく段階的にリリースが進んでいくと見込まれるため、順次使えるようになると推測されます。
現行のGASスクリプトエディタでのスクリプトプロパティ設定方法
実際に現行のGoogle Apps ScriptのスクリプトエディタのGUIから、スクリプトプロパティを設定する方法を解説します。
※すでにスクリプトプロパティGUI設定機能がリリース済みユーザーのみ設定可能です。
１．スクリプトプロパティを設定したいスクリプトプロジェクトを開きます。
２．スクリプトエディタの左メニューにある「プロジェクト設定」アイコンをクリックします。
３．プロジェクト設定ページをスクロールすると、スクリプトプロパティが表示されるので、「スクリプトプロパティを追加」をクリックします。
４．スクリプトプロパティで設定したいプロパティと値を入力し、「スクリプトプロパティを保存」をクリックします。
以上でGASのスクリプトエディタのプロジェクト設定ページ上でのスクリプトプロパティ設定が完了です。
現行のGASスクリプトエディタIDEでは、スクリプトプロパティを設定するコードを記述して実行する必要があったので、大幅に手間を減らすことができます。
設定したスクリプトプロパティをあとから編集したり、削除することもできるようになったのがありがたいです。
(2022年4月27日追記)多くアカウントで利用可能に
4月13日にリリースノートで発表されたスクリプトプロパティ設定は、発表後も利用できる日本ユーザーは少数でした。
しかし、4月下旬になってから利用できるGoogleアカウントが増加しています。
4月27日時点では、私が管理しているほとんどのアカウントで、IDEのプロジェクト設定ページにスクリプトプロパティが表示されるようになっています。
それを受けて、スクリプトプロパティの機能復活したことを紹介するYoutube動画をアップしています。
GASユーザーのコミュニティでも利用できるようになったとの声が挙がっているので、スクリプトプロパティ設定が面倒だった方は、前述した方法で確認してみてください。
まとめ・終わりに
今回、Google Apps Script(GAS)の現行スクリプトエディタ(IDE)にスクリプトプロパティが設定できる機能が実装され始めていることを紹介しました。
2022年4月13日のGASのリリースノートに、IDEのプロジェクト設定ページでスクリプトプロパティの追加・編集・削除ができると発表されました。
4月16日時点ではまだGASスクリプトエディタのプロジェクト設定ページに表示されていないユーザーも多いですが、徐々に使えるようになると考えられます。
2020年12月にGASスクリプトエディタがアップデートされて以降、スクリプトプロパティの設定がGASのsetPropertyメソッドか、クラシックエディタに戻しての対応だったので、設定しやすくなります。
GASの利用環境にスクリプトプロパティ設定が表示されるようになっているか定期的にチェックし、利用できるようになったらぜひ活用ください。