Firebase の API キーの使用と管理について学ぶ

API 固有のキーを作成する手順を確認する

以下の手順では、Super Service API という疑似の API 向けに個別の制限付き API キーを作成する方法を説明します。

ステップ 1: 既存の API キーを構成して、Super Service API へのアクセスを許可しないようにする

1. Google Cloud コンソールの [認証情報] ページを開きます。画面の指示に沿って、プロジェクトを選択します。

2. リスト内にある既存の API キーごとに、編集ビューを開きます。

3. [API の制限] セクションで [キーを制限] を選択し、API キーによるアクセスを許可するすべての API をリストに追加します。その場合は、個別の API キー（この場合は Super Service API）を作成する API を含めないでください。

   API キーの API の制限を構成することで、キーがアクセス権を持つ API を明示的に宣言します。デフォルトでは、[API の制限] セクションで [キーを制限しない] が選択されている場合、API キーを使用してプロジェクトで有効になっているすべての API にアクセスできます。

これで、既存の API キーは Super Service API へのアクセスを許可しなくなりますが、各キーは、API の制限リストに追加したすべての API で引き続き機能します。

ステップ 2: Super Service API にアクセスするための新しい API キーを作成して使用する

1. [認証情報] ページに戻ります。Firebase プロジェクトが選択されていることを確認してください。

2. [認証情報を作成] > [API キー] の順にクリックします。新しい API キーをメモし、[キーを制限] をクリックします。

3. [API の制限] セクションで [キーを制限] を選択し、Super Service API のみをリストに追加します。

   この新しい API キーは、Super Service API へのアクセスのみを許可します。

4. 新しい API キーを使用するようにアプリとサービスを構成します。

Firebase サービスの API キーはデフォルトで制限されていますか？

はい。デフォルトでは、Firebase 関連の API で使用するために Firebase によって自動的にプロビジョニングされるすべての API キーに、「API の制限」が自動的に適用されます。この許可リストに登録されている Firebase 関連 API のリストをご覧ください。

この許可リストに追加される API は、Firebase サービスがクライアント コードから呼び出す API で、Firebase プロジェクトまたはアプリの識別に API キーが必要です。Firebase サービスの使用に必要な API のほとんどは、実際には API キーの許可リストに登録する必要はありません。

Firebase は、すべての Firebase のサービスに必要な API を追加するため、API キーの許可リストに、使用していないプロダクトの API が含まれている場合があります。許可リストから API を削除できますが、Firebase と使用している Firebase サービスに必要な API を削除しないように注意してください（各サービス / プロダクトの許可リストに登録する必要がある Firebase 関連 API のリストをご覧ください）。そうしないと、Firebase サービスへの呼び出し時にエラーが発生します。

すべての API キーとその「API の制限」は、Google Cloud コンソールの [API とサービス] > [認証情報] パネルで確認できます。

Firebase がこれらの「API の制限」を適用する方法について、次の点に注意してください。

• 2024 年 5 月より、Firebase によって自動プロビジョニングされるすべての新しい API キーは、Firebase 関連 API のリストに自動的に制限されます。

• 2024 年 5 月、Firebase が以前に自動プロビジョニングした既存および制限なしの API キーはすべて、Firebase 関連 API のリスト、および、プロジェクトで現在有効になっている API に制限されます。

• Firebase が以前に自動プロビジョニングした既存の API キーで、すでに制限されているものは変更されませんでした。

• Firebase によって自動プロビジョニングされなかった既存の API キーは変更されませんでした。

Firebase アプリに関連付けられている API キーを確認するには、どうすればよいですか？

次のいずれかのオプションを使用して、Firebase アプリに関連付けられている API キーを確認できます。

同じ Firebase アプリの 2 つの API キーを Firebase 構成ファイル / オブジェクトに含めることはできますか？

• Firebase Apple アプリ - アプリごとに独自の構成ファイルがあり、リストに含めることのできる API キーは 1 つのみです。

• Firebase Android アプリ - 1 つの Firebase プロジェクト内のすべての Android アプリは同じ構成ファイル内に含まれ、個々のアプリに含めることのできる API キーは 1 つのみです。ただし、この構成ファイルの個々のアプリには異なるキーを含めることができます。

• Firebase ウェブアプリ - 各アプリに独自の構成オブジェクトがあり、含めることのできる API キーは 1 つのみです。

ただし、1 つのアプリで複数の API キーを使用することは可能です。他の API キーにアプリがアクセスできるメカニズム（環境変数など）を提供する必要があります。他の API キーにアクセスするためのメカニズムが、Firebase 構成ファイル / オブジェクト内にリストされている API キーに依存しないようにします。

Firebase では、どの API キーがアプリにマッチングしているかをどうやって認識しますか（Firebase 構成ファイル / オブジェクトなど）？

最初にアプリの Firebase 構成ファイル / オブジェクトを取得するとき、Firebase は、対象のアプリと一致する「アプリケーションの制限」が適用されている既存の API キーがプロジェクト内に含まれているかどうかをチェックします（たとえば Apple アプリのバンドル ID でマッチングします）。

