FirebaseApp

FirebaseApp

La liaison Google Apps Script pour la base de données en temps réel Firebase

Installer

Il est préférable de copier le contenu de ce fichier dans votre projet Google Apps Script : https://github.com/RomainVialard/FirebaseApp/blob/master/src/Code.gs

Vous pouvez également l'ajouter en tant que bibliothèque, bien que cela ne soit pas recommandé.
https://developers.google.com/apps-script/guides/libraries
ID de script de la bibliothèque : 1VlYLzhwx0YEoxIe62eItLAZeobVt_l-GQUKt2MXXuBHFVsqBkl9C_yBB

Documentation / Référence

Classe FirebaseApp

getDatabaseByUrl(url, optSecret)

Récupère une base de données par URL

• Paramètres :

  • url - string - - l'URL de la base de données

  • [optSecret] — string — - un secret d'application Firebase

• Renvoie : Database – la base de données trouvée à l'URL donnée

encodeAsFirebaseKey(string)

Renvoie une clé Firebase valide à partir d'une chaîne donnée. Les clés Firebase ne peuvent contenir aucun des caractères suivants : . $ # [ ] / https://firebase.google.com/docs/database/usage/limits#data_tree https://groups.google.com/forum/#!msg/firebase-talk/vtX8lfxxShk/skzA5vQFdosJ

• Paramètres : string — string — - la chaîne à encoder

• Renvoie : string – la chaîne codée

decodeFirebaseKey(string)

Renvoie une chaîne décodée à partir d'une clé Firebase codée par encodeAsFirebaseKey()

• Paramètres : string – string – la clé Firebase encodée

• Renvoie : string — la chaîne décodée

signInWithIdp(firebaseConfig, idToken)

Permet de connecter ou d'inscrire un utilisateur à l'aide des informations d'identification d'un fournisseur d'identité (IdP), par exemple : google.com. https://cloud.google.com/identity-platform/docs/reference/rest/v1/accounts/signInWithIdp

• Paramètres :

  • firebaseConfig — object — - voir la section "Obtenir un objet de configuration pour votre application Web" dans la page liée ci-dessous.

    https://support.google.com/firebase/answer/7015592?hl=fr

  • idToken — string — - un jeton d'identité OpenID Connect récupéré via ScriptApp.getIdentityToken()

• Renvoie : object – le jeton d'authentification accordant l'accès à Firebase

Base de données de classe

createAuthToken(userEmail, optAuthData, serviceAccountEmail, privateKey)

Génère un jeton d'autorisation sur Firebase

• Paramètres :
  • userEmail — string — le compte de messagerie de l'utilisateur que vous souhaitez authentifier
  • optAuthData — object — paires de clés de données à associer à cet utilisateur.
  • serviceAccountEmail — string — l'e-mail du compte de service utilisé pour générer ce jeton
  • privateKey — string — la clé privée de ce compte de service
• Renvoie : object – le jeton d'authentification accordant l'accès à Firebase

createAuthTokenFromServiceAccount(userEmail, optCustomClaims)

Génère un jeton d'autorisation sur Firebase

• Paramètres :

  • userEmail — string — - le compte de messagerie de l'utilisateur que vous souhaitez authentifier

  • optCustomClaims — object — - paires de clés de données à associer à cet utilisateur (c'est-à-dire revendications personnalisées).

• Renvoie : object – le jeton d'authentification accordant l'accès à Firebase

createLegacyAuthToken(userEmail, optCustomClaims)

Génère un jeton d'autorisation sur Firebase

• Paramètres :
  • userEmail — string — le compte de messagerie de l'utilisateur que vous souhaitez authentifier
  • optCustomClaims — object — - paires de clés de données à associer à cet utilisateur (c'est-à-dire revendications personnalisées).
• Renvoie : object – le jeton d'authentification accordant l'accès à Firebase

getData(path, optQueryParameters)

Renvoie les données sur ce chemin

• Paramètres :

  • path — string — - le chemin où les données sont stockées

  • [optQueryParameters] — OptQueryParameters — - un ensemble de paramètres de requête

• Renvoie : object – les données trouvées sur le chemin donné

getAllData(requests)

Renvoie les données dans tous les chemins spécifiés

• Paramètres : {Array.<string — FirebaseApp_.request>} requêtes - tableau de requêtes

• Renvoie : object – réponses à chaque requête

pushData(path, data, optQueryParameters)

Génère un nouvel emplacement enfant à l'aide d'une clé unique

• Paramètres :

  • path — string — - le chemin où créer un nouvel enfant

  • data — object — - les données à écrire à l'emplacement généré

  • [optQueryParameters] — OptQueryParameters — - un ensemble de paramètres de requête

• Renvoie : string – le nom enfant des nouvelles données ajoutées

setData(path, data, optQueryParameters)

Écrire des données sur le chemin spécifié

• Paramètres :

  • path — string — - le chemin où écrire les données

  • data — object — - les données à écrire sur le chemin spécifié

  • [optQueryParameters] — OptQueryParameters — - un ensemble de paramètres de requête

• Renvoie : object – les données écrites

updateData(path, data, optQueryParameters)

Mettre à jour des enfants spécifiques au chemin spécifié sans écraser les données existantes

• Paramètres :

  • path — string — - le chemin où mettre à jour les données

  • data — object — - les enfants à écraser

  • [optQueryParameters] — OptQueryParameters — un - ensemble de paramètres de requête

• Renvoie : object – les données écrites

removeData(path, optQueryParameters)

Supprimer les données au chemin spécifié

• Paramètres :

  • path — string — - le chemin où supprimer les données

  • [optQueryParameters] — OptQueryParameters — - un ensemble de paramètres de requête

• Renvoie : null –

getUrlFromPath(path)

Obtient l'URL absolue du chemin spécifié

• Paramètres : path — string — - le chemin/emplacement à convertir en URL
• Renvoie : string – une URL codée prête à être insérée dans un navigateur

#Tutoriels https://sites.google.com/site/scriptsexamples/new-connectors-to-google-services/firebase/tutorials