OAuth を使用する

Map Management API は、認証に OAuth 2.0 を使用することをサポートしています。Google は、ウェブサーバー上のアプリケーションなど、OAuth 2.0 の一般的なシナリオに対応しています。

このドキュメントでは、開発環境で Map Management API 呼び出しに OAuth トークンを渡す方法について説明します。本番環境で OAuth を使用する手順については、Google での認証をご覧ください。

始める前に

Map Management API のご利用にあたっては、請求先アカウントと Map Management API が有効なプロジェクトが必要です。詳細については、Cloud コンソールでのセットアップをご覧ください。

OAuth について

デプロイ環境に応じて、OAuth を使用してアクセス トークンを作成および管理する方法はいくつかあります。

たとえば、Google OAuth 2.0 システムは、アプリケーションと Google サービス間のサーバー間インタラクションをサポートしています。このシナリオでは、サービス アカウントが必要です。このアカウントは、個々のユーザーではなく、アプリケーションに属します。ユーザーが直接関与しないため、アプリケーションはサービス アカウントに代わって Google API を呼び出します。認証方法の詳細については、Google での認証をご覧ください。

また、Android または iOS のモバイルアプリの一部として Map Management API を使用することもできます。Map Management API で OAuth を使用する方法（さまざまなデプロイ環境のアクセス トークンを管理する方法など）については、OAuth 2.0 を使用して Google API にアクセスするをご覧ください。

OAuth スコープについて

Map Management API で OAuth を使用するには、OAuth トークンのスコープが https://www.googleapis.com/auth/cloud-platform である必要があります。

ローカル開発環境で REST API 呼び出しを試す

OAuth トークンを使用して Map Management API を試したいが、トークンを生成する環境が設定されていない場合は、このセクションの手順に沿って呼び出しを行うことができます。

この例では、アプリケーションのデフォルト認証情報（ADC）によって提供される OAuth トークンを使用して呼び出しを行う方法について説明します。ADC を使用してクライアント ライブラリから Google API を呼び出す方法については、クライアント ライブラリを使用した認証をご覧ください。

前提条件

ADC を使用して REST リクエストを行う前に、Google Cloud CLI を使用して ADC に認証情報を提供します。

  1. まだプロジェクトを作成していない場合は、Cloud コンソールで設定するの手順に沿ってプロジェクトを作成し、課金を有効にします。
  2. gcloud CLI をインストールして初期化します。

  3. 認証情報ファイルを作成するには、ローカルマシンで gcloud コマンドを実行します。

    gcloud auth application-default login
  4. プロンプトが表示されたら、ログインします。ログインすると、ADC で使用されるローカル認証情報ファイルに認証情報が保存されます。

詳細については、アプリケーションのデフォルト認証情報の認証情報を提供するドキュメントのローカル開発環境セクションをご覧ください。

REST リクエストを行う

この例では、2 つのリクエスト ヘッダーを渡します。

  • 次のコマンドを使用してトークンを生成し、Authorization ヘッダーで OAuth トークンを渡します。

    gcloud auth application-default print-access-token

    返されるトークンのスコープは https://www.googleapis.com/auth/cloud-platform です。

  • 課金が有効になっている Google Cloud プロジェクトの ID または名前を X-Goog-User-Project ヘッダーに渡します。詳しくは、Cloud コンソールでのセットアップをご覧ください。

OAuth トークンを使用して Map Management API を呼び出します。

curl -X GET \
-H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
-H "X-Goog-User-Project: PROJECT_ID" \
https://mapmanagement.googleapis.com/v2beta/projects/PROJECT_NUMBER_OR_ID/mapConfigs/

トラブルシューティング

この API が対応していないユーザー認証情報に関するエラー メッセージがリクエストから返された場合は、ユーザーの認証情報が機能しないをご覧ください。