FirebaseApp

FirebaseApp

Привязка сценария Google Apps для базы данных Firebase Realtime.

Установить

Лучше всего скопировать содержимое этого файла в свой проект Google Apps Script: https://github.com/RomainVialard/FirebaseApp/blob/master/src/Code.gs

Вы также можете добавить его как библиотеку, хотя это не рекомендуется.
https://developers.google.com/apps-script/guides/libraries
Идентификатор сценария библиотеки: 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)

Возвращает декодированную строку из ключа Firebase, закодированную с помощью encodeAsFirebaseKey().

• Параметры: string — string — — закодированный ключ Firebase.

• Возвращает: string — декодированная строка

signInWithIdp(firebaseConfig, idToken)

Вход или регистрация пользователя с использованием учетных данных поставщика удостоверений (IdP), например: google.com. https://cloud.google.com/identity-platform/docs/reference/rest/v1/accounts/signInWithIdp

• Параметры:

  • firebaseConfig — object — см. раздел «Получить объект конфигурации для вашего веб-приложения» на странице, указанной ниже.

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

  • idToken — string — токен идентификации OpenID Connect, полученный через ScriptApp.getIdentityToken().

• Возвращает: 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 — a — набор параметров запроса

• Возвращает: 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