API キーを使用する

Google Maps Platform サービスは、API 呼び出しを、適切な認証情報を提供しているもののみに制限することで、不正使用を防止しています。これらの認証情報は API キーの形式になります。API キーとは、Google の請求先アカウントをプロジェクトや特定の API、SDK に関連付ける一意の英数字文字列です。

このガイドでは、Google Maps Platform 用の API キーを作成、制限、使用する方法について説明します。

始める前に

Maps JavaScript API のご利用にあたっては、請求先アカウントと Maps JavaScript API が有効なプロジェクトが必要です。詳しくは、Cloud Console での設定をご覧ください。

API キーを作成する

API キーは、使用量を正確に集計して課金するため、プロジェクトに関連付けられたリクエストであることを認証する一意の識別子です。少なくとも 1 つの API キーをプロジェクトに関連付ける必要があります。

API キーを作成するには:

コンソール

  1. [Google Maps Platform] > [認証情報] ページに移動します。

    [認証情報] ページに移動

  2. [認証情報] ページで、[認証情報を作成] > [API キー] をクリックします。
    [API キーを作成しました] ダイアログで、新しく作成された API キーが表示されます。
  3. [閉じる] をクリックします。
    新しい API キーは、[認証情報] ページの [API キー] に一覧で表示されます。
    (本番環境で使用する前に必ず API キーを制限するようにしてください)

Cloud SDK

gcloud alpha services api-keys create \
    --project "PROJECT" \
    --display-name "DISPLAY_NAME"

詳しくは、Google Cloud SDKCloud SDK のインストール、および以下のコマンドをご覧ください。

API キーの制限

許可したリクエストにのみ API キーを使用するよう制限することで、アプリケーションのセキュリティが向上します。以下の手順に沿って API キーの制限を設定することを強くおすすめします。詳しくは、API セキュリティに関するベスト プラクティスをご覧ください。

API キーを制限する手順は次のとおりです。

コンソール

  1. [Google Maps Platform] > [認証情報] ページに移動します。

    [認証情報] ページに移動

  2. 制限を設定する API キーを選択します。選択した API キーのプロパティ ページが表示されます。
  3. [キーの制限] で、次の制限を設定します。
    • アプリケーションの制限:
      1. 指定したウェブサイトからのリクエストを受け入れるには、[アプリケーションの制限] のリストで [HTTP リファラー(ウェブサイト)] を選択します。
      2. 参照元のウェブサイトを 1 つ以上指定します。たとえば、*.google.com の場合は、google.com で終わるすべてのサイト(https://developers.google.com など)を受け入れます。

        注: 参照元が file:// の場合、キーの制限へ追加するには特殊な表現が必要です。「file://」の部分を「__file_url__」に置き換えてから、キーの制限に追加してください。たとえば、「file:///path/to/」は「__file_url__//path/to/*」になります。file:// 参照元を有効にしたら、使用量を定期的にチェックして、適切に運用されているか確認することをおすすめします。

    • API の制限:
      1. [キーを制限] をクリックします。
      2. [API を選択] プルダウンから [Maps JavaScript API] を選択します。 Maps JavaScript API がリストに表示されない場合は、この API を有効にする必要があります)。
      3. プロジェクトでプレイス ライブラリを使用する場合は、[Places API] も選択します。同様に、プロジェクトで JavaScript API の他のサービス(Directions サービスDistance Matrix サービスElevation サービスGeocoding サービスなど)を使用する場合は、このリストで該当する API を有効にして、選択する必要があります。
  4. 変更が完了したら、[保存] をクリックします。

Cloud SDK

既存のキーを一覧表示します。

gcloud services api-keys list --project="PROJECT"

既存のキーに対する既存の制限を削除します。

gcloud alpha services api-keys update "projects/PROJECT/keys/KEY_ID" \
    --clear-restrictions

既存のキーに新しい制限を設定します。

gcloud alpha services api-keys update "projects/PROJECT/keys/KEY_ID" \
    --api_target="maps-backend.googleapis.com"
    --allowed-referrers="REFERRER

詳しくは、Google Cloud SDKCloud SDK のインストール、および以下のコマンドをご覧ください。

リクエストへの API キーの追加

すべての Maps JavaScript API リクエストに API キーを追加する必要があります。次の例では、YOUR_API_KEY を API キーに置き換えます。

  <script async defer src="https://maps.googleapis.com/maps/api/js?key=YOUR_API_KEY&callback=initMap"></script>

API キーを使用するリクエストには HTTPS が必要です。