外部サービスと連携するGASを書くと、必ずAPIキーやWebhook URLを扱うことになります。多くの解説記事では、こう書かれています。
const API_KEY = 'sk-abcdef123456...'; // ここにキーを入れる
動作の説明としては分かりやすい書き方ですが、そのまま運用に乗せると問題が起きます。この記事では、設定値をコードから切り離して管理する方法を解説します。
コードに直書きするとどうなるか
共有すると相手に見える
スクリプトを他の人と共有した時点で、キーもそのまま渡ります。閲覧権限だけを渡したつもりでも、コードが読めればキーは読めます。
コピーが広がる
スプレッドシートを複製すれば、コンテナバインドのスクリプトも複製されます。キーの入ったファイルが、意図しない場所に増えていきます。
変更のたびにコードを直すことになる
通知先のチャンネルを変えるだけでコードの修正とデプロイが必要になり、修正ミスの機会が増えます。
環境ごとに使い分けられない
テスト用と本番用でキーを切り替えたい場合、コードを書き換えるしかなくなります。
PropertiesService の3種類
GASには、設定値を保存する仕組みが標準で用意されています。
| 種類 | 保存範囲 | 主な用途 |
|---|---|---|
| スクリプトプロパティ | スクリプト全体(利用者共通) | APIキー、通知先、設定値 |
| ユーザープロパティ | 実行したユーザーごと | 個人の設定、個人のトークン |
| ドキュメントプロパティ | 紐づいたファイルごと | そのシート固有の設定 |
APIキーの管理にはスクリプトプロパティを使います。
画面から登録する
- スクリプトエディタを開く
- 左側の歯車アイコン「プロジェクトの設定」をクリック
- 下部の「スクリプト プロパティ」→「スクリプト プロパティを追加」
- プロパティ名と値を入力して保存
例として、次のように登録します。
| プロパティ | 値 |
|---|---|
| SLACK_WEBHOOK_URL | https://hooks.slack.com/services/... |
| NOTIFY_MAIL | admin@example.com |
| SHEET_ID | 1AbCdEf... |
| MAX_ROWS | 5000 |
コードから取得する
function getConfig(key) { const value = PropertiesService.getScriptProperties().getProperty(key); if (value === null) { throw new Error('設定値「' + key + '」が登録されていません。' + 'プロジェクトの設定から登録してください。'); } return value; }
function notifySlack(message) { const url = getConfig('SLACK_WEBHOOK_URL'); UrlFetchApp.fetch(url, { method: 'post', contentType: 'application/json', payload: JSON.stringify({ text: message }) }); }
未登録のときに明確なエラーを出すのが重要です。 getProperty は値が無いと null を返すため、そのまま使うと「なぜか動かない」状態になります。上のように専用の取得関数を用意しておけば、原因がすぐ分かります。
まとめて取得する
設定値が多い場合は、一度に読み込むほうが効率的です。
function getAllConfig() { const props = PropertiesService.getScriptProperties().getProperties(); return { webhookUrl: props.SLACK_WEBHOOK_URL, notifyMail: props.NOTIFY_MAIL, sheetId: props.SHEET_ID, maxRows: Number(props.MAX_ROWS || 1000) }; }
値は必ず文字列として保存されます。 数値として使う場合は Number() で変換が必要です。真偽値も同様で、'false' という文字列は条件判定では true として扱われるため注意してください。
// 誤り: 'false' という文字列は true と判定される if (props.ENABLE_MAIL) { ... } // 正しい if (String(props.ENABLE_MAIL).toLowerCase() === 'true') { ... }
コードから登録・更新する
初期設定用の関数を用意しておくと、環境を作り直すときに便利です。
// 初期設定用(1回だけ手動で実行する) function setupProperties() { PropertiesService.getScriptProperties().setProperties({ 'NOTIFY_MAIL': 'admin@example.com', 'MAX_ROWS': '5000', 'ENABLE_MAIL': 'true' }); console.log('設定を登録しました'); }
// 1件だけ更新する function updateOne() { PropertiesService.getScriptProperties() .setProperty('MAX_ROWS', '10000'); } // 削除する function deleteOne() { PropertiesService.getScriptProperties() .deleteProperty('OLD_SETTING'); } // 現在の設定を確認する(キーだけ表示) function listKeys() { const keys = PropertiesService.getScriptProperties().getKeys(); console.log('登録済みのキー: ' + keys.join(', ')); }
APIキーの設定関数をコードに残さないでください。 setupProperties にキーを直書きすると、直書きを避けた意味がなくなります。キーは画面から手で登録し、コードには「キーがここに入る」という前提だけを書きます。
実行状態の記録にも使える
設定値だけでなく、処理の状態を保存する用途にも使えます。
// 最後に処理した日時を記録する function saveLastRun() { PropertiesService.getScriptProperties() .setProperty('LAST_RUN', new Date().toISOString()); } // 前回からの差分だけを処理する function processIncremental() { const props = PropertiesService.getScriptProperties(); const lastRun = props.getProperty('LAST_RUN'); const since = lastRun ? new Date(lastRun) : new Date(0); console.log(since + ' 以降のデータを処理します'); // --- 処理 --- props.setProperty('LAST_RUN', new Date().toISOString()); }
分割実行の進捗管理にも使えます。
function processInBatches() { const props = PropertiesService.getScriptProperties(); const startRow = Number(props.getProperty('NEXT_ROW') || 2); const BATCH = 500; const sheet = SpreadsheetApp.getActiveSheet(); const lastRow = sheet.getLastRow(); if (startRow > lastRow) { props.deleteProperty('NEXT_ROW'); console.log('全件処理が完了しました'); return; } const endRow = Math.min(startRow + BATCH - 1, lastRow); const values = sheet.getRange(startRow, 1, endRow - startRow + 1, 5).getValues(); // --- 処理 --- props.setProperty('NEXT_ROW', String(endRow + 1)); console.log(startRow + '〜' + endRow + ' 行目を処理しました'); }
6分の実行時間制限を超える処理を、トリガーで少しずつ進める際の定石です。
ユーザープロパティとの使い分け
複数人が使うWebアプリでは、利用者ごとに値を保存したい場面があります。
// 実行したユーザーごとに保存される function saveUserSetting(dept) { PropertiesService.getUserProperties() .setProperty('MY_DEPARTMENT', dept); } function getUserSetting() { return PropertiesService.getUserProperties() .getProperty('MY_DEPARTMENT') || '未設定'; }
| スクリプトプロパティ | ユーザープロパティ | |
|---|---|---|
| 保存先 | スクリプト単位 | 実行ユーザー単位 |
| 他の人から見えるか | 編集権限があれば見える | 他のユーザーからは見えない |
| 用途 | 共通のAPIキー、通知先 | 個人の設定、個人のトークン |
Webアプリの公開設定が「自分として実行」の場合、誰がアクセスしても実行者は自分になるため、ユーザープロパティは全員で同じものを共有します。個人ごとに分けたい場合は「アクセスしているユーザーとして実行」にする必要があります。
CacheService との違い
一時的なデータを保存する CacheService もありますが、用途が異なります。
| PropertiesService | CacheService | |
|---|---|---|
| 保存期間 | 消すまで永続 | 最大6時間 |
| 速度 | 標準 | 高速 |
| 容量 | 1プロパティ9KB、合計500KB | 1項目100KB |
| 用途 | 設定値、状態の記録 | 一時データ、重複処理の抑制 |
設定値はPropertiesService、一時的なキャッシュはCacheServiceという使い分けになります。
注意点
完全な秘匿ではない
スクリプトプロパティは、スクリプトの編集権限を持つ人なら誰でも見られます。 コードに直書きするよりは安全ですが、「編集権限のある人には見える」という前提は変わりません。
本当に秘匿性の高いキーを扱う場合は、共有範囲そのものを絞ってください。閲覧者に編集権限を与えない、スクリプトを別プロジェクトに分離する、といった対応が必要です。
容量の上限がある
1つのプロパティは9KBまで、合計500KBまでです。大きなデータの保管場所としては使えません。JSON文字列を保存する場合も、この上限を意識します。
// オブジェクトを保存する場合はJSON文字列にする function saveObject() { const config = { mode: 'production', retry: 3, targets: ['A', 'B'] }; PropertiesService.getScriptProperties() .setProperty('CONFIG_JSON', JSON.stringify(config)); } function loadObject() { const json = PropertiesService.getScriptProperties().getProperty('CONFIG_JSON'); return json ? JSON.parse(json) : {}; }
プロジェクトを複製すると引き継がれない
スクリプトをコピーしても、プロパティの内容はコピーされません。新しい環境では登録し直しが必要です。 何を登録すべきかをREADMEやシートに書き残しておかないと、移行時に詰まります。
// 必要な設定が揃っているか確認する関数を用意しておく function checkConfig() { const required = ['SLACK_WEBHOOK_URL', 'NOTIFY_MAIL', 'SHEET_ID']; const props = PropertiesService.getScriptProperties().getProperties(); const missing = required.filter(function (k) { return !props[k]; }); if (missing.length > 0) { throw new Error('未設定の項目があります: ' + missing.join(', ')); } console.log('設定はすべて登録されています'); }
ログに出力しない
デバッグ中でも、キーそのものを console.log に出さないでください。実行ログは一定期間残り、スクリプトにアクセスできる人が閲覧できます。
// 悪い例 console.log('APIキー: ' + apiKey); // 確認するなら伏せ字にする console.log('APIキー: ' + apiKey.slice(0, 4) + '****(' + apiKey.length + '文字)');
まとめ
- APIキーや通知先はコードに直書きせず、スクリプトプロパティに登録する
- 取得用の関数を1つ作り、未登録なら明確なエラーを出す
- 値は必ず文字列。数値や真偽値は変換して使う
- 実行状態(最終実行日時、処理済み行)の記録にも使える
- 編集権限がある人には見えるため、共有範囲そのものも管理する
- プロジェクト複製時は引き継がれない。必要な設定項目を文書に残す
設定値をコードから切り離しておくと、環境の移行やメンテナンスが格段に楽になります。外部サービス連携を書き始める前に、この仕組みを入れておくことをおすすめします。
他の記事でもGASやスプレッドシートの業務効率化テクニックを紹介していますので、ぜひチェックしてみてください。