Slackに自動通知を送るための「Webhook URL」や、外部サービスと連携するための「APIキー」「アクセストークン」。
こうした大切なシークレット情報、GAS(Google Apps Script)のコードの中に直接ベタ書き(ハードコーディング)していませんか……?
「とりあえず自分しか見ないから大丈夫!」「動けば問題ないよね」と、ついつい var SLACK_URL = "https://hooks.slack.com/services/..." のようにスクリプト内にそのまま書いてしまいがちですよね。
ですが、そのコードをチームの同僚に共有したり、スプレッドシートごと社内の別部署にコピーして使ってもらったり、あるいはGitHubなどにうっかり公開してしまったらどうなるでしょうか?
もし悪意のある第三者にシークレットキーが漏洩してしまうと、社内Slackのプライベートなチャンネルに勝手にメッセージを投稿されたり、高額な従量課金が発生する外部APIを不正利用されたりといった、取り返しのつかない重大なセキュリティ事故に発展してしまいます。
東京出張帰りの新千歳空港で、JR快速エアポートのUシートに揺られながら社内チャットを覗いた瞬間、「APIキーが漏洩してアラートが鳴り止みません!」なんて通知が飛び込んできたら……せっかく空港で買ってきた出来立ての「じゃがポックル」やセコマのフライドチキンを味わう余裕なんて一瞬で消し飛んでしまいますよね(汗)。
そんな大惨事を未然に防ぎ、プロのエンジニアとして安全・堅牢にシステムを運用するために用意されているのが、今回マスターする PropertiesService.getScriptProperties()(プロパティーズ・サービス・ゲット・スクリプト・プロパティーズ)です!
これを使えば、プログラムのコード上からパスワードやURLを完全に消し去り、Googleのクラウド金庫の中に「見えない鍵」として安全に隠して保管することができます。
今回は、札幌オフィスの自動化システムを題材に、スクリプトプロパティの基本概念から、画面(GUI)での登録方法、コードからの一括管理テクニック、そして実務で必須のセキュリティ設計まで、どこよりも分かりやすく徹底解説していきます!
1. そもそも PropertiesService とは?「クラウド上の隠し金庫」の仕組み
まずは、「なぜコードに書いてはいけないのか?」「PropertiesService は裏で何をしているのか?」という根本的な仕組みから解き明かしていきましょう。
「コード」と「設定値」を分離する大切さ
プログラミングの現場には、「プログラムのロジック(動き)」と「認証情報・環境ごとの設定値(秘密情報)」は絶対に分けて管理すべしという世界共通の鉄則があります。
- 危険なコード(ハードコーディング):コードの中に直接パスワードが書かれている状態。家の中に例えるなら、「玄関のドアの正面に、油性マジックで家の暗証番号をデカデカと書いている」ようなものです。誰かに写真(コード)を見せた瞬間に泥棒に入られてしまいます。
- 安全なコード(プロパティ管理):コードの中には「暗証番号は金庫の中に入っているよ」という合図だけを書いておき、実際の番号は別の頑丈な金庫の中にしまっておく状態です。これなら、コードを誰に見せても安心です。
この「頑丈な金庫」の役割を果たしてくれるのが、Google Apps Script標準機能の PropertiesService です!
知っておくべき「3種類のプロパティストア」比較
実は、GASの PropertiesService には、用途に合わせて3つの異なる金庫(プロパティストア)が用意されています。初心者が最も混乱しやすいポイントですので、違いをすっきり整理しておきましょう!
| プロパティの種類 | 取得メソッド | 共有される範囲 | 主な用途・使い分け |
|---|---|---|---|
| スクリプトプロパティ (★今回メイン!) |
getScriptProperties() |
そのプロジェクトを実行する全員で共有される | SlackのWebhook URL、外部APIキー、システム共通の管理者メアド |
| ユーザープロパティ | getUserProperties() |
ログインしているユーザー個別に保存される(他の人には見えない) | ユーザーごとの個人設定、マイページのお気に入り設定、個人の認証トークン |
| ドキュメントプロパティ | getDocumentProperties() |
そのスプレッドシートやドキュメント単体に紐づく | シート固有の管理フラグ、ファイル単位の設定値(※コンテナバインド専用) |
なぜAPI連携やSlack通知では「スクリプトプロパティ」一択なのか?
例えば、札幌オフィスの問い合わせフォームからSlack通知を送るシステムを作ったとします。夜間に自動で動くタイマーや、別のアカウントの同僚がボタンを押したとき、もし「ユーザープロパティ」にURLを入れてしまっていると、「実行した人専用の金庫」を見に行ってしまい、「URLが見つかりません!」とエラーになってしまいます。
「プロジェクト全体で共通して使いたい秘密の鍵」は、迷わず ScriptProperties(スクリプトプロパティ)に預けると覚えておきましょう!
2. スクリプトプロパティの設定方法は「2通り」ある!
スクリプトプロパティに秘密のキーを保存する方法には、大きく分けて以下の2つのアプローチがあります。
- 画面(プロジェクトの設定・GUI)から手動で登録する方法【★一番推奨!】
コードを一切書かずに、GASエディタの専用入力フォームにポチポチと「キー名」と「値」を打ち込んで保存します。コード上にキーの値が1文字も登場しないため、最も安全で事故が起きません。 - プログラム(コード・API)から自動で登録・更新する方法
setProperty('KEY', 'VALUE')という命令を使って、プログラムから値を流し込みます。初期設定を一括で行いたいときや、プログラムの途中で自動取得したトークンを更新したいときに便利です。
本記事では、実務の現場で最もよく使われる「方法1(画面から登録)」をSTEP1で実践し、その後に開発で役立つ「方法2(コードから登録)」も両方マスターしていきます!
3. STEP1:準備!「プロジェクトの設定」画面からシークレットキーを安全に登録しよう
それでは、実際に手元の環境でスクリプトプロパティを登録してみましょう!
今回は、次々回(第96回)で予定している「Slackの #sapporo-dashboard チャネルへの自動通知」を想定し、テスト用のダミーWebhook URLと秘密鍵を金庫に保管します。
登録手順(写真を見るように1ステップずつ進めよう!)
1. GASのエディタ画面を開く
任意のGoogleスプレッドシート(または独立スクリプト)を開き、メニューバーの「拡張機能」>「Apps Script」をクリックしてエディタを開きます。
2. 左メニューの「歯車マーク(プロジェクトの設定)」をクリック
エディタの画面左端にある縦並びアイコンの中から、一番下にある「歯車アイコン(プロジェクトの設定)」をクリックします。
【エディタ左メニュー】 ├── <> エディタ ├── ⏱️ トリガー ├── 📜 実行数 └── ⚙️ プロジェクトの設定 ← ★ここをクリック!
3. 画面最下部までスクロールして「スクリプト プロパティ」を見つける
設定画面が開いたら、ページの一番下までスクロールしてください。
そこに「スクリプト プロパティ」というセクションがあります。
4. 「スクリプト プロパティを追加」をクリックして入力する
「スクリプト プロパティを追加」ボタンを押し、以下の2つのテスト用キーを入力してみましょう!
| プロパティ(キー名) | 値(シークレットキー本体) | 用途・説明 |
|---|---|---|
SLACK_WEBHOOK_URL |
https://hooks.slack.com/services/T00/B00/XxxxxTestSecret123 |
Slack通知用の受取口URL(※テスト用ダミー) |
WEATHER_API_KEY |
sapporo_winter_api_token_99999 |
第94回で使う天気情報APIのシークレットキー |
5. 「スクリプト プロパティを保存」をクリック!
青い「スクリプト プロパティを保存」ボタンを押します。
画面に登録したキー名が一覧表示されれば、Googleのクラウド金庫への保管は完了です!
💡 プロの命名ルール:
スクリプトプロパティの「プロパティ名(キー名)」は、一般的な変数と区別がつくように、すべて半角大文字とアンダースコア(スネークケース:例SLACK_WEBHOOK_URLやAPI_SECRET_KEY)で命名するのが業界の世界共通ルールです!
4. STEP2:【実践】コードからシークレットキーを安全に呼び出そう!
金庫に秘密の鍵をしまえたので、次はプログラム(コード.gs)の中からその鍵を取り出して使うコードを書いていきましょう。
1. コードを入力する
左メニューの「<> エディタ」をクリックしてコード画面に戻り、既存のコードを消して以下のスクリプトを貼り付けます。
/**
* 第93回:PropertiesService.getScriptProperties() の基本動作確認
* 金庫からSlack Webhook URLとAPIキーを安全に呼び出します。
*/
function loadSecretProperties() {
// ① スクリプトプロパティの金庫(Propertiesオブジェクト)を開く
var scriptProperties = PropertiesService.getScriptProperties();
// ② getProperty("キー名") で、保存した値を取り出す!
var slackWebhookUrl = scriptProperties.getProperty("SLACK_WEBHOOK_URL");
var weatherApiKey = scriptProperties.getProperty("WEATHER_API_KEY");
// ③ 正常に取得できたかをチェック(第1回 Logger.log を活用!)
Logger.log("=== シークレット情報の取得テスト ===");
Logger.log("■ Slack Webhook URL : " + maskSecret(slackWebhookUrl));
Logger.log("■ 天気APIシークレット : " + maskSecret(weatherApiKey));
Logger.log("====================================");
// ④ 実務での利用シミュレーション
if (slackWebhookUrl) {
Logger.log("✅ Slack Webhook URLが正常にロードされました。安全に通信可能です!");
// ここで次回以降に学ぶ UrlFetchApp.fetch(slackWebhookUrl, ...) などを実行します
} else {
Logger.log("⚠️ エラー:SLACK_WEBHOOK_URL が設定されていません。プロジェクトの設定を確認してください。");
}
}
/**
* セキュリティ用ヘルパー関数:ログ画面にパスワードが丸見えにならないよう一部を伏字(マスク)にする
*/
function maskSecret(secretValue) {
if (!secretValue) return "【未設定 (null)】";
if (secretValue.length <= 8) return "********";
// 先頭4文字と末尾4文字だけ見せて、中間を「***」で隠す
var head = secretValue.substring(0, 4);
var tail = secretValue.substring(secretValue.length - 4);
return head + "..." + tail + " (伏字化済み)";
}
2. コードの超重要ポイントを1行ずつ解説!
var scriptProperties = PropertiesService.getScriptProperties();
本日の主役です!Googleのサーバーに対して「このプロジェクト専用のスクリプトプロパティ金庫を開けて!」と指示を出しています。var slackWebhookUrl = scriptProperties.getProperty("SLACK_WEBHOOK_URL");
金庫の中から、指定したラベル名(キー)の引き出しを開けて値を取り出します。カッコの中に渡すキー名は、STEP1で設定した文字列と1文字も違わず完全に一致させる必要があります。maskSecret(secretValue)
ここがプロの気配りポイントです! 動作確認のためにLogger.log(slackWebhookUrl)とそのままログに出力してしまうと、エディタの実行ログ画面に秘密のURLが生のまま残ってしまいます。実務ではログ画面から情報が漏洩するのを防ぐため、伏字(マスク処理)を通すのがスマートなエンジニアの作法です。
3. 保存して実行・ログの確認
エディタ上部の「保存(フロッピーアイコン)」を押し、「実行」ボタンをクリックしてみましょう!
(※初回のみ権限承認ポップアップが出ることがありますので、画面の指示に従ってアクセスを許可してください)。
情報 === シークレット情報の取得テスト === 情報 ■ Slack Webhook URL : http...123 (伏字化済み) 情報 ■ 天気APIシークレット : sapp...9999 (伏字化済み) 情報 ==================================== 情報 ✅ Slack Webhook URLが正常にロードされました。安全に通信可能です!
コードの中には怪しいURLやパスワード文字列が1文字も書かれていないのに、プログラムの実行時には金庫から正確に値を取り出して利用できていることが確認できましたね!
5. STEP3:【本格実践】コードからプロパティを一括登録・更新・削除する技
手動で「プロジェクトの設定」画面を開いて入力するのも手軽ですが、複数のキーを一気に登録したいときや、チームメンバーにスクリプトを配布して「初回セットアップ関数を実行するだけで初期設定を終わらせたい」という場面もありますよね。
GASには、コードからプロパティを読み書きするための命令もしっかり用意されています!
よく使うプロパティ操作メソッド一覧表
| メソッド名 | 引数 | 役割・動作 |
|---|---|---|
getProperty(key) |
キー名 (String) | 指定したキーの値を1つ取得する(未登録なら null) |
getProperties() |
なし | 金庫に保存されているすべてのプロパティをオブジェクト(連想配列)で一括取得する |
setProperty(key, value) |
キー名, 値 | キーと値をペアで1件保存する(既存キーなら上書き) |
setProperties(object) |
オブジェクト | 複数のキーと値をまとめて一括保存・更新する |
deleteProperty(key) |
キー名 (String) | 指定したキーのプロパティを1件削除する |
deleteAllProperties() |
なし | 金庫の中身をすべて空っぽに全削除する(※取扱注意!) |
一括登録と全件表示の実践スクリプト
札幌オフィスのシステム環境設定をまとめて登録し、確認するサンプルコードを動かしてみましょう!
/**
* 札幌オフィス システム初期設定:スクリプトプロパティを一括セットアップする関数
* (※キーを初期登録するときに1回だけ実行する関数です)
*/
function setupSapporoSystemProperties() {
var scriptProperties = PropertiesService.getScriptProperties();
// ① 登録したい設定情報を「キー: 値」のオブジェクトとしてまとめる
var initialConfig = {
"OFFICE_NAME": "札幌オフィス(北海道支社)",
"ADMIN_EMAIL": "admin-sapporo@example.com",
"SLACK_CHANNEL": "#sapporo-dashboard",
"DEFAULT_SPICE_LEVEL": "3", // スープカレー辛さ基準値
"API_ENV": "production"
};
// ② setProperties でまとめて一括保存!
// ※第2引数に false を渡すと既存のキーを残したまま追加(trueなら全置換)
scriptProperties.setProperties(initialConfig, false);
Logger.log("🎉 札幌オフィスのシステム設定を一括登録しました!");
// ③ 登録された中身を getProperties() で全件確認してみる
var allProps = scriptProperties.getProperties();
Logger.log("=== 現在保存されているプロパティ一覧 ===");
for (var key in allProps) {
Logger.log("・" + key + " : " + allProps[key]);
}
}
これを実行した後に、再び左メニューの「歯車マーク(プロジェクトの設定)」を覗いてみてください。
コードで指定した OFFICE_NAME や ADMIN_EMAIL が、設定画面のリストに自動で綺麗に追加されているはずです!
6. 実務で差がつく!シークレットキー管理のプロ技3選
基本が理解できたら、実際の現場や企業案件でシニアエンジニアが必ず実践している「3つのプロ技」を押さえておきましょう!
プロ技①:キーが見つからないときに親切に怒る「ガード関数」を作る
設定されていないプロパティを getProperty("UNKNOWN") で読み込もうとすると、エラーにはならず単に null が返ってきます。
その null のまま後続の通信処理に進むと、「原因不明の通信エラー」が発生してデバッグに何時間も溶かすことになります。
実務では、以下のような「キーが取れなかったら即座に分かりやすいエラーを投げて処理を止める専用関数」を用意しておくのがベストプラクティスです!
/**
* 安全にスクリプトプロパティを取得する共通ヘルパー関数
* 万が一設定されていない場合は、親切なエラーメッセージを出して停止する
*/
function getRequiredProperty(keyName) {
var val = PropertiesService.getScriptProperties().getProperty(keyName);
if (!val) {
var errorMsg = "【設定エラー】スクリプトプロパティ「" + keyName + "」が設定されていません。\n" +
"エディタの「プロジェクトの設定」>「スクリプト プロパティ」から値を登録してください。";
Logger.log(errorMsg);
throw new Error(errorMsg); // 処理を安全に中断!
}
return val;
}
// 実際の業務コードでの呼び出し例(超スッキリ!)
function testSendNotification() {
var webhookUrl = getRequiredProperty("SLACK_WEBHOOK_URL");
Logger.log("URL取得成功: 通信処理へ進みます");
}
プロ技②:開発環境と本番環境(DEV / PROD)のURLを切り替える
テスト中は自分の個人Slackチャンネルに通知を飛ばし、本番運用では全社Slackチャンネルに通知したい……という場面はよくありますよね。
スクリプトプロパティに環境フラグを持たせておけば、コードを書き換えずに通知先をサッと切り替えることができます!
function getSlackWebhookUrlByEnv() {
var props = PropertiesService.getScriptProperties();
var env = props.getProperty("ENV") || "DEV"; // デフォルトはDEV
if (env === "PROD") {
return props.getProperty("SLACK_URL_PROD"); // 本番全社チャネル
} else {
return props.getProperty("SLACK_URL_DEV"); // 開発テスト用チャネル
}
}
プロ技③:セットアップ用の使い捨て関数を作ったら必ずコードから削除する
STEP3で紹介した setupSapporoSystemProperties() のように、コードの中に本物のシークレットキーを書いて setProperty() を実行した場合、実行が終わったらそのスクリプトファイル内の平文パスワードは消去するのが絶対のルールです!
値自体はすでにGoogleの金庫(プロパティ)に格納されているため、コード上の文字を消しても金庫の中身は消えません。コードをクリーンに保つ習慣をつけましょう。
7. 初心者が100%つまずく!スクリプトプロパティの5大トラップと完全対処法
PropertiesService を扱う際、開発者が非常によく直面する「5大落とし穴」をまとめました。困ったときはまずここを確認してください!
トラップ1:プロパティ名のタイポ(大文字小文字・不要なスペース)で null になる
設定画面で SLACK_WEBHOOK_URL と登録したのに、コード側で getProperty("SLACK_WEBHOOK_url")(末尾が小文字)と書いていたり、コピペした際に末尾に「半角スペース」が混ざっていると、GASは「そんなキーは存在しない」と判断して null を返します。
【対策】 キー名は設定画面の文字列をそのままコピーしてコードへ貼り付けましょう!
トラップ2:保存した値は「すべて文字列(String)」として扱われる!
プロパティに数値(例:"100")や真偽値(例:"true")を保存した場合、取り出したときのデータ型は必ず「文字列(String)」になります!
// ✕ 初心者がやりがちな比較ミス
var isDebug = scriptProperties.getProperty("IS_DEBUG"); // "true" という文字列が返る
if (isDebug === true) {
// 文字列 "true" と 真偽値 true を厳密比較しているので一致しない!
}
// ◯ 正しい書き方(文字列として比較するか、型変換する)
if (isDebug === "true") { ... }
var count = Number(scriptProperties.getProperty("MAX_COUNT")); // 数値に変換!
トラップ3:スプレッドシートを「コピーして新規作成」するとプロパティは引き継がれない!
社内で「この自動化スプレッドシート便利だから、複製して別の部署でも使おう!」と、ドライブ上でスプレッドシートをコピー作成することがありますよね。
このとき、コピーされた新しいスプレッドシートのプロジェクトには、元のスクリプトプロパティは引き継がれず、中身が空っぽ(リセット)になるというGoogleの仕様があります!
【対策】 シートをコピーして新しい環境で動かすときは、必ず新プロジェクト側でも「プロジェクトの設定」からスクリプトプロパティを再設定する必要があることを覚えておきましょう。
トラップ4:容量制限(クォーテーション上限)の存在
スクリプトプロパティは非常に便利ですが、大量のデータ(長文のJSONや何万行ものテキスト)を保存するデータベース代わりには使えません。
- プロパティのプロパティ値の最大サイズ:1つの値につき 9KB まで
- プロパティの総数・全体の最大容量:プロジェクト全体で 500KB まで
あくまで「トークン」「URL」「設定パラメータ」などの短いシークレット情報を保存する場所として利用しましょう。
トラップ5:エディタから直接「実行」を押しても、設定画面の値は勝手に入らない
「コードに getProperty() って書いたのに値が取れない……」と悩む初心者の方がいますが、PropertiesService.getScriptProperties().getProperty("KEY") は「すでに金庫に入っているものを取る命令」であって、自動で値を生成してくれる魔法ではありません。
必ずコードを動かす前に、本記事のSTEP1に従って「プロジェクトの設定」から値を登録しておいてくださいね!
8. まとめ&次回予告
今回は、Slack連携や外部API通信を行う上で絶対に欠かせないシークレットキーの秘匿管理術 PropertiesService.getScriptProperties() について徹底解説しました!
本日の重要ポイントおさらい
- シークレットキーやURLはコードに直接書かず、PropertiesService の金庫に隠すのが鉄則!
- プロジェクトを実行する全員で共通利用する情報は
getScriptProperties()を使う。 - キーの登録は、コードを汚さないエディタの「プロジェクトの設定(歯車マーク)」から行うのが一番安全。
- 取り出したプロパティ値はすべて「文字列型」になるため、数値や真偽値の比較に注意する。
- ログ出力する際はパスワードが丸見えにならないよう、伏字(マスク)処理を挟むのがプロの作法!
パスワードや秘密の鍵をコードから綺麗に追い出し、安全な金庫に格納できたことで、これでどんな外部Web APIとも安心して繋ぎ込める準備が完全に整いましたね!
エンジニアとして胸を張って本番運用できる、一段上のセキュリティレベルへ到達しました。
さて、秘密のAPIキーを安全に呼び出せるようになったら、次にやりたくなるのは「外部のWebサービスからリアルタイムな最新データをインターネット経由で取ってくること」ですよね!
次回(第94回)のテーマは、
「UrlFetchApp.fetch() (GET) × 外部APIから『現在の札幌の天気・交通情報』を取得してダッシュボードに表示」 です!
今回金庫に隠した WEATHER_API_KEY を活用して、気象庁やOpenWeatherMapなどの外部APIへGASから実際にアクセスし、現在のリアルタイムな気温や天候データを取得してダッシュボードに組み込む実践テクニックを学びます。
いよいよ外部Webサービスとの本格連携が幕を開けますので、ぜひ次回も楽しみに待っていてくださいね!
