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

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

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

デフォルトでは、OAuth 2 と API キーの両方の認証情報タイプがチェックされます。1 つの認証情報だけでテストする場合は、使用する認証情報タイプをオンにします(他の認証情報タイプはオフにします)。テストに使用する認証情報を選択するための一般的なルールは次のとおりです。

  • 一般公開データ(Google マップ データなど)にアクセスする場合は、認証情報として API キーを使用できます。[API キー] をオンにして、[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 Explorer で有効になっています。特定のスコープでテストするには:

  1. 認証情報の Google OAuth 2.0 セクションで [スコープを表示] をクリックします。
  2. メソッドを呼び出すときに使用するスコープを確認します。
  3. 選択したスコープのみを使用して API を実行するには、[実行] をクリックします。API Explorer に、スコープを使用するためのアクセス権を付与するよう求める承認画面が表示されます。
  4. [Allow] をクリックします。結果が [Execute] ボタンの下に表示されます。

API Explorer で &applicationt/json の結果が 200 の場合、スコープはメソッドを呼び出すのに十分です。API Explorer に 403 という結果が表示された場合、メソッドを呼び出すのに不十分なスコープを選択しています。より広い範囲を試してみてください。

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

新しいスコープでのテストへの承認済みアクセスを取り消す

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

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

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