API キーの概要

API キーは、Google Cloud API を呼び出すときに使用できる暗号化された単純な文字列です。API キーの一般的な用途は、次の形式でクエリ パラメータとして REST API 呼び出しにキーを渡すことです。

http://example-library.googleapis.com/v1/publishers/mypublisher/books?key=API_KEY
API キーは、一般公開データに匿名でアクセスする場合に便利で、割り当て課金のために API リクエストをコンシューマー Google Cloud プロジェクトに関連付けるために使用されます。

API Keys は、プロジェクトの API キーを作成して管理するためのプログラマティック インターフェースを提供します。これにより、 Google Cloud コンソールで実行できる API キー関連のタスクよりも、API キーをより詳細に制御できます。

Google Cloud API に対する認証の詳細と、一般的なシナリオに最適な認証を決定する方法については、認証の概要をご覧ください。 Google Maps Platform API と SDK での API キーの使用に関する詳細については、Google Maps Platform のドキュメントをご覧ください。

API キーを保護する

アプリケーションで API キーを使用する場合は、保存時と転送時の両方でキーの安全確保に努めてください。 認証情報が公開されると、アカウントが侵害され、アカウントに対して予想外の料金が課される可能性があります。 API キーの安全性を保つには、以下のベスト プラクティスに従ってください。

  • API キーをコードに直接埋め込まないでください。コードに埋め込まれた API キーは、誤って公開されてしまう可能性があります。たとえば、共有するコードからキーを削除し忘れた場合などです。API キーはアプリケーションに埋め込む代わりに、アプリケーションのソースツリー外部にある環境変数やファイル内に保存します。

  • API キーに制限を追加します。制限を追加することで、API キーが不正使用された場合の影響を軽減できます。

  • 不要な API キーを削除して、攻撃を受けるリスクを最小限に抑えます。

  • API キーを定期的にローテーションします。API キーをローテーションするには、CreateKey メソッドを呼び出します。置換キーを作成したら、新たに生成したキーを使用するようにアプリケーションを更新し、古いキーを削除します。

  • 公開する前に、コードを確認します。コードを公開する前に、コードに API キーやその他のプライベート情報が含まれていないことを確認してください。

次のステップ