node google spreadsheet

谷歌电子表格

最流行的 JavaScript / TypeScript Google Sheets API 包装器

• 多个身份验证选项（通过 google-auth-library）- 服务帐户、OAuth、API 密钥、ADC 等
• 基于单元格的 API - 读取、写入、批量更新、格式化
• 基于行的 API - 读取、更新、删除（基于旧的 v3 基于行的调用）
• 管理工作表 - 添加、删除、调整大小、更新属性（例如：标题）、复制到同一文档或其他文档
• 管理文档 - 创建新文档、删除文档、基本共享/权限
• 导出 - 下载各种格式的表格/文档

文档网站 -完整文档位于 https://theoephraim.github.io/node-google-spreadsheet

---

？安装- pnpm i google-spreadsheet
（或npm i google-spreadsheet --save或yarn add google-spreadsheet ）

示例

以下示例旨在让您了解可以执行的一些操作

重要提示- 为了使示例简洁，我在顶层调用 wait ，这在某些旧版本的节点中是不允许的。如果您需要在根级别的脚本中调用await并且您的环境不支持它，则必须将其包装在异步函数中，如下所示：

 ( async function ( ) {
  await someAsyncFunction ( ) ;
} ) ( ) ;

基础知识

 import { GoogleSpreadsheet } from 'google-spreadsheet' ;
import { JWT } from 'google-auth-library' ;

// Initialize auth - see https://theoephraim.github.io/node-google-spreadsheet/#/guides/authentication
const serviceAccountAuth = new JWT ( {
  // env var values here are copied from service account credentials generated by google
  // see "Authentication" section in docs for more info
  email : process . env . GOOGLE_SERVICE_ACCOUNT_EMAIL ,
  key : process . env . GOOGLE_PRIVATE_KEY ,
  scopes : [ 'https://www.googleapis.com/auth/spreadsheets' ] ,
} ) ;

const doc = new GoogleSpreadsheet ( '<the sheet ID from the url>' , serviceAccountAuth ) ;

await doc . loadInfo ( ) ; // loads document properties and worksheets
console . log ( doc . title ) ;
await doc . updateProperties ( { title : 'renamed doc' } ) ;

const sheet = doc . sheetsByIndex [ 0 ] ; // or use `doc.sheetsById[id]` or `doc.sheetsByTitle[title]`
console . log ( sheet . title ) ;
console . log ( sheet . rowCount ) ;

// adding / removing sheets
const newSheet = await doc . addSheet ( { title : 'another sheet' } ) ;
await newSheet . delete ( ) ;

更多信息：

• 谷歌电子表格
• Google电子表格工作表
• 验证

处理行

 // if creating a new sheet, you can set the header row
const sheet = await doc . addSheet ( { headerValues : [ 'name' , 'email' ] } ) ;

// append rows
const larryRow = await sheet . addRow ( { name : 'Larry Page' , email : '[email protected]' } ) ;
const moreRows = await sheet . addRows ( [
  { name : 'Sergey Brin' , email : '[email protected]' } ,
  { name : 'Eric Schmidt' , email : '[email protected]' } ,
] ) ;

// read rows
const rows = await sheet . getRows ( ) ; // can pass in { limit, offset }

// read/write row values
console . log ( rows [ 0 ] . get ( 'name' ) ) ; // 'Larry Page'
rows [ 1 ] . set ( 'email' , '[email protected]' ) ; // update a value
rows [ 2 ] . assign ( { name : 'Sundar Pichai' , email : '[email protected]' } ) ; // set multiple values
await rows [ 2 ] . save ( ) ; // save updates on a row
await rows [ 2 ] . delete ( ) ; // delete a row

Row 方法支持数据形状的显式 TypeScript 类型

 type UsersRowData = {
  name : string ;
  email : string ;
  type ?: 'admin' | 'user' ;
} ;
const userRows = await sheet . getRows < UsersRowData > ( ) ;

userRows [ 0 ] . get ( 'name' ) ; // <- TS is happy, knows it will be a string
userRows [ 0 ] . get ( 'badColumn' ) ; // <- will throw a type error

更多信息：

• GoogleSpreadsheet工作表 > 使用行
• Google电子表格行

使用细胞

 await sheet . loadCells ( 'A1:E10' ) ; // loads range of cells into local cache - DOES NOT RETURN THE CELLS
console . log ( sheet . cellStats ) ; // total cells, loaded, how many non-empty
const a1 = sheet . getCell ( 0 , 0 ) ; // access cells using a zero-based index
const c6 = sheet . getCellByA1 ( 'C6' ) ; // or A1 style notation
// access everything about the cell
console . log ( a1 . value ) ;
console . log ( a1 . formula ) ;
console . log ( a1 . formattedValue ) ;
// update the cell contents and formatting
a1 . value = 123.456 ;
c6 . formula = '=A1' ;
a1 . textFormat = { bold : true } ;
c6 . note = 'This is a note!' ;
await sheet . saveUpdatedCells ( ) ; // save all updates in one call

更多信息：

• GoogleSpreadsheet工作表 > 使用单元格
• Google电子表格单元格

管理文档和共享

 const auth = new JWT ( {
  email : process . env . GOOGLE_SERVICE_ACCOUNT_EMAIL ,
  key : process . env . GOOGLE_PRIVATE_KEY ,
  scopes : [
    'https://www.googleapis.com/auth/spreadsheets' ,
    // note that sharing-related calls require the google drive scope
    'https://www.googleapis.com/auth/drive.file' ,
  ] ,
} ) ;

// create a new doc
const newDoc = await GoogleSpreadsheet . createNewSpreadsheetDocument ( auth , { title : 'new fancy doc' } ) ;

// share with specific users, domains, or make public
await newDoc . share ( '[email protected]' ) ;
await newDoc . share ( 'mycorp.com' ) ;
await newDoc . setPublicAccessLevel ( 'reader' ) ;

// delete doc
await newDoc . delete ( ) ; 

为什么？

该模块提供了一个围绕 Google API 的直观包装器，以简化常见交互

虽然 Google 的 v4 Sheets API 比 v3 更容易使用，但官方的 googleapis npm 模块是一个巨大的自动生成元工具，可以处理所有 Google 产品。该模块和 API 本身很尴尬，而且文档也非常糟糕，至少在开始时是这样。

什么情况下应该直接使用Google的API？
该模块对界面的简单性进行了权衡。 Google 的 API 提供了一种并行发出多个请求的机制，因此如果速度和效率对您的用例极其重要，您可能希望直接使用他们的 API。他们的 API 还有许多较少使用的功能尚未在这里实现。

支持与贡献

该模块由 Theo Ephraim 编写并积极维护。

您是否正在积极将此模块用于商业项目？想帮忙支持一下吗？
给西奥买瓶啤酒

赞助商

还没有 - 请联系！

贡献

欢迎贡献，但请遵循现有约定，使用 linter，添加相关测试，并添加相关文档。

文档站点是使用 docsify 生成的。要在本地预览和运行以便进行编辑，请运行npm run docs:preview并前往 http://localhost:3000 内容位于 docs 文件夹中的 markdown 文件中。

执照

这是免费且不受阻碍的公共领域软件。有关更多信息，请参阅 https://unlicense.org。