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