Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tomoyanakano/redash-to-sheet
📒 Google Apps Script for fetching redash query result and sync to google sheet
https://github.com/tomoyanakano/redash-to-sheet
google-apps-script redash
Last synced: 4 days ago
JSON representation
📒 Google Apps Script for fetching redash query result and sync to google sheet
- Host: GitHub
- URL: https://github.com/tomoyanakano/redash-to-sheet
- Owner: tomoyanakano
- License: mit
- Created: 2023-11-17T04:47:50.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-06T07:00:00.000Z (9 months ago)
- Last Synced: 2024-05-07T07:54:57.157Z (9 months ago)
- Topics: google-apps-script, redash
- Language: TypeScript
- Homepage:
- Size: 434 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Google Sheets & Redash Data Integration Script
This project provides a Google Apps Script that integrates Google Sheets with Redash. It fetches data from Redash queries and updates the corresponding sheets automatically.
## Overview
This script allows for automatic synchronization of data from Redash into Google Sheets. It's designed to run as a Google Sheets script, making it easy to set up and use within your Google Drive environment.
## Features
- Fetches and refreshes data from specified Redash queries.
- Updates Google Sheets with the latest data on a configurable schedule.
- Utilizes the Redash API for data retrieval.
- Supports multiple sheets and queries.
## Getting Started
### Prerequisites
- Access to Google Sheets
- A Redash account with queries set up
- The Redash API Key
### Setup
1. Clone this repository or copy the script files into your Google Apps Script editor.
2. set script properties below.
- `API_KEY`: Your Redash API key.
- `REDASH_HOST`: The URL of your Redash instance.
- `CONFIG_SHEET_NANE`: The name of the index sheet in your Google Sheets document (default: config).
### Configuration
Create an index sheet in your Google Sheets document with the following columns:
- `ColumnA: checkbox`: CheckBox to enable/disable the synchronization for the sheet. (executed on `refreshQueries`)
- `ColumnB: sheetName`: The name of the sheet where data will be updated.
- `ColumnC: queryId`: The ID of the Redash query to fetch data from.
- `ColumnD: keyColumnIndex`: The index of the column in your sheet that will act as the unique key for data updates.
### Deployment with Clasp
This project uses Clasp TypeScript Template for deployment.
#### Clasp
Add your script ID:
- **Dev Environment:** `.clasp.json.dev`
- **Prod Environment:** `.clasp.json.prod`
```json
{"scriptId":" YOUR SCRIPT ID "}
```
**appscript.json**
Modify `appscript.json` as needed:
- Time Zone (default: "Asia/Tokyo")
- OAuth
#### npm
Install packages:
```
npm install
```
Run linter:
```
npm run lint
```
Deploy:
```
npm run deploy:dev
npm run deploy:prod
```
### Usage
After setting up the script, you can run the `refreshQueries` function to start the synchronization process. You can also set up a trigger in Google Apps Script to run this function on a schedule.
## Contributing
Contributions are welcome, and any contributions you make are greatly appreciated.
## License
Distributed under the MIT License. See `LICENSE` for more information.