Google Apps Script binding for Firebase Realtime Database
The Google Apps Script binding for the Firebase Realtime Database
Best it to copy the content of this file in your Google Apps Script project: https://github.com/RomainVialard/FirebaseApp/blob/master/src/Code.gs
You can also add it as a library, though this is not recommended.
https://developers.google.com/apps-script/guides/libraries
Library's script ID: 1VlYLzhwx0YEoxIe62eItLAZeobVt_l-GQUKt2MXXuBHFVsqBkl9C_yBB
getDatabaseByUrl(url, optSecret)
Retrieves a database by url
url
— string
— - the database url
[optSecret]
— string
— - a Firebase app secret
Database
— the Database found at the given URLencodeAsFirebaseKey(string)
Returns a valid Firebase key from a given string Firebase Keys can't contain any of the following characters: . $ # [ ] / https://firebase.google.com/docs/database/usage/limits#data_tree https://groups.google.com/forum/#!msg/firebase-talk/vtX8lfxxShk/skzA5vQFdosJ
Parameters: string
— string
— - the string to encode
Returns: string
— the encoded string
decodeFirebaseKey(string)
Returns a decoded string from a Firebase key encoded by encodeAsFirebaseKey()
Parameters: string
— string
— - the encoded Firebase key
Returns: string
— the decoded string
signInWithIdp(firebaseConfig, idToken)
Signs in or signs up a user using credentials from an Identity Provider (IdP) - eg: google.com. https://cloud.google.com/identity-platform/docs/reference/rest/v1/accounts/signInWithIdp
firebaseConfig
— object
— - see the "Get config object for your web app" section in the page linked below.
idToken
— string
— - an OpenID Connect identity token retrieved via ScriptApp.getIdentityToken()
object
— the auth token granting access to firebasecreateAuthToken(userEmail, optAuthData, serviceAccountEmail, privateKey)
Generates an authorization token to firebase
userEmail
— string
— the email account of the user you want to authenticateoptAuthData
— object
— key-pairs of data to be associated to this user.serviceAccountEmail
— string
— the email of the service account used to generate this tokenprivateKey
— string
— the private key of this service accountobject
— the auth token granting access to firebasecreateAuthTokenFromServiceAccount(userEmail, optCustomClaims)
Generates an authorization token to Firebase
userEmail
— string
— - the email account of the user you want to authenticate
optCustomClaims
— object
— - key-pairs of data to be associated to this user (aka custom claims).
object
— the auth token granting access to firebasecreateLegacyAuthToken(userEmail, optCustomClaims)
Generates an authorization token to firebase
userEmail
— string
— the email account of the user you want to authenticateoptCustomClaims
— object
— - key-pairs of data to be associated to this user (aka custom claims).object
— the auth token granting access to firebasegetData(path, optQueryParameters)
Returns the data at this path
path
— string
— - the path where the data is stored
[optQueryParameters]
— OptQueryParameters
— - a set of query parameters
object
— the data found at the given pathgetAllData(requests)
Returns data in all specified paths
Parameters: {Array.<string
— FirebaseApp_.request>} requests - array of requests
Returns: object
— responses to each requests
pushData(path, data, optQueryParameters)
Generates a new child location using a unique key
path
— string
— - the path where to create a new child
data
— object
— - the data to be written at the generated location
[optQueryParameters]
— OptQueryParameters
— - a set of query parameters
string
— the child name of the new data that was addedsetData(path, data, optQueryParameters)
Write data at the specified path
path
— string
— - the path where to write data
data
— object
— - the data to be written at the specified path
[optQueryParameters]
— OptQueryParameters
— - a set of query parameters
object
— the data writtenupdateData(path, data, optQueryParameters)
Update specific children at the specified path without overwriting existing data
path
— string
— - the path where to update data
data
— object
— - the children to overwrite
[optQueryParameters]
— OptQueryParameters
— a - set of query parameters
object
— the data writtenremoveData(path, optQueryParameters)
Delete data at the specified path
path
— string
— - the path where to delete data
[optQueryParameters]
— OptQueryParameters
— - a set of query parameters
null
—getUrlFromPath(path)
Gets the absolute URL from the specified path
path
— string
— - the path / location to convert to URLstring
— an encoded URL that is ready to be put into a browser#Tutorials https://sites.google.com/site/scriptsexamples/new-connectors-to-google-services/firebase/tutorials