Node-Google-Spreadsheet 使用指南

Node-Google-Spreadsheet 使用指南

node-google-spreadsheet Google Sheets API wrapper for Javascript / Typescript 项目地址: https://gitcode.com/gh_mirrors/no/node-google-spreadsheet

1. 项目介绍

node-google-spreadsheet 是一个开源项目，它为 JavaScript/TypeScript 提供了一个 Google Sheets API 的封装。这个库支持多种认证方式，包括服务账户、OAuth、API 密钥等，并且提供了基于单元格和行的 API 来读取、写入和格式化 Google Sheets 文档。

2. 项目快速启动

首先，确保你已经安装了 Node.js 环境。以下是如何快速启动 node-google-spreadsheet 的步骤：

# 安装依赖
pnpm install google-spreadsheet
# 或者
npm install google-spreadsheet --save
# 或者
yarn add google-spreadsheet

以下是一个基本的使用示例：

const { GoogleSpreadsheet } = require('google-spreadsheet');
const { JWT } = require('google-auth-library');

// 初始化认证
const jwt = new JWT({
  email: process.env.GOOGLE_SERVICE_ACCOUNT_EMAIL,
  key: process.env.GOOGLE_PRIVATE_KEY,
  scopes: ['https://www.googleapis.com/auth/spreadsheets']
});

// 创建一个新的 GoogleSpreadsheet 实例
const doc = new GoogleSpreadsheet('<你的表格ID>', jwt);

// 加载文档信息
await doc.loadInfo();

// 打印文档标题
console.log(doc.title);

// 更新文档标题
await doc.updateProperties({ title: '新的文档标题' });

确保将 <你的表格ID> 替换为你的 Google Sheets 文档的实际 ID。

3. 应用案例和最佳实践

读取和写入数据

你可以使用以下方法来读取和写入数据：

const sheet = doc.sheetsByIndex[0]; // 获取第一个工作表

// 读取所有行
const rows = await sheet.getRows();

// 写入数据到新行
const newRow = await sheet.addRow({ name: '新名字', email: '新邮箱' });

管理工作表

你可以轻松地添加和删除工作表：

// 添加一个新的工作表
const newSheet = await doc.addSheet({ title: '新工作表' });

// 删除一个工作表
await newSheet.delete();

数据类型

你可以使用 TypeScript 类型来确保数据的形状：

type UsersRowData = {
  name: string;
  email: string;
  type?: 'admin' | 'user';
};

const userRows = await sheet.getRows<UsersRowData>();

4. 典型生态项目

node-google-spreadsheet 作为一个流行的库，在多个生态项目中都有应用。以下是一些使用该库的典型项目：

• 自动化报表生成
• 数据库与 Google Sheets 同步工具
• 教育应用中的成绩管理
• 项目管理工具中的任务跟踪

这些项目展示了 node-google-spreadsheet 在不同场景下的灵活性和实用性。

node-google-spreadsheet Google Sheets API wrapper for Javascript / Typescript 项目地址: https://gitcode.com/gh_mirrors/no/node-google-spreadsheet