Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

form-google-sheets

0.1.1 • Public • Published

form-google-sheets

Maintenance Status NPM version Travis build

Uses Google Apps Scripts with Google Sheets to provide a POST endpoint for form data that is parsed into sheet fields.

https://techcoop.github.io/form-google-sheets/

Requirements

  1. Google Account
  2. Google Sheet with column headers
  3. node > 6.0.0 (Optional)
  4. yarn (or npm latest) > 0.10.0 (Optional)

Installation

Google Scripts

  1. Create a google sheet
  2. Make the first column "timestamp"
  3. Click on "Tools" > "Script Editor..."
  4. Name your project something memorable
  5. Replace contents of code.gs with this file
  6. Change the name of your tab in the sheet
  7. Update the variable "SHEET_NAME" in the code from step 5
  8. Add columns you want as fields in your form, the fields should match your HTML exactly
  9. Add any required fields with messages to the "fields" object
  10. Edit the "testData" to match your sheet fields
  11. Click on Run > Run Function > "test_post"
  12. Confirm this data is inserted into your sheet
  13. If everything works, Click on Publish and select "Deploy as web app"
  14. Select new and type a version name (e.g 0.1.0) (or update existing)
  15. In "Execute the app as" select yourself
  16. In "Who has access to the app" Select "Anyone, even anonymous"
  17. Click Deploy or Update
  18. Click "Review Permissions", to Authorize application
  19. When you see a warning, Click "Advanced" and "Go to PROJECT_NAME"
  20. Review list of permissions required, and click "Allow"
  21. Copy and paste URL (note: if you're logged into multiple Google accounts you'll have to manually remove "/u/0" or similar from the URL to avoid errors)
  22. Setup your HTML form to post to the URL from step 21

NPM package

yarn add form-google-sheets

Usage

ES6

import { Form } from 'form-google-sheets'
 
const endpoint = 'https://script.google.com/macros/s/AKfycbyEBGqfIUmxrLKMp_LlAlH8C_VO9vfRvtvwgjAS9lEi8Vu8xho/exec'
const form = new Form(endpoint).then((event) => {
  console.log('SUCCESS')
  console.log(event)
}).catch((event) => {
  console.log('ERROR')
  console.log(event)
})

Node

var Form = require('form-google-sheets').Form
 
var endpoint = 'https://script.google.com/macros/s/AKfycbyEBGqfIUmxrLKMp_LlAlH8C_VO9vfRvtvwgjAS9lEi8Vu8xho/exec'
var form = new Form(endpoint).then((event) => {
  console.log('SUCCESS')
  console.log(event)
}).catch((event) => {
  console.log('ERROR')
  console.log(event)
})

Javascript

<script src="form-google-sheets.js"></script>
var endpoint = 'https://script.google.com/macros/s/AKfycbyEBGqfIUmxrLKMp_LlAlH8C_VO9vfRvtvwgjAS9lEi8Vu8xho/exec'
var form = new FormGoogleSheets.Form(endpoint).then(function(event) {
  console.log('SUCCESS')
  console.log(event)
}).catch(function(event) {
  console.log('ERROR')
  console.log(event)
})

Testing

Google Scripts

There is a test function setup that you can change to include your own fields and make sure your form is setup correctly.

  1. Change the testData in test_post()
  2. Move to Run in the top menu
  3. Click function test_post()

Client library

# Run unit test 
yarn test

Releasing

# Create new versioned release 
yarn run release

Examples

You can see examples of use in javascript under /docs.

You can see the (view only) sheet that this posts to here: https://docs.google.com/spreadsheets/d/1SRRfFOpIJyW6tZB1TP3wJf01CFISviIMFEJDgwoqq5w/edit?usp=sharing

Original Source

https://github.com/dwyl/html-form-send-email-via-google-script-without-server

Contributing

All contributors are welcome, please follow CONTRIBUTING.md

Contributors

colin@techcoop.group

Install

npm i form-google-sheets

DownloadsWeekly Downloads

0

Version

0.1.1

License

MIT

Last publish

Collaborators

  • avatar
  • avatar