Firebase Extensions のインストール

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

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

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

拡張機能をインストールするには、プロジェクトが Blaze（従量課金制）プランを利用している必要があります。拡張機能のインストールは無料ですが、Firebase サービス、または [Cloud Secret Manager][secret-pricing] などのクラウドサービスの使用に対して、使用量がサービスの無料枠を超えた場合に請求されることがあります。

始める前に

まだ追加していない場合は、Firebase をプロジェクトに追加します。
まだアップグレードしていない場合は、プロジェクトを Blaze（従量課金制）プランにアップグレードします。
Firebase CLI の最新バージョンをインストールするか、最新バージョンに更新します。
Firebase プロジェクト ID または構成済みのプロジェクトのエイリアスをメモします。
- プロジェクト ID - パソコンの任意の場所から firebase projects:list を実行します。
- プロジェクトエイリアス - ローカルアプリディレクトリから firebase use を実行します。
注: CLI コマンドを使用して拡張機能のインストールと管理を行うには、--project フラグを使用し、プロジェクト ID またはプロジェクトエイリアスを渡します。ただし、ローカルアプリディレクトリに Firebase プロジェクトがすでに関連付けられている場合は、ローカルアプリディレクトリからコマンドを実行するときに --project フラグを渡す必要はありません。

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

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

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

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

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

環境を設定し、拡張機能を選択していることを確認します。
パソコンの任意の場所から、extension-info コマンドを実行します。
```
firebase ext:info publisher-id/extension-id
```
publisher-id 引数と extension-id 引数は必須で、拡張機能のプリインストールの詳細ページで確認できます。

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

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

環境を設定し、拡張機能を選択していることを確認します。
拡張機能インストールコマンドを実行します。プロンプトが表示されたら、パラメータ値を入力して拡張機能のインスタンスをカスタマイズします。
```
firebase ext:install publisher-id/extension-id --project=projectId-or-alias
```
publisher-id 引数と extension-id 引数は必須で、拡張機能のプリインストールの詳細ページで確認できます。

注: 拡張機能のインストールとプロビジョニングには 3～5 分かかることがあります。
インストール中に表示されるパラメータ値のインタラクティブなターミナルプロンプトをバイパスする方法
1. パラメータ値を定義する .env ファイル（params.env など）を作成します。ファイルをローカルに保存します。
  - 各パラメータを拡張機能の extension.yaml ファイルの param 値で宣言します。
  - すべてのパラメータの値を含めます。
  - dotenv 構文に従います。
  たとえば、Translate Text 拡張機能の場合、次のような .env ファイルを作成できます。
```
# params.env

LOCATION=us-east1
LANGUAGES=fr,es
COLLECTION_PATH=translations
INPUT_FIELD_NAME=input
OUTPUT_FIELD_NAME=output
```
2. --params フラグを指定して拡張機能インストールコマンドを実行します。たとえば、Translate Text 拡張機能をインストールするには、次のコマンドを実行します。
```
firebase ext:install firebase/firestore-translate-text --params=path/to/params.env --project=projectID-or-alias
```

ステップ 3: インストール後の設定を完了する

拡張機能によっては、使用する前に行っておかなければならない必須の手順があるものや、オプションの手順があるものがあります。それらの手順は、Firebase コンソールの Extensions ダッシュボードに表示されるインストール後の詳細ページで確認できます（インストール後、ターミナルにダッシュボードへのリンクが表示されます）。

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

Firebase リソースを作成する

Firebase リソース（Cloud Firestore コレクション、Realtime Database パス、Cloud Storage バケット）を使用するように拡張機能が構成されていて、それらのリソースがまだ存在しない場合は、拡張機能を使用する前にそれらを作成してください。

Eventarc イベントハンドラを作成する

拡張機能の中には、実行中に重要なイベントが発生すると Eventarc に公開されるものがあります。拡張機能がイベントを公開するものであり、インストール時にイベントを有効にした場合、独自のカスタムロジックを使用してこれらのイベントに応答する関数を作成できます。これは、たとえば、長時間実行タスクが完了したときにユーザーに通知する場合や、拡張機能の出力を後処理する場合に役立ちます。

公開するイベント（ある場合）のリストについては、拡張機能のドキュメントをご覧ください。

Eventarc イベントハンドラの詳細については、カスタムイベントトリガーをご覧ください。

複数の拡張機能インスタンスをインストールする

同じプロジェクトに同じ拡張機能を複数回インストールできます。インストールされたインスタンスごとに、カスタマイズされた独自の設定と独自の拡張機能リソースを設定できます。インストールされた各インスタンスは、プロジェクト内で一意のインスタンス ID を使用して識別し、参照します。拡張機能のインスタンスを追加でインストールするたびに、インスタンス ID を確認または編集するよう求められます。

次のステップ

Firebase コンソールで、インストールした拡張機能の詳細と構成を表示する。
インストールした拡張機能のアクティビティをモニタリングする。これには、拡張機能の健全性、使用状況、ログの確認が含まれます。
Firebase CLI を使用して、インストールした拡張機能を管理する。拡張機能の再構成、アンインストール、最新バージョンへの更新ができます。
Firebase コンソールを使用して、インストールした拡張機能を管理する。Firebase Extensions の公式拡張機能の場合は、拡張機能の再構成、アンインストール、最新バージョンへの更新ができます。
すべてのプロジェクトのベストプラクティスとして、プロジェクトの予算アラートを設定し、Firebase コンソールで[使用量と請求額] ダッシュボードをモニタリングする。