ほとんどのドキュメント ページでは、画面の右側に要約された API Explorer が表示されます。API Explorer が表示されない場合は、[試してみる] をクリックして、API Explorer の簡易版を表示します。
リファレンス ドキュメント ページの右側に [Try it!] が表示されない場合、そのメソッドは 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
メソッドを試すには:
books.volumes.list
に移動します。- API Explorer が表示されない場合は、[試してみる] をクリックします。
- [
q
] フィールドに「Hunger Games」と入力します(引用符や特殊文字は不要です)。 - 下にスクロールして [実行] をクリックします。
- (省略可)Google ログイン画面で、Google アカウントを選択するように求められます。
- (省略可)Google の承認ダイアログで、「書籍を管理」してもよいかどうかを尋ねるメッセージが表示されます。[Allow] をクリックします。結果が [Execute] ボタンの下に表示されます。
API Explorer が結果 200 を表示した場合、メソッドは成功しています。
API Explorer に関する問題のトラブルシューティング
401 エラーまたは 403 エラーが表示された
APIs Explorer を使用してメソッドを実行する際に 401 エラーや 403 エラーが表示される場合は、次のいずれかに問題がある可能性があります。
- 間違った認証タイプ(OAuth 2.0 ではなく API キー)を使用している。 承認タイプを切り替えてみてください。
- OAuth 2.0 を使用していますが、対象範囲が狭すぎます。より広い範囲を使用してみてください。
認証ダイアログが表示されない
API Explorer はポップアップを使用して、個人データへのアクセスを許可します。ブラウザでポップアップがブロックされると、このポップアップは表示されず、アクセスの許可もできません。
認証ダイアログで [許可] をクリックしても何も起こらない場合は、ブラウザのポップアップ設定を変更してポップアップを有効にしてみてください。