clasp — Google Apps Script CLI

clasp CLI で Google Apps Script (GAS) プロジェクトをローカル開発・デプロイする。 TypeScript で書いて push するだけで、Google のサーバーで動くスクリプトが完成する。

• 公式ドキュメント: https://developers.google.com/apps-script/guides/clasp
• npm: https://www.npmjs.com/package/@google/clasp
• GitHub: https://github.com/google/clasp

インストール & セットアップ

npm install -g @google/clasp
clasp login

Apps Script API を有効化: https://script.google.com/home/usersettings

コマンド一覧

プロジェクトタイプ

clasp create --type <type> で紐付けるコンテナを指定:

TypeScript 対応

clasp は TypeScript をネイティブサポート。push 時に自動的に .ts → .gs に変換される。

セットアップ

clasp create --title "My Project" --type sheets
npm init -y
npm install -D @types/google-apps-script

tsconfig.json:

{
  "compilerOptions": {
    "lib": ["esnext"],
    "strict": true,
    "skipLibCheck": true
  }
}

.clasp.json に rootDir を設定してソースを分離:

{
  "scriptId": "...",
  "rootDir": "src"
}

ディレクトリ構成

my-gas-project/
├── .clasp.json
├── tsconfig.json
├── package.json
└── src/
    ├── appsscript.json
    ├── main.ts
    └── utils.ts

src/appsscript.json（マニフェスト）:

{
  "timeZone": "Asia/Tokyo",
  "dependencies": {},
  "exceptionLogging": "STACKDRIVER",
  "runtimeVersion": "V8"
}

よく作るパターン

1. スプレッドシートのカスタム関数

function HELLO(name: string): string {
  return `こんにちは、${name}さん！`;
}

function FETCH_PRICE(ticker: string): number | string {
  const url = `https://api.example.com/price/${ticker}`;
  const res = UrlFetchApp.fetch(url);
  const data = JSON.parse(res.getContentText());
  return data.price ?? "取得失敗";
}

セルで =HELLO("太郎") や =FETCH_PRICE("AAPL") として使える。

2. Web アプリ（Webhook エンドポイント）

function doPost(e: GoogleAppsScript.Events.DoPost): GoogleAppsScript.Content.TextOutput {
  const payload = JSON.parse(e.postData.contents);
  const sheet = SpreadsheetApp.openById("SHEET_ID").getActiveSheet();
  sheet.appendRow([new Date(), payload.event, JSON.stringify(payload.data)]);
  return ContentService.createTextOutput(JSON.stringify({ ok: true }))
    .setMimeType(ContentService.MimeType.JSON);
}

function doGet(): GoogleAppsScript.Content.TextOutput {
  return ContentService.createTextOutput(JSON.stringify({ status: "running" }))
    .setMimeType(ContentService.MimeType.JSON);
}

デプロイ手順:

clasp push
clasp deploy --description "Webhook v1"
clasp open --webapp

appsscript.json に Web アプリ設定を追加:

{
  "timeZone": "Asia/Tokyo",
  "dependencies": {},
  "exceptionLogging": "STACKDRIVER",
  "runtimeVersion": "V8",
  "webapp": {
    "access": "ANYONE_ANONYMOUS",
    "executeAs": "USER_DEPLOYING"
  }
}

3. 定期実行（トリガー）

function setupTrigger(): void {
  ScriptApp.newTrigger("dailyTask")
    .timeBased()
    .everyDays(1)
    .atHour(9)
    .create();
}

function dailyTask(): void {
  const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Log");
  if (!sheet) return;
  sheet.appendRow([new Date(), "Daily task executed"]);
}

手動でトリガーを設置: clasp run setupTrigger または Apps Script エディタのトリガー設定画面から設定。

4. Gmail 自動化

function archiveOldThreads(): void {
  const threads = GmailApp.search("older_than:30d -is:starred label:inbox", 0, 100);
  for (const thread of threads) {
    thread.moveToArchive();
  }
}

function sendDailyDigest(): void {
  const threads = GmailApp.search("is:unread newer_than:1d", 0, 20);
  const summary = threads.map((t) => `• ${t.getFirstMessageSubject()}`).join("\n");
  if (summary) {
    GmailApp.sendEmail("you@example.com", "今日の未読メールまとめ", summary);
  }
}

5. スプレッドシート操作

function syncDataToSheet(): void {
  const ss = SpreadsheetApp.getActiveSpreadsheet();
  const sheet = ss.getSheetByName("Data") ?? ss.insertSheet("Data");

  const res = UrlFetchApp.fetch("https://api.example.com/data");
  const items: Array<{ name: string; value: number }> = JSON.parse(res.getContentText());

  sheet.clear();
  sheet.appendRow(["名前", "値", "更新日時"]);
  for (const item of items) {
    sheet.appendRow([item.name, item.value, new Date()]);
  }
}

6. Slack 通知

function notifySlack(message: string): void {
  const webhookUrl = PropertiesService.getScriptProperties().getProperty("SLACK_WEBHOOK_URL");
  if (!webhookUrl) throw new Error("SLACK_WEBHOOK_URL not set");

  UrlFetchApp.fetch(webhookUrl, {
    method: "post",
    contentType: "application/json",
    payload: JSON.stringify({ text: message }),
  });
}

function onFormSubmit(e: GoogleAppsScript.Events.SheetsOnFormSubmit): void {
  const values = e.values;
  notifySlack(`📝 新しいフォーム回答: ${values.join(", ")}`);
}

開発ワークフロー

新規プロジェクト作成

mkdir my-gas && cd my-gas
clasp create --title "My GAS Project" --type sheets
npm init -y
npm install -D @types/google-apps-script

# src/ に rootDir を変更
# .clasp.json の "rootDir" を "src" に設定
mkdir src
mv appsscript.json src/

コーディング → デプロイ

# コードを書く（src/*.ts）

# push してリモートに反映
clasp push

# 動作確認
clasp open

# バージョン作成 & デプロイ
clasp deploy --description "v1.0"

既存プロジェクトの取得

clasp clone <scriptId>
# scriptId は Apps Script エディタの「プロジェクトの設定」で確認

スクリプトプロパティ（環境変数）

API キーなどの秘密情報は PropertiesService で管理:

// 設定（手動で Apps Script エディタから、または初回実行関数で）
function setProperties(): void {
  PropertiesService.getScriptProperties().setProperties({
    API_KEY: "your-api-key",
    SLACK_WEBHOOK_URL: "https://hooks.slack.com/...",
  });
}

// 取得
function getApiKey(): string {
  return PropertiesService.getScriptProperties().getProperty("API_KEY") ?? "";
}

主要な GAS サービス

トラブルシューティング

注意事項

• clasp push はリモートのファイルを上書きする。先に clasp pull で最新を取得すること
• Web アプリをデプロイするたびに新しい URL が発行される。固定 URL が必要なら clasp deploy の deploymentId を使い回す
• GAS の実行時間制限: 通常 6 分、Google Workspace で 30 分
• UrlFetchApp.fetch の同時接続数やレート制限に注意