google-spreadsheet-reader
v0.2.0
Published
Converts a Google SpreadSheet to a pretty JSON.
Downloads
5
Maintainers
Readme
google-spreadsheet-reader
Converts a Google SpreadSheet to a pretty JSON.
This works with both server server-side and client-side :)
Demo Click here
Install
$ npm install google-spreadsheet-reader
Preparation
Publish to the web
Select [File > Publish to the web…]
Click [Publish]
Done!
Customize documents
After toggle [Published content & settings], select documents you want to publish. Then click [Start publishing]
Stop publishing
After toggle [Published content & settings], click [Stop publishing]
Usage
Example
For example, see this spreadsheet example.
Get key
Use the key
from the URL.
var SpreadSheet = require('google-spreadsheet-reader');
// Create SpreadSheet Object
var spreadSheet = new SpreadSheet('1lBbCRh6N2Ozz8oEB9fIRN4vuUNQhErqGbAQbHAu2w5Q');
Basic example:
spreadSheet.load()
.then(function(res) { console.log(res); }) // beautiful JSON!
.catch(function(err) { console.error(err.message); }); // Aw, something happened.
Result:
Options:
You can change the property names to camelCase by setting the camelcase
flag to true
.
spreadSheet.load({ camelcase: true })
.then(function(res) { console.log(res); }) // JSON with camelcased properties!
.catch(function(err) { console.error(err.message); });
Result:
Represent data types
You can represent JSON data types with the following spreadsheet configurations.
int / float / number
Add type next to property. (e.g. Population: int
)
Array / JSON
For Array
, split items with |
(e.g. Genotype: Array
)
Convert page items to Object
You can create an Object
type and with the first column, define its properties.
Add : Object
next to the first property. (e.g. id: Object
)