n8n-nodes-google-sheets-trigger
Advanced tools
Comparing version 0.1.3 to 0.1.4
{ | ||
"name": "n8n-nodes-google-sheets-trigger", | ||
"version": "0.1.3", | ||
"version": "0.1.4", | ||
"description": "This is a trigger node for Google Sheets.", | ||
@@ -5,0 +5,0 @@ "keywords": [ |
{ | ||
"name": "n8n-nodes-google-sheets-trigger", | ||
"version": "0.1.3", | ||
"version": "0.1.4", | ||
"description": "This is a trigger node for Google Sheets.", | ||
@@ -5,0 +5,0 @@ "keywords": [ |
167
README.md
@@ -1,47 +0,148 @@ | ||
![Banner image](https://user-images.githubusercontent.com/10284570/173569848-c624317f-42b1-45a6-ab09-f0ea3c247648.png) | ||
![Banner n8n & n8nhackers](images/n8n-and-n8nhackers.png) | ||
# n8n-nodes-starter | ||
# n8n-nodes-google-sheets-trigger | ||
This repo contains example nodes to help you get started building your own custom integrations for [n8n](n8n.io). It includes the node linter and other dependencies. | ||
This is an n8n community node. It lets you use Google Sheets in trigger mode with your n8n workflows. | ||
Using this trigger, you will be able to recover only new rows from any Google sheet. | ||
To make your custom node available to the community, you must create it as an npm package, and [submit it to the npm registry](https://docs.npmjs.com/packages-and-modules/contributing-packages-to-the-registry). | ||
# Contents | ||
## Prerequisites | ||
[TLDR](#TLDR) | ||
You need the following installed on your development machine: | ||
[Installation](#installation) | ||
* [git](https://git-scm.com/downloads) | ||
* Node.js and npm. Minimum version Node 16. You can find instructions on how to install both using nvm (Node Version Manager) for Linux, Mac, and WSL [here](https://github.com/nvm-sh/nvm). For Windows users, refer to Microsoft's guide to [Install NodeJS on Windows](https://docs.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-windows). | ||
* Install n8n with: | ||
``` | ||
npm install n8n -g | ||
``` | ||
* Recommended: follow n8n's guide to [set up your development environment](https://docs.n8n.io/integrations/creating-nodes/build/node-development-environment/). | ||
[Operations](#operations) | ||
[Credentials](#credentials) | ||
## Using this starter | ||
[Compatibility](#compatibility) | ||
These are the basic steps for working with the starter. For detailed guidance on creating and publishing nodes, refer to the [documentation](https://docs.n8n.io/integrations/creating-nodes/). | ||
[Usage](#usage) | ||
1. [Generate a new repository](https://github.com/n8n-io/n8n-nodes-starter/generate) from this template repository. | ||
2. Clone your new repo: | ||
``` | ||
git clone https://github.com/<your organization>/<your-repo-name>.git | ||
``` | ||
3. Run `npm i` to install dependencies. | ||
4. Open the project in your editor. | ||
5. Browse the examples in `/nodes` and `/credentials`. Modify the examples, or replace them with your own nodes. | ||
6. Update the `package.json` to match your details. | ||
7. Run `npm run lint` to check for errors or `npm run lintfix` to automatically fix errors when possible. | ||
8. Test your node locally. Refer to [Run your node locally](https://docs.n8n.io/integrations/creating-nodes/test/run-node-locally/) for guidance. | ||
9. Replace this README with documentation for your node. Use the [README_TEMPLATE](README_TEMPLATE.md) to get started. | ||
10. Update the LICENSE file to use your details. | ||
11. [Publish](https://docs.npmjs.com/packages-and-modules/contributing-packages-to-the-registry) your package to npm. | ||
[Version history](#version-history) | ||
## More information | ||
[Another way to try it out](#another-way-to-try-it-out) | ||
Refer to our [documentation on creating nodes](https://docs.n8n.io/integrations/creating-nodes/) for detailed information on building your own nodes. | ||
[Contribution](#contribution) | ||
## License | ||
[Issues](#issues) | ||
[MIT](https://github.com/n8n-io/n8n-nodes-starter/blob/master/LICENSE.md) | ||
[Resources](#resources) | ||
[License](#license) | ||
# TLDR | ||
Don't want to read? Import the sample workflow [Recover only new rows from Google Sheets](https://app.n8n.io/workflows/1812) to test this node. | ||
![Recover only new rows from Google Sheets](images/sample-workflow.jpeg "Recover only new rows from Google Sheets") | ||
# Installation | ||
Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation. | ||
The plugin uses polling capabilities. You will need to recreate your Docker instance to see the poll Times selector. | ||
# Operations | ||
Using this node you recover only new rows added to any Google sheet. | ||
# Credentials | ||
You can choose any credential defined in other Google Sheets nodes. | ||
All credentials are compatible. | ||
# Compatibility | ||
Tested with node 0.197.1. | ||
You need an n8n version with polling enabled. | ||
# Usage | ||
With this node, you will be able to recover new rows added to any sheet. | ||
Define your Google sheets node as usual (credentials, spreadsheet id, range, raw data) and choose your poll time | ||
![Poll time selector](images/polltimes.png) | ||
If you want the sample sheet, access the spreadsheet at | ||
https://docs.google.com/spreadsheets/d/1UzzxzEy6N-B_A3bWGEm-iDa0fM1n7v2JNb2a7q8y_To/edit?usp=sharing | ||
and copy it to your Google Drive. | ||
Google sheet contains a list of numbered rows: | ||
![Google sheet](images/contents-google-sheet.jpeg) | ||
You have a sample below where I combine new rows from Google Sheets with [Generate dynamic contents for EMAILS or HTML pages](https://app.n8n.io/workflows/1790) (this is another community node created by me). | ||
Then, create a new template for this node: | ||
``` | ||
{{#each items}} | ||
{{sample}} | ||
{{/each}} | ||
``` | ||
First, execute the workflow directly to recover all rows and test the message to Telegram. | ||
Polling and recovering new rows only work for active tasks in the background. | ||
Define the poll time (every 5 minutes, every hour, every day), and activate your task to get only new rows. | ||
Check executions to ensure that Workflows are executed every defined poll time. | ||
Now, add new numbered rows (row 24, row, 25, ...) to your Google sheet. | ||
If everything works as expected, a new message is sent to the Telegram channel with new rows. | ||
This is a sample of how the message looks (I added rows 14 to 23). | ||
![image](images/telegram-sample.png) | ||
# Version history | ||
* 2022/10/12 - Initial version for Google Sheets Trigger | ||
# Another way to try it out | ||
Clone the n8n-nodes-google-sheets-trigger repository and execute: | ||
``` | ||
# Use v16.17.0 = lts/gallium | ||
nvm use lts/gallium | ||
# Install dependencies | ||
npm install | ||
# Build the code | ||
npm run build | ||
# "Publish" the package locally | ||
npm link | ||
``` | ||
Create an N8N installation and add the n8n-nodes-document-generator to it: | ||
``` | ||
# Create an N8N installation | ||
cd .. | ||
mkdir n8n_install | ||
cd n8n_install | ||
npm init | ||
npm install | ||
npm install n8n | ||
# "Install" the locally published module | ||
npm link n8n-nodes-google-sheets-trigger | ||
# Start n8n | ||
npx n8n | ||
``` | ||
# Contribution | ||
To make this node even better, please let us know, [how you use it](mailto:miquel@n8nhackers.com). Commits are always welcome. | ||
# Issues | ||
If you have any issues, please [let us know on GitHub](https://github.com/n8nhackers/n8n-nodes-google-sheets-trigger/issues). | ||
# About | ||
Node by [n8nhackers.com](https://n8nhackers.com). For productive use and consulting on this, [contact us please](mailto:contact@n8nhackers.com). | ||
Special thanks to [N8n nodemation](https://n8n.io) workflow automation by Jan Oberhauser. | ||
# Resources | ||
If you want to build your custom n8n nodes, check the [N8N documentation on custom nodes](https://docs.n8n.io/nodes/creating-nodes/create-n8n-nodes-module.html). | ||
# Licenses | ||
* [n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/reference/license/) workflow automation platform. | ||
* [MIT](https://github.com/n8n-io/n8n-nodes-starter/blob/master/LICENSE.md) |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
47506
149