ディスカバリドキュメント: リスト

このエンドポイントでサポートされている API のリストを取得します。

discovery.apis.list メソッドは、Google API Discovery Service でサポートされているすべての API のリストを返します。各エントリのデータは、その API のディスカバリドキュメントのサブセットであり、リストにはサポートされている API のディレクトリが含まれます。特定の API に複数のバージョンがある場合、リストには各バージョンのエントリが含まれます。

リクエスト

HTTP リクエスト

GET https://discovery.googleapis.com/discovery/v1/apis

パラメータ

パラメータ名	値	説明
オプションパラメータ
`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
    }
  ]
}

プロパティ名	値	説明
`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`。

ディスカバリ ドキュメント: リスト