クライアント ID 移行ガイド

概要

認証のセキュリティと信頼性を高めるため、Maps Platform クライアント ID は 2025 年 5 月 26 日に非推奨となり、2026 年 5 月 31 日以降は使用できなくなります。

クライアント ID を使用する代わりに、API キーの認証情報を使用して Google Maps API サービス トラフィックを認証する必要があります。このガイドでは、クライアント ID の使用から API キーの使用に移行する方法について説明します。

方法は次のとおりです。

  1. 現在のクライアント ID の使用状況を確認する
  2. API キーを準備する
  3. 割り当て設定を確認する
  4. コードを更新する
  5. クライアント ID のトラフィックをモニタリングする
  6. クライアント ID を一時停止する

現在のクライアント ID の使用状況を確認する

移行プロセスを開始する前に、次の項目をリストします。

  • クライアント ID で使用している Maps Platform サービス。
  • クライアント ID を使用しているアプリケーション、サイト、システム。

Google は、2025 年 5 月にクライアント ID の非推奨化について、影響を受けるお客様に通知メールを送信しました。この情報は通知メールにも記載されています。

Cloud コンソールで、Google Maps の [指標] ページでクライアント ID の使用状況の最新のステータスを確認できます。

Maps Platform サービスの一覧:

  1. Cloud Console で [指標] ページを開きます。
  2. 次の設定で使用状況をフィルタします。
    • 認証情報: 「project_number:<数値識別子>」のみを選択します。
  3. 次のフィルタを設定します。
    • グループ条件: API

アプリケーション、サイト、システムのヒントの場合:

Cloud Console にアプリケーション、サイト、システムの詳細は表示されません。ただし、クライアント ID トラフィックのソースのヒントは確認できます。手順は次のとおりです。

  1. Cloud Console で [指標] ページを開きます。
  2. プルダウンから Maps Platform サービスを選択します。
  3. 次の設定で使用状況をフィルタします。
    • 認証情報: 「project_number:<数値識別子>」のみを選択します。
  4. 次のフィルタを設定します。
    • グループ条件: プラットフォーム、またはドメイン
  5. トラフィックを確認する必要がある Maps Platform サービスごとに、ステップ 2 から繰り返します。

API キーを準備する

すべてのクライアント ID は Google Cloud プロジェクトに関連付けられています。そのプロジェクトの API キーを使用すると、以前にクライアント ID でアクセスしたのと同じ機能にアクセスできます。割り当ての問題や機能の欠落を回避するため、関連付けられたプロジェクトに移行することをおすすめします。

  1. クライアント ID がリンクされている Cloud プロジェクトを見つけます。
  2. Cloud プロジェクトが有効な請求先アカウントにリンクされていることを確認します。
  3. クライアント ID の移行用に新しい API キーを作成します。
    • Cloud プロジェクトで既存の API キーを再利用できます。
    • 同じ Cloud プロジェクトから複数の API キーを使用できます。たとえば、各 Maps Platform サービスのトラフィックを分離したり、異なるプラットフォーム(ブラウザ、モバイルアプリなど)からのトラフィックを分離したりする場合に使用します。API キーの管理に関するベスト プラクティスについては、セキュリティ ガイドをご覧ください。

API キーを保護する

API キーを安全に保護して、不正アクセスからキーを保護してください。

  • API キーのアプリケーション制限(ウェブサイト、IP アドレス、Android アプリ、iOS アプリなど)を設定します。
  • API キーの API 制限を設定します。

詳しくは、Google Maps Platform のセキュリティに関するガイダンスをご覧ください。

Maps JavaScript API、Maps Static API、Street View Static API の場合、クライアント ID の信頼できるリファラーを API キーの制限に移行できます。信頼できるリファラーのリストは Cloud Console で確認できます。

割り当て設定を確認する

Cloud プロジェクトに想定どおりの割り当て設定があることを確認します。この操作が必要なのは、クライアント ID から Maps JavaScript API クライアントサイド サービスを呼び出す場合のみです。割り当ての設定は、Google Maps の割り当てページで確認および調整できます。

割り当てレポートの詳細

Maps JavaScript API クライアントサイド サービスの割り当ての増加

Maps JavaScript API で次のサービスを使用している場合、API キーの移行後に割り当ての使用量が増加します。

現在の割り当て構成と現在の使用量を確認し、割り当て上限を適宜調整します。

  1. クライアント ID を使用して Maps JavaScript API クライアントサイド サービスを使用しているかどうかを確認します。
    • Cloud Console で [指標] ページを開きます。
    • 次の設定で使用状況をフィルタします。
      • グループ条件: API メソッド
      • 認証情報: 「project_number:<数値識別子>」のみを選択します。
    • [API メソッド別のトラフィック] グラフに、メソッド名とそのトラフィックのリストが表示されます。

API メソッド

