FirebaseApp

Firebase应用程序

Firebase 实时数据库的 Google Apps 脚本绑定

安装

最好将此文件的内容复制到您的 Google Apps 脚本项目中：https://github.com/RomainVialard/FirebaseApp/blob/master/src/Code.gs

您也可以将其添加为库，但不建议这样做。
https://developers.google.com/apps-script/guides/libraries
库的脚本 ID： 1VlYLzhwx0YEoxIe62eItLAZeobVt_l-GQUKt2MXXuBHFVsqBkl9C_yBB

文档/参考

FirebaseApp 类

getDatabaseByUrl(url, optSecret)

通过 url 检索数据库

• 参数：

  • url — string — - 数据库url

  • [optSecret] — string — - Firebase 应用程序密钥

• 返回： Database — 在给定 URL 处找到的数据库

encodeAsFirebaseKey(string)

从给定字符串返回有效的 Firebase 键 Firebase 键不能包含以下任何字符： 。 $ # [ ] / https://firebase.google.com/docs/database/usage/limits#data_tree https://groups.google.com/forum/#!msg/firebase-talk/vtX8lfxxShk/skzA5vQFdosJ

• 参数： string — string — - 要编码的字符串

• 返回： string — 编码后的字符串

decodeFirebaseKey(string)

从由encodeAsFirebaseKey()编码的Firebase密钥返回解码后的字符串

• 参数： string — string — - 编码后的 Firebase 键

• 返回： string — 解码后的字符串

signInWithIdp(firebaseConfig, idToken)

使用身份提供商 (IdP) 的凭据登录或注册用户 - 例如：google.com。 https://cloud.google.com/identity-platform/docs/reference/rest/v1/accounts/signInWithIdp

• 参数：

  • firebaseConfig — object — - 请参阅下面链接页面中的“获取 Web 应用程序的配置对象”部分。

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

  • idToken — string — - 通过 ScriptApp.getIdentityToken() 检索的 OpenID Connect 身份令牌

• 返回： object — 授予对 firebase 的访问权限的身份验证令牌

类数据库

createAuthToken(userEmail, optAuthData, serviceAccountEmail, privateKey)

生成 Firebase 的授权令牌

• 参数：
  • userEmail — string — 您要验证的用户的电子邮件帐户
  • optAuthData — object — 与该用户关联的数据密钥对。
  • serviceAccountEmail — string — 用于生成此令牌的服务帐户的电子邮件
  • privateKey — string — 此服务帐户的私钥
• 返回： object — 授予对 firebase 的访问权限的身份验证令牌

createAuthTokenFromServiceAccount(userEmail, optCustomClaims)

生成 Firebase 的授权令牌

• 参数：

  • userEmail — string — - 您要验证的用户的电子邮件帐户

  • optCustomClaims — object — - 与该用户关联的关键数据对（也称为自定义声明）。

• 返回： object — 授予对 firebase 的访问权限的身份验证令牌

createLegacyAuthToken(userEmail, optCustomClaims)

生成 Firebase 的授权令牌

• 参数：
  • userEmail — string — 您要验证的用户的电子邮件帐户
  • optCustomClaims — object — - 与该用户关联的关键数据对（也称为自定义声明）。
• 返回： object — 授予对 firebase 的访问权限的身份验证令牌

getData(path, optQueryParameters)

返回该路径下的数据

• 参数：

  • path — string — - 数据存储的路径

  • [optQueryParameters] — OptQueryParameters — - 一组查询参数

• 返回： object — 在给定路径找到的数据

getAllData(requests)

返回所有指定路径中的数据

• 参数： {Array.<string — FirebaseApp_.request>} requests - 请求数组

• 返回： object — 对每个请求的响应

pushData(path, data, optQueryParameters)

使用唯一键生成新的子位置

• 参数：

  • path — string — - 创建新子项的路径

  • data — object — - 生成位置要写入的数据

  • [optQueryParameters] — OptQueryParameters — - 一组查询参数

• 返回： string — 添加的新数据的子名称

setData(path, data, optQueryParameters)

向指定路径写入数据

• 参数：

  • path — string — - 写入数据的路径

  • data — object — - 指定路径要写入的数据

  • [optQueryParameters] — OptQueryParameters — - 一组查询参数

• 返回： object — 写入的数据

updateData(path, data, optQueryParameters)

更新指定路径的特定子项而不覆盖现有数据

• 参数：

  • path — string — - 更新数据的路径

  • data — object — — 要覆盖的子项

  • [optQueryParameters] — OptQueryParameters — 一组查询参数

• 返回： object — 写入的数据

removeData(path, optQueryParameters)

删除指定路径下的数据

• 参数：

  • path — string — - 删除数据的路径

  • [optQueryParameters] — OptQueryParameters — - 一组查询参数

• 返回： null —

getUrlFromPath(path)

获取指定路径的绝对URL

• 参数： path — string — - 要转换为URL的路径/位置
• 返回： string — 已编码的 URL，可以放入浏览器中

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