この条件に合致する制限付きキーが見つからない場合、Firebase は構成ファイル / オブジェクト内の iOS key（Apple アプリ）、Android key（Android アプリ）、Browser key（ウェブアプリ）のリストを取得します（これらのキーが存在し、対象のアプリとのマッチングを制限する「アプリケーションの制限」がないと仮定）。

Firebase 構成ファイル / オブジェクトから API キーとフィールドを手動で削除できますか？

はい。構成ファイル / オブジェクトから API キーを手動で削除できます。ただし、API キーにアクセスするための別のメカニズムをアプリに提供する必要があります（環境変数を使用するなど）。そうしないと、Firebase サービスへの呼び出しは失敗します。

Firebase 構成ファイル / オブジェクトを手動で編集し、別の API キーを設定できますか？

はい。構成ファイル / オブジェクトを手動で編集して、別の API キーをアプリに関連付けることができます。

なお、コンソールからアプリの構成ファイル / オブジェクトを再取得すると、Firebase が自動的にそのアプリにマッチングする API キーのリストが必ず含まれます。そのため、必要に応じて手動編集を繰り返さなければならないことに注意してください。

ある Firebase プロジェクトから別の Firebase プロジェクトに API キーを移動できますか？

いいえ。API キーは特定のプロジェクトのみを識別するため、他のプロジェクトに移動することはできません。

Google Cloud　コンソール でリストされている API キーを削除するとどうなりますか？

アプリで使用されている API キーを削除すると、そのアプリからの API 呼び出しは失敗します。その場合、無効な API キーの使用を試みていることを通知するレポート、メール、エラーを受け取ることがあります。

API キーを削除すると、元に戻すことはできません。

Firebase API キーの「API の制限」許可リストに必要な API は何ですか？

Firebase API キーの場合、キーの「API の制限」許可リストに登録する必要がある API は、クライアントが呼び出しとともに API キーを提供することが必要な API のみです。Firebase 関連の API でこの要件が必要なものはほとんどありません。プロジェクトで有効にしている Firebase 関連の API のほとんどは、キーの「API の制限」許可リストに登録する必要はありません。

次の表を使用して、Firebase API キーの「API の制限」許可リストに含める必要がある Firebase 関連の API を確認します。Firebase API キーは Firebase サービスにのみ使用してください。詳しくは、特定のタイプの API には、制限された個別の API キーを作成するをご覧ください。

プロジェクトのすべての API キーは、Google Cloud Console の [API とサービス] > [認証情報] パネルで表示、管理できます。

^{* サードパーティ製ツールで Firebase API キーを使用している場合、または Firebase サービス / プロダクトへの直接 REST アクセスを使用している場合にのみ必要です。}

^{** プロダクトの以前のバージョンの SDK では必須です。最新バージョンの SDK を使用している場合、API をキーの許可リストに登録する必要はありません。}

この API へのリクエストがブロックされていることを示す API_KEY_SERVICE_BLOCKED または Forbidden 403 エラーを修正するにはどうすればよいですか？

API_KEY_SERVICE_BLOCKED エラーまたは次のようなエラーが表示された場合は、このよくある質問のガイダンスに沿って対応してください。

Forbidden: 403 POST https://example-service.googleapis.com/method: Requests to this API example-service.googleapis.com method google.example-service.rest.method are blocked.

アプリが API の呼び出しに使用している API キーに「API の制限」が適用されており、その API がキーの許可リストに含まれていない可能性があります。

• Firebase 関連のサービス / プロダクトの使用時にこのエラーが発生する場合は、使用している API キーの「API の制限」許可リストに必要な API がすべて含まれていることを確認してください。

• Firebase 以外のサービスの使用時にこのエラーが発生する場合は、そのサービスと API 専用の新しい API キーを作成することを強くおすすめします。Firebase API キーは、Firebase のサービス / プロダクトにのみ使用してください。 詳しくは、特定のタイプの API には、制限付きの個別の API キーを作成するをご覧ください。

このエラーを修正するにはどうすればよいですか？「サーバーからこの Firebase アプリの測定 ID を取得できませんでした」

ウェブアプリで使用されている API キーに「API の制限」が適用されている可能性があります。その場合は、許可される API のリストに Firebase Management API が含まれていることを確認してください。

API キーが無効であることを知らせるメールが届いたか、またはエラーが表示されました。何が起こったのでしょうか。どうすればよいですか？

無効な API キーの一般的な原因のいくつかを以下に示します。

• API キーに「API キーの制限」が適用されていて、キーの使用を試みているアプリとマッチングされない（「アプリケーションの制限」）、または呼び出そうとしている API を使用できない（「API の制限」）ようになっています。

• Google CloudConsole で API キーがプロジェクトから削除されました。

• アプリの Firebase 構成ファイル / オブジェクトにリストされているプロジェクト ID の API キーが作成されていません。

この問題の解決策の一つとして、アプリの Firebase 構成ファイル / オブジェクトの更新されたバージョンを取得し、古い構成ファイル / オブジェクトと置き換えるという方法があります。構成ファイルをダウンロード用に送信したり、コンソールで構成オブジェクトを表示したりする前に、Firebase は、リスト内にある API キーがアプリにマッチングしていることを確認します。