【初心者向けGAS】プロパティストアの概要とスクリプトプロパティの入力方法

photo credit: AdamCohn Red Chili Shop, Bucaramanga Colombia via photopin (license)

みなさん、こんにちは！
タカハシ(@ntakahashi0505)です。

初心者向けGoogle Apps Script入門として名言Botの作り方をお伝えしています。

前回の記事はコチラ。

【初心者向けGAS】時限式のイベントトリガーを設置して決まった時刻にBotを送信する方法

初心者向けGoogle Apps Scriptのシリーズとして、名言Botの作成の方法をお伝えしています。今回は、時限式のイベントトリガーを設置して決まった時刻にChatworkにBot送信する方法です。

インストーラブルトリガーを使って一定時間ごとにスクリプトを実行する方法についてお伝えしました。

さて、Botとしては完成と言っても良いのです。

ただ、APIトークン…コード内にベタ打ちしたくないですもん。

GASには、そういう取り扱い注意なやつを、いい感じに管理するプロパティストアという機能があるんです。

今回は、Google Apps Scriptのプロパティストアとは何か、またスクリプトプロパティの入力の方法についてお伝えします。

では、行ってみましょう！

プロパティストアとプロパティサービス
スクリプトプロパティにデータを格納する
まとめ
連載目次：超初心者向けGASでBotを作りながら基礎を学ぶ

プロパティストアとプロパティサービス

プロパティストアとは

GASではプロジェクトやドキュメントに紐付いてデータを格納しておくコードとは別の領域が用意されていて、それをプロパティストアといいます。

プロパティストアには、キーの役割を果たす「プロパティ」と「値」のペアを文字列形式で格納することができます。

ちょっとGASとかJavaScriptに詳しい方なら、オブジェクトと同じような形式だと気づくでしょう。

プロパティストアに格納するデータの例

で、どんなデータを格納すると良いかというと、例えば、現在連載中の名言BotのスクリプトでいうとAPIトークン。

記事内には「ここにAPIトークンを入力してください」ってしていたんですけど、全世界に晒すわけにはいかない、とっても厳重注意のやつですもん。

ブログ書いてなくても、うっかりコピペして晒してしまったりとかあるかも知れませんよね。

ってことは、コード内にベタで書きたくないわけです。

APIトークン以外にも、あとは

スクリプト内で使用するスプレッドシートやファイルのID
Gmailでメールを送信するメールアドレス
外部のデータベースに接続するための情報

といった情報も同様にベタ書きしたくないです。

こういったデータをコードではない管理しやすいところに保管することができる、その場所がプロパティストアというわけです。

プロパティストアの種類

プロパティストアには３つの種類があります。

以下表にまとめました。扱うデータの性質や用途によって、どれを使うかセレクトをします。

プロパティストア	場所
スクリプトプロパティ	プロジェクト
ユーザープロパティ	プロジェクト×ユーザー
ドキュメントプロパティ	ドキュメント

いずれの場合も、後述する方法でGASのスクリプトから操作をします。

プロパティサービスとは

そして、そのプロパティストアのデータをGASから操作することができ、それがプロパティサービスです。

プロパティストアに登録してあるデータをプロパティをキーにして取得してきたり、またはデータの入力や編集をしたりといったことが可能です。

スクリプトプロパティにデータを格納する

プロパティストアにはいくつか種類がありますが、今回はプロジェクトにひもづく形でデータを保管できるスクリプトプロパティについてお伝えします。

練習として、Chatwork APIのトークンをスクリプトプロパティとして格納してみましょう。

スクリプトプロパティに格納するには、以下のようなコードを実行します。

function setScriptProperty() {
  PropertiesService.getScriptProperties().setProperty('CW_TOKEN', 'ここにAPIトークンを入力してください');
}

実行すると、特に何も起きずに実行完了するように見えますが、ちゃんとスクリプトプロパティにAPIトークンがデータとして格納されているので安心してください。

プロパティストアとPropertiesServiceオブジェクト

では、解説していきましょう。

これまでお伝えしてきたスプレッドシートを操作する機能は、Spreadsheetサービスでしたね。

GASではプロパティストアを扱うために、Propertiesサービスという機能が提供されています。

その機能を使って、スクリプトプロパティのデータを格納したり、取り出したりすることができるのです。

それで、Propertiesサービスを使用する場合には、まずPropertiesServiceオブジェクトからアクセスをすることになります。

これがPropertiesサービスの最も上位にあるオブジェクトで、トップレベルの親分的なオブジェクトです。

スプレッドシートでいうと、SpreadsheetAppがそれに当たります。

スクリプトプロパティをPropertiesオブジェクトとして取得

プロパティストアはPropertiesオブジェクトとして取得することで操作ができます。

前述のとおり、プロパティストアにはいくつかの種類がありますので、その種類ごとにメソッドが異なります。

スクリプトプロパティを操作するためのPropertiesオブジェクトを取得するには、getScriptPropertiesメソッドを使います。

PropertiesService.getScriptProperties()

スクリプトプロパティにキーを指定して値を格納する

これで、スクリプトプロパティをPropertiesオブジェクトとして操作ができるようになりましたので、そこにデータを格納します。

そのためのメソッドがsetPropertyメソッドです。

書式はコチラです。

Propertiesオブジェクト.setProperty(キー, 値)

今回の例では、キーは「CW_TOKEN」という文字列ですね。

そのキーに対となる値として、Chatwork APIのトークンを格納したというわけです。

そして、それはプロジェクトに紐づくスクリプトプロパティに削除するまでは半永久的に保存されますので、必要なときに取り出せばよいのです。

まとめ

以上、Google Apps Scriptのプロパティストアの概要とスクリプトプロパティの入力方法についてお伝えしました。

コード内に書くべきではない情報があるよということと、GASではそれらを格納するためにプロパティストアという機能が提供されているよということを確認していただければと思います。

次回、今回格納をしたスクリプトプロパティをGASのスクリプトから取得する方法についてお伝えします。

【初心者向けGAS】スクリプトプロパティを操作してそのデータを取り出す方法

初心者向けのシリーズとしてGoogle Apps Scriptで名言Botの作り方を解説しております。今回は、GASでPropertiesサービスを使ってスクリプトプロパティからデータを取り出す方法です。

どうぞお楽しみに！

連載目次：超初心者向けGASでBotを作りながら基礎を学ぶ

Google Apps Script（GAS）をはじめるためのメリットは山程ありますが、何を作ったらいいの？と悩んでしまうこともありますよね。そんな時に、おすすめしたいのが「Bot」の作成です。このシリーズでは、超初心者向けにGASでBotを作る方法を題材としながら、GASプログラミングの一通りの流れと書き方について学んでいきます。