
Security News
Deno 2.2 Improves Dependency Management and Expands Node.js Compatibility
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
edit-google-spreadsheet
Advanced tools
A simple API for reading and writing to Google Spreadsheets
npm install edit-google-spreadsheet
Load a spreadsheet:
var Spreadsheet = require('edit-google-spreadsheet');
Spreadsheet.load({
debug: true,
spreadsheetName: 'node-edit-spreadsheet',
worksheetName: 'Sheet1',
// Choose from 1 of the 3 authentication methods:
// 1. Username and Password
username: 'my-name@google.email.com',
password: 'my-5uper-t0p-secret-password',
// OR 2. OAuth
oauth : {
email: 'my-name@google.email.com',
keyFile: 'my-private-key.pem'
},
// OR 3. Token
accessToken : {
type: 'Bearer',
token: 'my-generated-token'
}
}, function sheetReady(err, spreadsheet) {
//use speadsheet!
});
Note: Using the options spreadsheetName
and worksheetName
will cause lookups for spreadsheetId
and worksheetId
. Use spreadsheetId
and worksheetId
for improved performance.
Update sheet:
function sheetReady(err, spreadsheet) {
if(err) throw err;
spreadsheet.add({ 3: { 5: "hello!" } });
spreadsheet.send(function(err) {
if(err) throw err;
console.log("Updated Cell at row 3, column 5 to 'hello!'");
});
}
Read sheet:
function sheetReady(err, spreadsheet) {
if(err) throw err;
spreadsheet.receive(function(err, rows, info) {
if(err) throw err;
console.log("Found rows:", rows);
// Found rows: { '3': { '5': 'hello!' } }
});
}
Get metadata
function sheetReady(err, spreadsheet) {
if(err) throw err;
spreadsheet.metadata(function(err, metadata){
if(err) throw err;
console.log(metadata);
// { title: 'Sheet3', rowCount: '100', colCount: '20', updated: [Date] }
});
}
Set metadata
function sheetReady(err, spreadsheet) {
if(err) throw err;
spreadsheet.metadata({
title: 'Sheet2'
rowCount: 100,
colCount: 20
}, function(err, metadata){
if(err) throw err;
console.log(metadata);
});
}
WARNING: all cells outside the range of the new size will be silently deleted
add
ExamplesBatch edit:
spreadsheet.add([[1,2,3],
[4,5,6]]);
Batch edit starting from row 5:
spreadsheet.add({
5: [[1,2,3],
[4,5,6]]
});
Batch edit starting from row 5, column 7:
spreadsheet.add({
5: {
7: [[1,2,3],
[4,5,6]]
}
});
Formula building with named cell references:
spreadsheet.add({
3: {
4: { name: "a", val: 42 }, //'42' though tagged as "a"
5: { name: "b", val: 21 }, //'21' though tagged as "b"
6: "={{ a }}+{{ b }}" //forumla adding row3,col4 with row3,col5 => '=D3+E3'
}
});
Note: cell a
and b
are looked up on send()
Spreadsheet.load( options, callback )
See Options below
add( obj | array )
Add cells to the batch. See examples.
send( [options,] callback( err ) )
Sends off the batch of add()
ed cells. Clears all cells once complete.
options.autoSize
When required, increase the worksheet size (rows and columns) in order to fit the batch (default false
).
receive( [options,] callback( err , rows , info ) )
Recieves the entire spreadsheet. The rows
object is an object in the same format as the cells you add()
, so add(rows)
will be valid. The info
object looks like:
{
spreadsheetId: 'ttFmrFPIipJimDQYSFyhwTg',
worksheetId: 'od6',
worksheetTitle: 'Sheet1',
worksheetUpdated: '2013-05-31T11:38:11.116Z',
authors: [ { name: 'jpillora', email: 'dev@jpillora.com' } ],
totalCells: 1,
totalRows: 1,
lastRow: 3,
nextRow: 4
}
options.getValues
Always get the values (results) of forumla cells.
metadata( [data, ] callback )
Get and set metadata
Note: when setting new metadata, if rowCount
and/or colCount
is left out,
an extra request will be made to retrieve the missing data.
raw
The raw data recieved from Google when enumerating the spreedsheet and worksheet lists, which are triggered when searching for IDs. In order to see this array of all spreadsheets (raw.spreadsheets
) the spreadsheetName
option must be used. Similarly for worksheets (raw.worksheets
), the worksheetName
options must be used.
callback
Function returning the authenticated Spreadsheet instance.
debug
If true
, will display colourful console logs outputing current actions.
username
password
Google account - Be careful about committing these to public repos.
oauth
OAuth configuration object. See google-oauth-jwt. By default oauth.scopes
is set to ['https://spreadsheets.google.com/feeds']
(https
if useHTTPS
)
accessToken
Reuse a generated access token
of the given type
spreadsheetName
spreadsheetId
The spreadsheet you wish to edit. Either the Name or Id is required.
worksheetName
worksheetId
The worksheet you wish to edit. Either the Name or Id is required.
useHTTPS
Whether to use https
when connecting to Google (default: true
)
info
object returned from receive()
, one could always begin add()
ing at the nextRow
, thereby appending to the spreadsheet.Thanks to googleclientlogin
for easy Google API ClientLogin Tokens
FAQs
> A simple API for reading and writing Google Spreadsheets in Node.js
The npm package edit-google-spreadsheet receives a total of 1,614 weekly downloads. As such, edit-google-spreadsheet popularity was classified as popular.
We found that edit-google-spreadsheet demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.