【GAS】スクリプト プロパティの設定方法、取得方法（ハードコーディングを回避）

今回はGAS（Google Apps Script）に関して書いていきます。

以前もGASに関する記事を書いています（以下リンク）。

miya-moto-memo.hatenablog.com

最近GASを触り始めたのですが、上記に載っているプログラムを実装していく過程で「スクリプト プロパティ」というものを知りました。

「APIキー」や「パスワード」など、プログラムにハードコーディングしたくない時があります。
そういった時に、スクリプト プロパティを活用するとセキュリティ面の安全を確保できそうです。
「ハードコーディングよりはマシ」くらいの感じかもしれませんが。

今回の記事では、「スクリプト プロパティ」に関して詳しく書いてみようと思います。

それでは本題へ。

スクリプト プロパティ 設定方法

スクリプト プロパティは本来、隠すべき値を設定するケースが多いと思います。
ただ今回は、スクリプト プロパティを取得した結果も見せたいのでサンプルデータを設定してみます。

設定手順は以下の通りです。

STEP

「プロジェクトの設定」をクリック（歯車マーク）

STEP

ページの下の方にある「スクリプト プロパティを追加」をクリック

STEP

プロパティを設定し、「スクリプト プロパティを保存」をクリック

スクリプト プロパティ 取得方法

function main() {
  // スクリプトプロパティから値を取得
  const SAMPLE_1 = PropertiesService.getScriptProperties().getProperty('SAMPLE_1');
  const SAMPLE_2 = PropertiesService.getScriptProperties().getProperty('SAMPLE_2');
  const SAMPLE_3 = PropertiesService.getScriptProperties().getProperty('SAMPLE_3');
  // ログ出力
  console.log(SAMPLE_1);
  console.log(SAMPLE_2);
  console.log(SAMPLE_3);
}

上記のプログラムを実行すると、以下の画像のようになります。

プログラム実行結果

設定した通りに値が取得できました。

「Properties Service」について

リファレンスをリンクしておきます。

Properties Service
developers.google.com
getScriptProperties
developers.google.com
getProperty
developers.google.com

おわりに

ということで、「GASでスクリプト プロパティの設定方法、取得方法」に関してアレコレ書いてみました。

このブログではプログラムを載せることも多いので、APIキーやパスワードの情報を隠したうえで載せる必要があります。
今のところ隠し忘れはないはずですが、いつ隠し忘れるか気を付けながら記事を書くのもシンドイです。

そういった面でも、スクリプトプロパティは隠し忘れのリスクを解消してくれるので良いなと。
あとは単純に、隠すために画像を加工したりプログラムを手直しする手間がなくなるのも良いなと思いました。

この記事が参考になれば幸いです。

関連記事

GAS（Google Apps Script）に関してはいくつか記事にしています。
気になる記事があればぜひ。

GASの活用事例