このエンドポイントでサポートされている API のリストを取得します。実習をご覧ください。
discovery.apis.list メソッドは、Google API Discovery Service でサポートされるすべての API のリストを返します。各エントリのデータはその API のディスカバリ ドキュメントのサブセットであり、リストにはサポートされている API のディレクトリが記載されています。特定の API に複数のバージョンがある場合、バージョンごとに固有のエントリがリストに表示されます。
リクエスト
HTTP リクエスト
GET https://discovery.googleapis.com/discovery/v1/apis
パラメータ
| パラメータ名 | Value | 説明 |
|---|---|---|
| 省略可能なパラメータ | ||
name |
string |
指定された名前の API のみを含めます。 |
preferred |
boolean |
目的のバージョンの API のみを返します。 "false" (デフォルト) |
リクエスト本文
このメソッドをリクエストの本文に含めないでください。
レスポンス
成功すると、このメソッドは次の構造を含むレスポンスの本文を返します。
{
"kind": "discovery#directoryList",
"discoveryVersion": "v1",
"items": [
{
"kind": "discovery#directoryItem",
"id": string,
"name": string,
"version": string,
"title": string,
"description": string,
"discoveryRestUrl": string,
"discoveryLink": string,
"icons": {
"x16": string,
"x32": string
},
"documentationLink": string,
"labels": [
string
],
"preferred": boolean
}
]
}
| プロパティ名 | Value | 説明 | 備考 |
|---|---|---|---|
kind |
string |
固定文字列 Discovery#directoryList | |
discoveryVersion |
string |
このドキュメントの生成に使用した Discovery API のバージョンを示します。 | |
items[] |
list |
個々のディレクトリ エントリ。API とバージョンのペアごとに 1 つのエントリ。 | |
items[].kind |
string |
このレスポンスの種類。 | |
items[].id |
string |
この API の ID。 | |
items[].name |
string |
API の名前。 | |
items[].version |
string |
API のバージョン。 | |
items[].title |
string |
この API のタイトル。 | |
items[].description |
string |
この API の説明。 | |
items[].discoveryRestUrl |
string |
検出 REST ドキュメントの URL。 | |
items[].discoveryLink |
string |
ディスカバリ ドキュメントへのリンク。 | |
items[].icons |
object |
API を表す 16x16 および 32x32 のアイコンへのリンク。 | |
items[].icons.x16 |
string |
16x16 アイコンの URL。 | |
items[].icons.x32 |
string |
32x32 アイコンの URL。 | |
items[].documentationLink |
string |
人が読める形式の API ドキュメントのリンク。 | |
items[].labels[] |
list |
この API のステータスのラベル(limited_availability や deprecated など)。 |
|
items[].preferred |
boolean |
true: このバージョンを優先して使用するバージョン。 |
試してみる
以下のエクスプローラを使用して、ライブデータ上でこのメソッドを呼び出し、レスポンスを確認します。または、スタンドアロン エクスプローラをお試しください。