Google Apps Script

GAS(Google Apps Script)のスクリプト プロパティの使い方

スポンサーリンク

概要

GAS(Google Apps Script)では、キー・バリュー形式で設定ができる「スクリプト プロパティ」が用意されています。

主に、IDやAPIトークンなど、ソースコード上にベタ書きをしたくない値を設定するのに使用することができます。

「スクリプト プロパティ」を開く

  1. 左側のメニューにある、歯車のアイコンの「プロジェクトの設定」をクリックします。
  1. 「プロジェクトの設定」画面の一番下に「スクリプト プロパティ」があります。

プロパティの追加

  1. 「スクリプト プロパティを追加」ボタンをクリックします。
  1. 「プロパティ」にキーを、「値」にキーに紐ずく値を設定し、「スクリプト プロパティを保存」ボタンをクリックします。

ソースコード

スクリプト プロパティの取得

指定したプロパティの値を取得する場合

以下では”SAMPLE”というプロパティの値を取得します。

const data = PropertiesService.getScriptProperties().getProperty("SAMPLE");

指定したプロパティの値を全て取得する場合

以下では、プロパティの全ての値を取得してログに出力をします。

const datas = PropertiesService.getScriptProperties().getProperties();
for (var key in datas) {
  Logger.log(`プロパティ: ${key}, 値: ${datas[key]}`);
}

スクリプト プロパティの設定

プロパティを1つ設定する場合

以下では”SAMPLE”というプロパティで、”サンプル”という値を設定します。

PropertiesService.getScriptProperties().setProperty("SAMPLE", "サンプル");

一度に複数のプロパティを設定する場合

配列で設定をしたいプロパティと値を設定します。

PropertiesService.getScriptProperties().setProperties({
  "SAMPLE": "サンプル",
  "TEST": "テスト"
});

スクリプト プロパティの削除

指定したプロパティを1つ削除する場合

以下では”SAMPLE”というプロパティを削除します

PropertiesService.getScriptProperties().deleteProperty("SAMPLE");

全てのプロパティを削除する場合

PropertiesService.getScriptProperties().deleteAllProperties();
タイトルとURLをコピーしました