クライアントサイド サービス

割り当てを調整するサービス

google.routes.Directions.Javascript

ルートサービス

Directions API

google.routes.DistanceMatrix.Javascript

距離行列サービス

Distance Matrix API

google.maps.Elevation.Javascript

高度サービス

Elevation API

google.places.Geocoding.Javascript

ジオコーディング サービス

Geocoding API

google.places.Geocoding.Javascript 以外の google.places.*.Javascript

プレイス ライブラリ

Places API

  • これらの API メソッドを使用しない場合は、クライアント ID トラフィックがすでにプロジェクトの割り当てを消費しているため、割り当て設定について心配する必要はありません。
  • クライアント ID の割り当て使用量を見積もる
    • 各サービスについて、1 秒あたりの粒度と 1 日あたりの粒度の両方を確認します。
    • [Per Second] グラフ: ピーク時のトラフィックに 60 を掛けて、1 分あたりの追加割り当てを計算します。
    • [Per Day] グラフ: トラフィックのピークは、1 日あたりの追加の割り当てのニーズになります。
  • 対応する Maps Platform サービスの割り当てを調整します。
    • 手順 1 で確認したメソッド名に基づいて、対応するサービスの割り当てを調整します。

コードを更新する

クライアント パラメータをキー パラメータに置き換え

送信 GMP API 呼び出しで、認証情報を URL&client={value} から URL&key={value} に更新します。アプリで HTTP を使用して GMP サービスにアクセスしている場合は、HTTPS を使用するように更新します。

レポート用のチャネル パラメータを更新する

API リクエストにチャネル パラメータを指定することで、チャネルごとの使用状況を追跡できます。API キーは、チャネル パラメータの数値のみをサポートします。クライアント ID を使用していて、チャネル パラメータに数値以外の値を使用している場合は、サポートされている数値の値に更新してください。

詳しくは、Google Maps Platform のレポートをご覧ください。

ウェブサービスの署名パラメータを削除

次のウェブサービス API では、API キーを使用してアクセスする場合、署名パラメータは必要ありません。API リクエストから署名パラメータのみを削除します。

  • Directions API(以前のバージョン)
  • Distance Matrix API(以前のバージョン)
  • Geocoding API
  • Elevation API
  • Time Zone API

詳しくは、プレミアム プランの概要をご覧ください。

画像 API の署名シークレット

Maps Static API と Street View Static API では、引き続き署名パラメータが必要です。テスト目的で署名なしのリクエストを少数受け付けますが、本番環境でしきい値に達すると失敗し始めます。署名シークレットをクライアント ID のものから API キーのものに置き換えます。同じ署名アルゴリズムを使用できますが、別の署名シークレットを使用する必要があります。詳細については、デジタル署名を使用するをご覧ください。

クライアント ID のトラフィックをモニタリングする

デプロイ後、Cloud Console ダッシュボードを使用して、トラフィックが正常に移行されたことを確認します。クライアント ID のトラフィックが減少し始めます。これは、認証情報でグループ化すると、ダッシュボードに「project_number:123456」形式で表示されます。

クライアント ID を一時停止する

移行後にクライアント ID を一時停止することを強くおすすめします。これは、認証情報を意図しないトラフィックから保護し、クライアント ID の残りの使用量が重要ではない(テスト、キャッシュ、ボットなど)ことを確認し、ビジネスに影響を与えることなくエラーを返すことができるようにするためです。クライアント ID は Cloud コンソールで一時停止できます。詳しくは、プレミアム プランの認証の概要をご覧ください。

トラブルシューティング

リクエストが失敗しているかどうかを確認するにはどうすればよいですか?

エラー統計情報は、レスポンス コードのグラフで確認できます。

ApiNotActivatedMapError エラーまたは REQUEST_DENIED エラー

Cloud プロジェクトでサービスを有効にしていない場合は、ApiNotActivatedMapError または REQUEST_DENIED エラーが表示されます。手順に沿ってサービスを有効にします

エラー RefererNotAllowedMapError

ソースドメインが API キーに追加されていない場合は、RefererNotAllowedMapError エラーが表示されます。「API キーを保護する」セクションを確認し、API キーにドメインを追加します。

OverQuotaMapError エラーまたは OVER_QUERY_LIMIT エラー

構成した割り当てがトラフィックをカバーするのに十分でない場合は、OverQuotaMapError または OVER_QUERY_LIMIT が表示されます。「割り当て設定を確認する」セクションを確認し、必要に応じて割り当てを調整します。

「この API へのリクエストは SSL 経由で行う必要があります」というエラー

次のエラー メッセージが表示された場合は、API リクエストを「http://」から「https://」に更新してください。

{
  "error_message" : "Requests to this API must be over SSL. Load the API with
  \"https://\" instead of \"http://\".",

  "results" : [],

  "status" : "REQUEST_DENIED"
}