FirebaseApp

FirebaseApp

Firebase Realtime Database の Google Apps Script バインディング

インストール

このファイルの内容を Google Apps Script プロジェクトにコピーすることをお勧めします: 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)

ID プロバイダー (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=ja

  • idToken — string — - ScriptApp.getIdentityToken() によって取得された OpenID Connect ID トークン

• 戻り値: 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>} リクエスト - リクエストの配列

• 戻り値: 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

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