如何通过Node.js调用Google Script API为脚本项目添加Libraries

核心实现原理 #

Google Apps Script API原生支持通过修改项目清单文件实现库的批量添加，无需手动操作。Apps Script项目的所有依赖配置都存储在项目根目录的appsscript.json清单文件中，添加Libraries本质就是在该文件的dependencies.libraries数组中插入对应库的配置项。

Node.js 端实现步骤 #

前置准备 #

• 已经开启Google Cloud项目的Apps Script API权限
• 已经获取到对应操作权限的OAuth2凭据（授权范围需要包含https://www.googleapis.com/auth/script.projects）
• 已记录两个核心ID：生成的容器绑定脚本的脚本ID、存储业务逻辑的公共库的脚本ID

核心代码示例 #

const { google } = require('googleapis');
const script = google.script('v1');

// 以下为示例参数，替换为你自己的实际值
const CONTAINER_SCRIPT_ID = '你的容器绑定脚本ID';
const LIB_SCRIPT_ID = '你的业务逻辑库的脚本ID';
const LIB_VERSION = '1'; // 库的发布版本号
const LIB_SYMBOL = 'lib'; // 你代码中调用库的命名空间，和示例里的保持一致

async function addLibraryToBoundScript() {
  // 这里的auth替换为你自己的已授权OAuth2客户端实例
  const auth = await getAuthenticatedClient(); 

  // 构造要更新的脚本项目内容
  const projectContent = {
    files: [
      // 容器绑定脚本的委托代码文件
      {
        name: 'Code',
        type: 'SERVER_JS',
        source: `const onOpen = (e) => {
  ${LIB_SYMBOL}.onOpen(e)
}`
      },
      // 项目清单文件，添加库配置
      {
        name: 'appsscript',
        type: 'JSON',
        source: JSON.stringify({
          timeZone: 'Asia/Shanghai',
          runtimeVersion: 'V8',
          dependencies: {
            libraries: [
              {
                scriptId: LIB_SCRIPT_ID,
                version: LIB_VERSION,
                userSymbol: LIB_SYMBOL,
                developmentMode: false // 不需要调试库的话设为false即可
              }
            ]
          }
        })
      }
    ]
  };

  // 调用API更新脚本项目内容
  const res = await script.projects.updateContent({
    auth: auth,
    scriptId: CONTAINER_SCRIPT_ID,
    requestBody: projectContent
  });

  console.log('库添加完成', res.data);
}

常见注意事项 #

• 确保你的业务逻辑库已经发布对应版本，且权限设置为目标用户可访问
• 容器绑定脚本的授权范围需要和业务库的所需范围匹配，避免运行时报权限错误
• 如果需要添加多个库，只需在libraries数组中追加多个配置项即可
• 若要使用库的开发模式，需要保证当前操作账号对库项目有编辑权限

内容的提问来源于stack exchange，提问作者liberrace