Firebase コンソールまたはFirebase CLI (コマンドライン インターフェース) を使用して、公式の Firebase 拡張機能をインストール (および管理) できます。
Firebase CLI と Firebase コンソールでサポートされているアクションの違いを確認してください。
拡張機能をインストールまたは管理するには、所有者、編集者、またはFirebase 管理者 のいずれかの役割が割り当てられている必要があります。
拡張機能をインストールするには、プロジェクトがBlaze (従量課金制) プランである必要があります。拡張機能のインストールは無料ですが、使用量がサービスの無料利用枠を超えた場合、Firebase サービスまたはCloud Secret Managerなどのクラウド サービスの使用に対して課金される場合があります。
あなたが始める前に
Firebase をプロジェクトにまだ追加していない場合は追加します。
まだお持ちでない場合は、プロジェクトをBlaze (従量課金制) プランにアップグレードしてください。
Firebase プロジェクト ID または以前に構成したプロジェクト エイリアスのいずれかをメモします。
- プロジェクト ID — コンピューターのどこからでも
firebase projects:listを実行します。 - プロジェクト エイリアス— ローカル アプリ ディレクトリから
firebase useを実行します。
- プロジェクト ID — コンピューターのどこからでも
ステップ 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 : インストール後のセットアップを完了する
一部の拡張機能には、使用する前に完了する必要がある、またはオプションの手順があります。これらの手順は、Firebase コンソールの拡張機能ダッシュボードにある拡張機能のインストール後の詳細ページで確認できます (ダッシュボードへの特定のリンクは、インストール後にターミナルに表示されます)。
これらの手順は、拡張機能のソース ディレクトリに含まれるPOSTINSTALL.mdファイルにも記載されています。
Firebase リソースを作成する
まだ存在しない Firebase リソース（Cloud Firestore コレクション、Realtime Database パス、Cloud Storage バケット）を使用するように拡張機能を構成した場合は、拡張機能を使用する前にそれらを作成します。
Eventarc イベント ハンドラーを作成する
一部の拡張機能は、実行中に重要なイベントが発生したときにEventarcに公開されます。拡張機能がイベントを発行し、インストール中にイベントを有効にした場合、独自のカスタム ロジックでこれらのイベントに反応する関数を作成できます。これは、たとえば、実行時間の長いタスクが完了したときにユーザーに通知したり、拡張関数の出力を後処理したりするのに役立ちます。
拡張機能が公開するイベント (存在する場合) のリストについては、拡張機能のドキュメントを参照してください。
次に、Eventarc イベント ハンドラーの作成に関する情報について、カスタム イベント トリガーを参照してください。
複数の拡張インスタンスをインストールする
同じプロジェクトに同じ拡張機能を複数回インストールできます。インストールされた各インスタンスは、独自のカスタマイズされた構成と独自の拡張リソースを持つことができます。プロジェクト内で一意のインスタンス IDを使用して、インストールされた各インスタンスを識別し、参照します。インストールする拡張機能の各追加インスタンスのインスタンス ID を確認または編集するよう求められます。
次のステップ
Firebase コンソールで、インストールされている拡張機能の詳細と構成を表示します。
正常性、使用状況、ログのチェックなど、インストールされた拡張機能のアクティビティを監視します。
Firebase CLI を使用して、インストール済みの拡張機能を管理します。拡張機能を再構成またはアンインストールしたり、拡張機能を最新バージョンに更新したりできます。
Firebase コンソールを使用して、インストール済みの拡張機能を管理します。公式の Firebase 拡張機能については、拡張機能を再構成またはアンインストールしたり、拡張機能を最新バージョンに更新したりできます。
すべてのプロジェクトのベスト プラクティスとして、プロジェクトの予算アラートを設定し、Firebase コンソールで使用状況と請求のダッシュボードを監視してください。
Firebase コンソールまたはFirebase CLI (コマンドライン インターフェース) を使用して、公式の Firebase 拡張機能をインストール (および管理) できます。
Firebase CLI と Firebase コンソールでサポートされているアクションの違いを確認してください。
拡張機能をインストールまたは管理するには、所有者、編集者、またはFirebase 管理者 のいずれかの役割が割り当てられている必要があります。
拡張機能をインストールするには、プロジェクトがBlaze (従量課金制) プランである必要があります。拡張機能のインストールは無料ですが、使用量がサービスの無料利用枠を超えた場合、Firebase サービスまたはCloud Secret Managerなどのクラウド サービスの使用に対して課金される場合があります。
あなたが始める前に
Firebase をプロジェクトにまだ追加していない場合は追加します。
まだお持ちでない場合は、プロジェクトをBlaze (従量課金制) プランにアップグレードしてください。
Firebase プロジェクト ID または以前に構成したプロジェクト エイリアスのいずれかをメモします。
- プロジェクト ID — コンピューターのどこからでも
firebase projects:listを実行します。 - プロジェクト エイリアス— ローカル アプリ ディレクトリから
firebase useを実行します。
- プロジェクト ID — コンピューターのどこからでも
ステップ 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 : インストール後のセットアップを完了する
一部の拡張機能には、使用する前に完了する必要がある、またはオプションの手順があります。これらの手順は、Firebase コンソールの拡張機能ダッシュボードにある拡張機能のインストール後の詳細ページで確認できます (ダッシュボードへの特定のリンクは、インストール後にターミナルに表示されます)。
これらの手順は、拡張機能のソース ディレクトリに含まれるPOSTINSTALL.mdファイルにも記載されています。
Firebase リソースを作成する
まだ存在しない Firebase リソース（Cloud Firestore コレクション、Realtime Database パス、Cloud Storage バケット）を使用するように拡張機能を構成した場合は、拡張機能を使用する前にそれらを作成します。
Eventarc イベント ハンドラーを作成する
一部の拡張機能は、実行中に重要なイベントが発生したときにEventarcに公開されます。拡張機能がイベントを発行し、インストール中にイベントを有効にした場合、独自のカスタム ロジックでこれらのイベントに反応する関数を作成できます。これは、たとえば、実行時間の長いタスクが完了したときにユーザーに通知したり、拡張関数の出力を後処理したりするのに役立ちます。
拡張機能が公開するイベント (存在する場合) のリストについては、拡張機能のドキュメントを参照してください。
次に、Eventarc イベント ハンドラーの作成に関する情報について、カスタム イベント トリガーを参照してください。
複数の拡張インスタンスをインストールする
同じプロジェクトに同じ拡張機能を複数回インストールできます。インストールされた各インスタンスは、独自のカスタマイズされた構成と独自の拡張リソースを持つことができます。プロジェクト内で一意のインスタンス IDを使用して、インストールされた各インスタンスを識別し、参照します。インストールする拡張機能の各追加インスタンスのインスタンス ID を確認または編集するよう求められます。
次のステップ
Firebase コンソールで、インストールされている拡張機能の詳細と構成を表示します。
正常性、使用状況、ログのチェックなど、インストールされた拡張機能のアクティビティを監視します。
Firebase CLI を使用して、インストール済みの拡張機能を管理します。拡張機能を再構成またはアンインストールしたり、拡張機能を最新バージョンに更新したりできます。
Firebase コンソールを使用して、インストール済みの拡張機能を管理します。公式の Firebase 拡張機能については、拡張機能を再構成またはアンインストールしたり、拡張機能を最新バージョンに更新したりできます。
すべてのプロジェクトのベスト プラクティスとして、プロジェクトの予算アラートを設定し、Firebase コンソールで使用状況と請求のダッシュボードを監視してください。