Google は、黒人コミュニティのための人種的公平の促進に取り組んでいます。詳細をご覧ください。

Firebase Extension のインストール

Firebase コンソールまたは Firebase CLI(コマンドライン インターフェース)を使用して、公式 Firebase Extensions をインストール(および管理)できます。

Firebase CLI と Firebase コンソールでサポートされるアクションの違いを確認してください。


拡張機能のインストールや管理を行うには、オーナーまたは編集者、あるいは Firebase 管理者のいずれかのロールが割り当てられている必要があります。

また、拡張機能をインストールするには、プロジェクトが Blaze(従量課金制)プランを利用している必要があります。使用量に関連する請求に加えて、この拡張機能が必要とする Firebase リソースに対して(使用しない場合でも)少額(通常は約 $0.01/月)が請求されます。

始める前に

  1. まだ追加していない場合は、Firebase をプロジェクトに追加します。

  2. まだアップグレードしていない場合は、プロジェクトを Blaze(従量課金制)プランにアップグレードします。

  3. Firebase CLI の最新バージョンをインストールするか、最新バージョンに更新します。

  4. Firebase プロジェクト ID または構成済みのプロジェクトのエイリアスをメモします。

ステップ 1: 拡張機能の詳細情報を表示する

この手順は省略可能ですが、行うことを強くおすすめします。

Firebase Extension をインストールする前に、次のような拡張機能の詳細情報を確認することをおすすめします。

  • 拡張機能の仕組み、プリインストール タスク、拡張機能の詳細
  • 一般的な識別情報と説明
  • 拡張機能のタスクに請求先アカウントが必要かどうか
  • 動作に必要な Google サービス(API)とアクセスロール
  • 拡張機能用に作成されたリソース(関数など)
  • ユーザー構成可能なパラメータの説明

拡張機能の詳細情報を表示するには:

  1. 環境を設定し、拡張機能を選択していることを確認します。

  2. パソコンの任意の場所から、extension-info コマンドを実行します。

    firebase ext:info extension-name

    extension-name は必須で、拡張機能の詳細ページまたは拡張機能の extension.yaml ファイルname フィールドで確認できます。

ステップ 2: 拡張機能をインストールする

インストール中に、拡張機能の基本仕様(有効になる API、作成されるリソース、付与されるアクセス権など)を確認するよう求められます。課金の要件があれば、通知されます。また、拡張機能の構成可能なパラメータの値を指定するよう求められます。

  1. 環境を設定し、拡張機能を選択していることを確認します。

  2. 拡張機能インストール コマンドを実行します。プロンプトが表示されたら、パラメータ値を入力して拡張機能のインスタンスをカスタマイズします。

    firebase ext:install extension-name --project=projectId-or-alias

    extension-name 引数は必須で、拡張機能のプリインストールの詳細ページまたは拡張機能の extension.yaml ファイルname フィールドで確認できます。

  3. インストールが完了したら、拡張機能の使用手順を確認します。これには、インストール後に必要な作業が含まれている場合があります。

    • この手順は、Firebase コンソールの Extensions ダッシュボードに表示されるインストール後の詳細ページで確認できます(ダッシュボードへのリンクは、インストールの後、ターミナルに表示されます)。

      この手順は、拡張機能のソース ディレクトリにある POSTINSTALL.md ファイルでも確認できます。

    • 必要な場合、手順で拡張機能のテスト方法が示されます([実際に使ってみる] を探してください)。

次のステップ

  • Firebase コンソールで、インストールした拡張機能の詳細と構成を表示する。

  • インストールした拡張機能のアクティビティをモニタリングする。これには、拡張機能の健全性、使用状況、ログの確認が含まれます。

  • Firebase CLI を使用して、インストールした拡張機能を管理する。拡張機能の再構成、アンインストール、最新バージョンへの更新ができます。

  • Firebase コンソールを使用して、インストールした拡張機能を管理する。公式 Firebase Extensions の場合は、拡張機能の再構成、アンインストール、最新バージョンへの更新ができます。

  • すべてのプロジェクトのベスト プラクティスとして、プロジェクトの予算アラートを設定し、Firebase コンソールで使用量と請求ダッシュボードをモニタリングする。