Places Insights API で API キーを使用する

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

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

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 SDK、Cloud SDK のインストール、および以下のコマンドをご覧ください。

API キーの制限

アプリケーションに必要な API しか使用しないよう、API キーの使用に制限をかけておくことを強くおすすめします。API キーに制限をかけることにより、不正なリクエストからアプリケーションを守り、セキュリティを強化できます。詳しくは、API の保護に関するベスト プラクティスをご覧ください。

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

コンソール

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

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

  2. 制限を設定する API キーを選択します。選択した API キーのプロパティ ページが表示されます。
  3. [キーの制限] で、次の制限を設定します。
    • アプリケーションの制限:
      1. 指定したウェブサーバー IP アドレスのリストからのリクエストを受け入れるには、 IP アドレス（ウェブサーバー、cron ジョブなど）のリスト アプリケーションの制限。IPv4 または IPv6 アドレスを 1 つ以上指定します。 CIDR 表記を使ってサブネットを指定します。この IP アドレスは、ネットワーク トラフィックに Google Maps Platform サーバーが監視します。以下をご使用の場合: ネットワーク アドレス変換（NAT）、 これは通常、マシンのパブリック IP アドレスに対応します。
    • API の制限:
      1. [キーを制限] をクリックします。
      2. [API を選択] プルダウンから [Places Insights API] を選択します。 Places Insights 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="areainsights.googleapis.com"
    --allowed-ips="IP_ADDRESS"

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

リクエストに API キーを追加する

すべての Places Insights API リクエストに API キーを含める必要があります。以下の例では、 YOUR_API_KEY は実際の API キーに置き換えます。

https://areainsights.googleapis.com/v1:computeInsights?key=YOUR_API_KEY

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