API Explorer を表示し、メソッドを実行する

ほとんどのドキュメント ページでは、画面の右側に API Explorer の縮小版が表示されます。API Explorer が表示されていない場合は、[試してみる] をクリックして、API Explorer の縮小版を表示します。

リファレンス ドキュメント ページの右側に [試してみる] が表示されない場合、そのメソッドは API Explorer でサポートされていません。たとえば、API Explorer はサービス アカウントを必要とする API と互換性がないため、そのような API のドキュメント ページには表示されません。

API Explorer の展開バージョンを表示する

API Explorer の展開バージョンには、cURL、HTTP、その他のコードサンプルが含まれています。API Explorer の拡大版を表示するには、全画面表示アイコン をクリックします。

メソッドを実行する

API Explorer では、API メソッドの必須パラメータ、省略可能なパラメータ、リクエスト本文(該当する場合)を入力できます。list メソッドなど、多くの REST メソッドでは、メソッドを実行する前に 1 つまたは 2 つのフィールドを入力するだけで済みます。たとえば、Books API の books.volumes.list メソッドは、書籍を一覧表示するためにクエリ パラメータ(q)のみを必要とします。books.volumes.list メソッドを試すには:

  1. books.volumes.list に移動します。
  2. API Explorer が表示されていない場合は、[試してみる] をクリックします。
  3. [q] フィールドに「Hunger Games」(引用符や特殊文字は不要)と入力します。
  4. 下にスクロールして [Execute] をクリックします。
  5. (省略可)Google ログイン画面で Google アカウントを選択するよう求められます。
  6. (省略可)Google の認証ダイアログで、[書籍の管理] を許可するかどうかを確認するメッセージが表示されます。[許可] をクリックします。結果は [実行] ボタンの下に表示されます。

API Explorer に 200 の結果が表示された場合、メソッドは成功しています。

API Explorer の問題のトラブルシューティング

401 エラーまたは 403 エラーが表示された

API Explorer を使用してメソッドを実行するときに 401 または 403 エラーが発生した場合は、次のいずれかに問題がある可能性があります。

  • 使用している認証タイプが間違っています(OAuth 2.0 ではなく API キーを使用している)。認証タイプの切り替えをお試しください。
  • OAuth 2.0 を使用しているが、スコープが狭すぎる。より広範なスコープを使用してみてください。

承認ダイアログが表示されない

API Explorer は、ポップアップを使用してプライベート データへのアクセス権を付与します。ブラウザでポップアップがブロックされている場合、このポップアップは表示されず、アクセス権を付与できません。

認証ダイアログで [許可] をクリックしても何も起こらない場合は、ブラウザのポップアップ設定を変更してポップアップを有効にしてみてください。