# clasp — Google Apps 脚本 CLI 使用“clasp” CLI 在本地开发和部署 Google Apps 脚本 (GAS) 项目。只需用 TypeScript 编写它并推送它即可创建在 Google 服务器上运行的脚本。 * 官方文档： * npm： * GitHub： ## 安装和设置 npm 安装-g @google/clasp 扣登录启用 Apps 脚本 API： ## 命令列表命令|目的 ---|--- `扣登录` |使用 Google 帐户进行身份验证 `扣住注销` |退出 `扣环创建--标题“名称”` |创建新项目 `扣环创建--标题“名称”--键入表格` |使用电子表格附件创建 `扣环克隆 ` |克隆现有项目 `扣拉力` |从远程获取到本地 `扣推` |从本地上传到远程 `扣推--手表` |监视文件变化并自动推送 `扣环状态` |显示跟踪文件的状态 `扣打开` |在浏览器中打开 Apps 脚本编辑器 `扣开--webapp` |打开已部署的 Web 应用程序 `扣环部署` |部署清单 `扣环部署` |部署新版本 `扣环取消部署 ` |删除部署 `扣环版本[描述]` |版本创建 `扣环版本` |版本列表 `扣木` |显示执行日志 `clasp run <函数名称>` |远程执行功能 `扣环设置` |显示项目设置 ## 项目类型指定与“clasp create --type ”关联的容器：类型 |目的地 ---|--- `独立` |独立项目（默认） `床单` |谷歌表格 `文档` |谷歌文档 `幻灯片` |谷歌幻灯片 `表格` |谷歌表单 `网络应用程序` |网络应用程序 `api` | API可执行文件 ## TypeScript 兼容 clasp 本身支持 TypeScript。推送时自动从“.ts”转换为“.gs”。 ### 设置扣环创建--标题“我的项目”--类型表 npm 初始化 -y npm install -D @types/google-apps-script `tsconfig.json`： { “编译器选项”：{ “lib”：[“esnext”]， “严格”：真实， “skipLibCheck”：true } } 通过在 .clasp.json 中设置 rootDir 来分隔源： { "scriptId": "...", “根目录”：“源” } ### 目录结构我的天然气项目/ ├── .clasp.json ├── tsconfig.json ├── package.json └── 源文件/ ├── appsscript.json ├── main.ts └── utils.ts `src/appsscript.json`（清单）： { "timeZone": "亚洲/东京", “依赖项”：{}， “异常记录”：“STACKDRIVER”， “运行时版本”：“V8” } ** ** ## 常用图案 ### 1\.自定义电子表格功能函数 HELLO(名称: 字符串): 字符串 { 返回`你好，${name}！ `; } 函数 FETCH_PRICE（股票代码：字符串）：数字 |字符串{ const url = `https://api.example.com/price/${ticker}`; const res = UrlFetchApp.fetch(url); const data = JSON.parse(res.getContentText()); 返回数据.价格 ?? “获取失败”； } 可以在单元格中用作 `=HELLO("Taro")` 或 `=FETCH_PRICE("AAPL")`。 ### 2\. Web 应用程序（webhook 端点）函数 doPost(e: GoogleAppsScript.Events.DoPost): GoogleAppsScript.Content.TextOutput { const 负载 = JSON.parse(e.postData.contents); const Sheet = SpreadsheetApp.openById("SHEET_ID").getActiveSheet(); sheet.appendRow([new Date(), Payload.event, JSON.stringify(payload.data)]); 返回 ContentService.createTextOutput(JSON.stringify({ ok: true })) .setMimeType(ContentService.MimeType.JSON); } 函数 doGet(): GoogleAppsScript.Content.TextOutput { 返回 ContentService.createTextOutput(JSON.stringify({ status: "running" })) .setMimeType(ContentService.MimeType.JSON); } 部署步骤：扣推扣环部署--描述“Webhook v1” 扣子打开--webapp 将 Web 应用程序设置添加到 `appsscript.json`： { "timeZone": "亚洲/东京", “依赖项”：{}， “异常记录”：“STACKDRIVER”， “运行时版本”：“V8”， “网络应用程序”：{ “访问”：“ANYONE_ANONYMOUS”， “executeAs”：“USER_DEPLOYING” } } ### 3\.周期性执行（触发）函数 setupTrigger(): void { ScriptApp.newTrigger(“每日任务”) .timeBased() .日常(1) .atHour(9) .create(); } 函数 dailyTask(): void { const Sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Log"); if (!sheet) 返回； sheet.appendRow([new Date(), "每日任务执行"]); } 手动设置触发器：“clasp run setupTrigger”或从 Apps 脚本编辑器中的触发器设置屏幕。 ### 4\. Gmail 自动化函数 archiveOldThreads(): void { const 线程 = GmailApp.search("older_than:30d -is:starred label:inbox", 0, 100); for (线程的常量线程) { 线程.moveToArchive(); } } 函数 sendDailyDigest(): void { const 线程 = GmailApp.search("is:unread newer_than:1d", 0, 20); const 摘要 =threads.map((t) => `• ${t.getFirstMessageSubject()}`).join("\n"); 如果（摘要）{ GmailApp.sendEmail("you@example.com", "今日未读邮件摘要", 摘要); } } ### 5\.电子表格操作函数syncDataToSheet(): void { const ss = SpreadsheetApp.getActiveSpreadsheet(); const Sheet = ss.getSheetByName("Data") ?? ss.insertSheet("数据"); const res = UrlFetchApp.fetch("https://api.example.com/data"); const 项：数组 <{ 名称：字符串；值：数字 }> = JSON.parse(res.getContentText()); 工作表.clear(); sheet.appendRow(["名称", "值", "更新时间"]); for (const item of items) { sheet.appendRow([item.name, item.value, new Date()]); } } ### 6\.松弛通知函数notifySlack（消息：字符串）：void { const webhookUrl = PropertiesService.getScriptProperties().getProperty("SLACK_WEBHOOK_URL"); if (!webhookUrl) 抛出新错误("SLACK_WEBHOOK_URL 未设置"); UrlFetchApp.fetch(webhookUrl, { 方法：“发布”，内容类型：“应用程序/json”，负载：JSON.stringify({ text: message }), }); } 函数 onFormSubmit(e: GoogleAppsScript.Events.SheetsOnFormSubmit): void { const 值 = e.values； notificationSlack(`📝 新表单答案：${values.join(", ")}`); } ** ** ## 开发工作流程 ### 创建一个新项目 mkdir my-gas && cd my-gas 扣环创建--标题“我的天然气项目”--类型表 npm 初始化 -y npm install -D @types/google-apps-script # 将 rootDir 更改为 src/ # 将 .clasp.json 的“rootDir”设置为“src” mkdir 源代码 mv appsscript.json src/ ### 编码 → 部署 # 编写代码(src/*.ts) # 推送并反射到远程扣推 # 操作确认扣打开 # 版本和部署扣环部署--描述“v1.0” ### 获取现有项目扣环克隆 # 在 Apps 脚本编辑器的“项目设置”中检查 scriptId ## 脚本属性（环境变量） API 密钥等秘密由 PropertiesService 管理： // 配置（从 Apps 脚本编辑器手动或在首次运行函数中）函数 setProperties(): void { PropertiesService.getScriptProperties().setProperties({ API_KEY: "你的 API 密钥", SLACK_WEBHOOK_URL: "https://hooks.slack.com/...", }); } // 获取函数 getApiKey(): 字符串 { 返回 PropertiesService.getScriptProperties().getProperty("API_KEY") ?? “”； } ## 主要燃气服务服务 |应用 ---|--- `电子表格应用程序` |电子表格操作 `GmailApp` | Gmail 操作 `日历应用程序` |日历操作 `DriveApp` |谷歌云端硬盘操作 `文档应用程序` |文件操作 `幻灯片应用程序` |滑动操作 `表单应用程序` |表单操作 `UrlFetchApp` | HTTP请求 `内容服务` |网络应用程序响应 `属性服务` |脚本属性（环境变量） `脚本应用程序` |触发器和权限管理 `缓存服务` |缓存 `锁定服务` |专属锁 `公用事业` |编码/散列/日期 `记录器` / `控制台` |日志输出 ## 故障排除问题 |解决方案 ---|--- 运行 `clasp: 未找到命令` | `npm install -g @google/clasp` 运行“脚本错误：未登录”| `扣登录` `用户尚未启用 Apps 脚本 API` |在启用 API `push` 输入错误 |检查是否安装了“@types/google-apps-script” `run` 的权限错误 |从编辑器手动运行“clasp open”并批准权限部署后更改未反映出来 |创建新的部署（现有部署是固定版本）我不知道网络应用程序的 URL |使用“扣环部署”检查部署列表 ## 注释 * `clasp push` 覆盖远程文件。首先使用“clasp pull”获取最新版本。 * 每次部署 Web 应用程序时都会发出一个新的 URL。如果需要固定URL，请复用clasp deploy的deploymentId * GAS 运行时间限制：通常为 6 分钟，在 Google Workspace 上为 30 分钟 * 注意`UrlFetchApp.fetch`的同时连接数和速率限制

应用脚本

包含技能