node google spreadsheet
4.1.4
O wrapper mais popular da API do Planilhas Google para javascript/typescript
Site de documentos - Documentos completos disponíveis em https://theoephraim.github.io/node-google-spreadsheet
? Instalação -
pnpm i google-spreadsheet
(ounpm i google-spreadsheet --saveouyarn add google-spreadsheet)
Os exemplos a seguir têm como objetivo dar uma ideia de apenas algumas das coisas que você pode fazer
NOTA IMPORTANTE - Para manter os exemplos concisos, estou chamando await no nível superior, o que não é permitido em algumas versões mais antigas do node. Se você precisar chamar await em um script no nível raiz e seu ambiente não suportar isso, você deverá envolvê-lo em uma função assíncrona como esta:
( 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 ( ) ;Mais informações:
// 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 rowOs métodos de linha suportam tipos TypeScript explícitos para o formato dos dados
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 errorMais informações:
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 callMais informações:
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 ( ) ; Este módulo fornece um wrapper intuitivo em torno da API do Google para simplificar interações comuns
Embora a API de planilhas v4 do Google seja muito mais fácil de usar do que a v3, o módulo oficial googleapis npm é uma metaferramenta gigante gerada automaticamente que lida com todos os produtos do Google . O módulo e a API em si são estranhos e os documentos são terríveis, pelo menos para começar.
Em que situação você deve usar a API do Google diretamente?
Este módulo compensa a simplicidade da interface. A API do Google fornece um mecanismo para fazer muitas solicitações em paralelo. Portanto, se a velocidade e a eficiência forem extremamente importantes para o seu caso de uso, você poderá usar a API diretamente. Existem também muitos recursos menos usados de sua API que ainda não foram implementados aqui.
Este módulo foi escrito e é mantido ativamente por Theo Ephraim.
Você está usando ativamente este módulo para um projeto comercial? Quer ajudar a apoiá-lo?
Compre uma cerveja para Theo
Nenhum ainda - entre em contato!
Contribuições são bem-vindas, mas siga as convenções existentes, use o linter, adicione testes relevantes e adicione documentação relevante.
O site de documentos é gerado usando docsify. Para visualizar e executar localmente para que você possa fazer edições, execute npm run docs:preview e vá para http://localhost:3000 O conteúdo reside em arquivos markdown na pasta docs.
Este é um software de domínio público gratuito e desimpedido. Para obter mais informações, consulte https://unlicense.org.
