Skip to content

Latest commit

 

History

History
 
 

firestore-shorten-urls-bitly

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
functions
functions
 
 
.gitignore
.gitignore
 
 
CHANGELOG.md
CHANGELOG.md
 
 
POSTINSTALL.md
POSTINSTALL.md
 
 
PREINSTALL.md
PREINSTALL.md
 
 
README.md
README.md
 
 
extension.yaml
extension.yaml
 
 

README.md

Shorten URLs in Firestore

Author: Firebase (https://firebase.google.com)

Description: Shortens URLs written to a specified Cloud Firestore collection (uses Bitly).

Details: Use this extension to create shortened URLs from URLs written to Cloud Firestore. These shortened URLs are useful as display URLs.

This extension listens to your specified Cloud Firestore collection. If you add a URL to a specified field in any document within that collection, this extension:

  • Shortens the URL.
  • Saves the shortened URL in a new specified field in the same document.

If the original URL in a document is updated, then the shortened URL will be automatically updated, too.

This extension uses Bitly to shorten URLs, so you'll need to supply your Bitly access token as part of this extension's installation. You can generate this access token using Bitly.

Additional setup

Before installing this extension, make sure that you've set up a Cloud Firestore database in your Firebase project.

You must also have a Bitly account and access token before installing this extension.

Billing

To install an extension, your project must be on the Blaze (pay as you go) plan

  • This extension uses other Firebase and Google Cloud Platform services, which have associated charges if you exceed the service’s no-cost tier:
    • Cloud Firestore
    • Cloud Functions (Node.js 10+ runtime. See FAQs)
  • This extension also uses these services:
    • Bitly. You must have a Bitly account and you're responsible for any associated charges.

Configuration Parameters:

  • Bitly access token: What is your Bitly access token? Generate this access token using Bitly.

  • Collection path: What is the path to the collection that contains the URLs that you want to shorten?

  • URL field name: What is the name of the field that contains the original long URLs that you want to shorten?

  • Short URL field name: What is the name of the field where you want to store your shortened URLs?

Cloud Functions:

  • fsurlshortener: Listens for writes of new URLs to your specified Cloud Firestore collection, shortens the URLs, then writes the shortened form back to the same document.

Access Required:

This extension will operate with the following project IAM roles:

  • datastore.user (Reason: Allows the extension to write shortened URLs to Cloud Firestore.)