Вы можете установить (и управлять ) любым из официальных расширений Firebase, используя либо консоль Firebase, либо Firebase CLI (интерфейс командной строки).
Обязательно ознакомьтесь с различиями в поддерживаемых действиях для Firebase CLI и консоли Firebase.
Чтобы устанавливать расширения или управлять ими, вам должна быть назначена одна из следующих ролей: владелец, редактор или администратор Firebase .
Чтобы установить расширение, ваш проект должен быть включен в план Blaze (pay as you go). Хотя за установку расширения плата не взимается, с вас может взиматься плата за использование служб Firebase или облачных служб, таких как Cloud Secret Manager , если ваше использование превышает уровень бесплатного пользования службами.
Прежде чем вы начнете
Если вы еще этого не сделали, добавьте Firebase в свой проект .
Если вы еще этого не сделали, обновите свой проект до плана Blaze (pay as you go).
Обратите внимание на идентификатор вашего проекта Firebase или ранее настроенный псевдоним проекта.
- Идентификатор проекта — запускайте
firebase projects:list
из любого места на вашем компьютере. - Псевдоним проекта — запустите
firebase use
из вашего локального каталога приложений.
- Идентификатор проекта — запускайте
Шаг 1. Просмотрите подробную информацию о расширении.
Этот шаг необязателен, но настоятельно рекомендуется.
Перед установкой расширения Firebase рекомендуется ознакомиться с подробной информацией о расширении, в том числе:
- Как работает расширение, любые задачи перед установкой и подробности о расширении
- Общая идентифицирующая информация и описание
- Требуется ли для задач расширения учетная запись для выставления счетов
- Сервисы Google (API) и роли доступа, необходимые для работы
- Ресурсы , созданные для расширения (например, функции)
- Описание настраиваемых пользователем параметров
Чтобы просмотреть подробную информацию о расширении:
Убедитесь, что вы настроили свою среду и выбрали расширение .
Запустите команду extension-info из любого места на вашем компьютере:
firebase ext:info publisher-id/extension-id
Аргументы
publisher-id
иextension-id
являются обязательными, и их можно найти на странице сведений о предварительной установке расширения .
Шаг 2 : Установите расширение
В процессе установки вам будет предложено просмотреть основные характеристики расширения (например, включенные API, созданные ресурсы , предоставленный доступ и т. д.). Вы будете уведомлены о любых требованиях к выставлению счетов, а также вам будет предложено указать значения для настраиваемых параметров расширения.
Убедитесь, что вы настроили свою среду и выбрали расширение .
В локальном каталоге Firebase запустите команду extension-install. При появлении запроса введите значения параметров, чтобы настроить экземпляр расширения.
firebase ext:install publisher-id/extension-id --project=projectId-or-alias
Аргументы
publisher-id
иextension-id
являются обязательными, и их можно найти на странице сведений о предварительной установке расширения .Выполнение этой команды добавляет экземпляр расширения в ваш манифест расширений .
Затем, чтобы развернуть расширения в вашем манифесте в проекте Firebase, запустите:
firebase deploy --only extensions --project=projectId-or-alias
Шаг 3. Завершите настройку после установки.
Некоторые расширения имеют обязательные или необязательные шаги, которые необходимо выполнить перед их использованием. Найдите эти инструкции на странице сведений о вашем расширении после установки на панели инструментов Extensions консоли Firebase (конкретная ссылка на панель инструментов отображается в терминале после установки).
Вы также можете найти эти инструкции в файле POSTINSTALL.md
, включенном в исходный каталог расширения .
Создать ресурсы Firebase
Если вы настроили расширение для использования ресурсов Firebase (коллекции Cloud Firestore, пути к базе данных в реальном времени, сегменты облачного хранилища), которые еще не существуют, создайте их перед использованием расширения.
Создание обработчиков событий Eventarc
Некоторые расширения публикуются в Eventarc , когда во время выполнения происходят важные события. Если расширение публикует события, и вы включили события во время установки, вы можете написать функции, которые реагируют на эти события с помощью собственной пользовательской логики. Это может быть полезно, например, для уведомления пользователей о завершении длительных задач или для постобработки вывода функции расширения.
См. документацию расширения для списка событий (если таковые имеются), которые оно публикует. Например, см. типы событий для расширения Run Payments with Stripe .
Затем см. Пользовательские триггеры событий для получения информации о написании обработчиков событий Eventarc.
Установите несколько экземпляров расширения
Вы можете установить одно и то же расширение несколько раз в одном проекте. Каждый установленный экземпляр может иметь собственную настроенную конфигурацию и собственные ресурсы расширения. Вы идентифицируете и ссылаетесь на каждый установленный экземпляр, используя его идентификатор экземпляра , который уникален в рамках вашего проекта. Вам будет предложено подтвердить или изменить идентификатор экземпляра каждого дополнительного экземпляра устанавливаемого вами расширения.
Следующие шаги
Просмотрите сведения и конфигурацию установленного расширения в консоли Firebase.
Отслеживайте активность установленного расширения, в том числе проверяйте его работоспособность, использование и журналы.
Используя интерфейс командной строки Firebase, управляйте установленным расширением. Вы можете перенастроить или удалить расширение, а также обновить его до последней версии.
Используя консоль Firebase, управляйте установленным расширением. Для официальных расширений Firebase вы можете перенастроить или удалить расширение, а также обновить расширение до последней версии.
В качестве наилучшей практики для всех проектов обязательно настройте оповещения о бюджете для своего проекта и следите за панелью управления использованием и выставлением счетов в консоли Firebase.