Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yuanqing/google-sheets
:leaves: An easier interface to read from and write to Google Sheets
https://github.com/yuanqing/google-sheets
google-api google-sheets spreadsheet
Last synced: 5 days ago
JSON representation
:leaves: An easier interface to read from and write to Google Sheets
- Host: GitHub
- URL: https://github.com/yuanqing/google-sheets
- Owner: yuanqing
- License: mit
- Created: 2019-07-15T10:36:02.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-01-30T07:40:32.000Z (almost 4 years ago)
- Last Synced: 2024-12-12T05:42:14.613Z (11 days ago)
- Topics: google-api, google-sheets, spreadsheet
- Language: JavaScript
- Homepage:
- Size: 688 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# @yuanqing/google-sheets [](https://www.npmjs.org/package/@yuanqing/google-sheets) [](https://travis-ci.org/yuanqing/google-sheets)
> An easier interface to read from and write to Google Sheets
## Quick start
```sh
$ yarn add @yuanqing/google-sheets
```
```js
const { getSpreadsheet } = require('@yuanqing/google-sheets')
async function main () {
const serviceAccountCredentials = {
clientEmail: '',
priateKey: ''
}
const spreadsheetId = ''
const sheetName = ''
const spreadsheet = await getSpreadsheet(
serviceAccountCredentials,
spreadsheetId
)
const sheet = await spreadsheet.getSheet(sheetName)
const rows = await sheet.getAllRows()
console.log(rows)
}
await main()
```
- **``** and **``** are credentials for a Service Account with edit access to your spreadsheet. See [Initial setup](#initial-setup).
- **``** is the value between `/d/` and `/edit` in your spreadsheet URL.
- **``** is the name of the sheet that you want to read from or write to.
### Initial setup
1. Create a Service Account on the Google API Console.
1. Navigate to [the Google API Console](https://console.developers.google.com/apis/dashboard)
2. Select a project from the drop-down box in the top bar.
3. Click **`Credentials`** (the Key icon) on the left navigation bar.
4. Click the **`Create credentials`** drop-down box, and select **`Service account key`**.
5. Click the **`Select…`** drop-down box, and select **`New service account`**. Enter a **`Service account name`**. For **`Role`**, select **`Project › Editor`**.
6. For **`Key type`**, select **`JSON`**.
7. Click the **`Create`** button. A JSON file with the Service Account credentials will be generated. Note the `client_email` and `private_key` values in the generated JSON file.
2. Grant the Service Account edit access to your spreadsheet.
1. Navigate to your spreadsheet.
2. Click the **`Share`** button on the top-right corner of the page.
3. In the **`Enter names or email addresses…`** text box, enter the `client_email` of the Service Account, then click the **`Send`** button.
### Assumptions
1. Data is row-based. Each field is stored on a column.
2. Row 1 of the sheet contains the headers for the data. “Actual” data starts from Row 2.
[](https://docs.google.com/spreadsheets/d/1ur-Bd1PBUpkXs18u4VeSy85q9wSYf2db9hUi73aWbSY/edit#gid=0)
> [**Example spreadsheet**](https://docs.google.com/spreadsheets/d/1ur-Bd1PBUpkXs18u4VeSy85q9wSYf2db9hUi73aWbSY/edit#gid=0)
## API
```js
const { createSpreadsheet, getSpreadsheet } = require('@yuanqing/google-sheets')
```
### Spreadsheet
#### const spreadsheet = await createSpreadsheet(serviceAccountCredentials)
Creates a new spreadsheet and returns a Promise for it.
- `serviceAccountCredentials` is an object literal with the following keys:
Key | Description
:-|:-
`clientEmail` | Email address of the Service Account that has edit access to the spreadsheet.
`privateKey` | Private key of the Service Account.
#### const spreadsheet = await getSpreadsheet(serviceAccountCredentials, spreadsheetId)
Returns a Promise for an existing spreadsheet.
- `spreadsheetId` is the value between `/d/` and `/edit` in the spreadsheet URL.
#### const sheet = await spreadsheet.createSheet(spreadsheetName, headers)
Creates a new sheet and returns a Promise for it.
- `spreadsheetName` is the name of the new sheet.
- `headers` is an array of headers for the new sheet.
#### const sheet = await spreadsheet.getSheet(spreadsheetName)
Returns a Promise for an existing sheet.
### Sheet
#### const rows = await sheet.getAllRows()
Returns a Promise for an array containing all the `rows` from the `sheet`.
#### const rows = await sheet.getRowsByRange(m, n)
Returns a Promise for an array containing `rows` from the row `m` to row `n` of the `sheet`.
Data rows are zero-indexed. For example, pass in `(0, 1)` to delete rows 2 and 3 in the `sheet`.
#### await sheet.addRows(rows)
Appends the given array of `rows` to the `sheet`, and returns a Promise that resolves.
#### const deletedRows = await sheet.deleteRows(predicate)
Deletes rows in the `sheet` that satisfy the given `predicate`, and returns a Promise for an array containing the deleted rows.
## Installation
```sh
$ yarn add @yuanqing/google-sheets
```
## License
[MIT](LICENSE.md)