さまざまな認証情報タイプとスコープでテストする

API Explorer の認証情報セクションでは、さまざまな認証情報とスコープでテストできます。この機能は、API エンドポイントを呼び出すために必要な最小限の認証情報とスコープを使用していることを確認するのに役立ちます。

別の認証情報でテストする

デフォルトでは、OAuth 2 と API キーの両方の認証情報タイプがオンになっています。1 つの認証情報のみでテストする場合は、使用する認証情報の種類をオンにします(他の認証情報の種類はオフにします)。テストに使用する認証情報を選択する際の一般的なルールは次のとおりです。

  • Google マップデータなどの一般公開データにアクセスする方法を使用している場合は、API キーを認証情報として使用できます。[API Key] をオンにし、[Google OAuth 2.0] をオフにします。

  • ユーザーの Google ドライブのデータなど、プライベート データにアクセスする方法を使用している場合は、OAuth 2 認証情報を使用する必要があります。[API キー] チェックボックスをオフにし、[Google OAuth 2.0] チェックボックスをオンにします。

結果が 200 の場合、認証情報はデータへのアクセスに十分です。401 の結果を受け取った場合は、OAuth 2 認証情報を使用してデータにアクセスする必要があります。

さまざまなスコープでテストする

スコープは、https://www.googleapis.com/auth/drive.metadata.readonly などの文字列で、アプリに必要なリソースへのアクセスレベル(ユーザーが所有するデータへのアクセスレベルなど)を定義します。理想的には、アプリでユーザーのデータへのアクセス権が最も狭いスコープを使用することが望ましいです。メソッドによって必要なスコープが異なる場合があります。たとえば、API のあるメソッドでは読み取り専用スコープが必要で、別のメソッドでは読み取り / 書き込みスコープが必要になる場合があります。

デフォルトでは、API のすべての Google OAuth 2.0 スコープが API エクスプローラで有効になっています。特定のスコープでテストするには:

  1. [Credentials Google OAuth 2.0] セクションで、[show scopes] をクリックします。
  2. メソッドを呼び出すときに使用するスコープを確認します。
  3. [実行] をクリックして、選択したスコープのみを使用して API を実行します。API エクスプローラに、スコープの使用を許可するよう求める認証画面が表示されます。
  4. [許可] をクリックします。結果は [実行] ボタンの下に表示されます。

API Explorer に「application/json」の下に 200 の結果が表示された場合、メソッドを呼び出すのに十分なスコープがあります。API Explorer に 403 の結果が表示された場合は、メソッドを呼び出すためのスコープが不足しています。より広範なスコープを試してください。

スコープの選択について詳しくは、特定の Google API のドキュメントの認証と認可のセクションをご覧ください。

新しいスコープでテストするために承認済みのアクセス権を取り消す

Google の認証画面で認証を承認すると、認証情報が期限切れにならない限り、API Explorer は認証済みリクエストを行う権限を保持します。スコープのチェックを外しても、以前に承認された認証情報とスコープはリセットされません。新しいスコープ構成でテストする場合は、以前に承認した認証情報を取り消す必要があります。

APIs Explorer で使用される認証情報を取り消すには:

  1. [アカウントにアクセスできるアプリ] に移動します。
  2. [アカウントにアクセスできるサードパーティ製アプリ] で、[Google APIs Explorer] をクリックします。
  3. [アクセス権を削除] をクリックします。
  4. (省略可)ドキュメント ページを再読み込みして、API Explorer をリセットします。