最受歡迎的 JavaScript / TypeScript Google Sheets API 包裝器
文件網站 -完整文件位於 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 ( ) ;
更多資訊:
// 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
更多資訊:
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
更多資訊:
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。