Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(firestore-sheets-sync): initial commit #52

Open
wants to merge 18 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
chore: formatting
pr-Mais committed Feb 27, 2023
commit c9f685148bce2a13aa1693f605d198a76f8258b8
1 change: 0 additions & 1 deletion extensions/firestore-sheets-sync/POSTINSTALL.md
Original file line number Diff line number Diff line change
@@ -13,4 +13,3 @@ You need to allow the extension service account to edit the Google Sheet you wan
```

You're good to go!

30 changes: 7 additions & 23 deletions extensions/firestore-sheets-sync/README.md
Original file line number Diff line number Diff line change
@@ -4,8 +4,6 @@

**Description**: Export defined collection to a Google Sheet.



**Details**: Use this extension to sync Firestore documents to Google Sheets automatically.

This extension creates a Cloud Function named `googleSheetSync`, which will be triggered when a Firestore document is created in the specified collection.
@@ -34,40 +32,26 @@ To install an extension, your project must be on the [Blaze (pay as you go) plan
- Cloud Storage
- Cloud Functions (Node.js 10+ runtime. [See FAQs](https://firebase.google.com/support/faq#extensions-pricing))




**Configuration Parameters:**

* Google Sheet ID: What is the ID of the Google Sheet you want to export to?


* Firestore collection to record export metadata: What is the path to the collection that will be synced to your Google Sheet?

- Google Sheet ID: What is the ID of the Google Sheet you want to export to?

* Fields to sync: A list of comma-separated fields to sync to the Google Sheet. If left blank, no fields will be synced.


* Cloud Functions location: Where do you want to deploy the functions created for this extension? For help selecting a location, refer to the [location selection guide](https://firebase.google.com/docs/functions/locations).
- Firestore collection to record export metadata: What is the path to the collection that will be synced to your Google Sheet?

- Fields to sync: A list of comma-separated fields to sync to the Google Sheet. If left blank, no fields will be synced.

- Cloud Functions location: Where do you want to deploy the functions created for this extension? For help selecting a location, refer to the [location selection guide](https://firebase.google.com/docs/functions/locations).

**Cloud Functions:**

* **googleSheetSync:** Listens for document changes in your specified Cloud Firestore collection, then exports the changes into a Google Sheet.


- **googleSheetSync:** Listens for document changes in your specified Cloud Firestore collection, then exports the changes into a Google Sheet.

**APIs Used**:

* sheets.googleapis.com (Reason: Powers all Sheets tasks performed by the extension.)


- sheets.googleapis.com (Reason: Powers all Sheets tasks performed by the extension.)

**Access Required**:



This extension will operate with the following project IAM roles:

* datastore.owner (Reason: Allows the extension to export (user) data from Cloud Firestore.)
- datastore.owner (Reason: Allows the extension to export (user) data from Cloud Firestore.)