ディスカバリ ドキュメント: list
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
このエンドポイントでサポートされている 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 : このバージョンを優先して使用するバージョン。 |
|
試してみる
以下のエクスプローラを使用して、ライブデータ上でこのメソッドを呼び出し、レスポンスを確認します。または、スタンドアロン エクスプローラをお試しください。
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2022-07-27 UTC。
[null,null,["最終更新日 2022-07-27 UTC。"],[[["\u003cp\u003eThe \u003ccode\u003ediscovery.apis.list\u003c/code\u003e endpoint retrieves a list of all APIs supported by the Google APIs Discovery Service.\u003c/p\u003e\n"],["\u003cp\u003eEach API and its versions are represented as individual entries in the response.\u003c/p\u003e\n"],["\u003cp\u003eYou can filter results using optional parameters like \u003ccode\u003ename\u003c/code\u003e to include specific APIs or \u003ccode\u003epreferred\u003c/code\u003e to return only preferred versions.\u003c/p\u003e\n"],["\u003cp\u003eThe response provides comprehensive information about each API, including its ID, name, version, description, documentation link, and icons.\u003c/p\u003e\n"]]],[],null,["# Discovery Document: list\n\nRetrieve the list of APIs supported at this endpoint.\n\n\nThe `discovery.apis.list` method returns the list of all APIs supported by the\nGoogle APIs Discovery Service. The data for each entry is a subset of the Discovery Document\nfor that API, and the list provides a directory of supported APIs. If a specific API\nhas multiple versions, each of the versions has its own entry in the list.\n\nRequest\n-------\n\n### HTTP Request\n\n```\nGET https://discovery.googleapis.com/discovery/v1/apis\n```\n\n### Parameters\n\n| Parameter Name | Value | Description |\n|----------------|-----------|--------------------------------------------------------------------|\n| **Optional Parameters** |||\n| `name` | `string` | Only include APIs with the given name. |\n| `preferred` | `boolean` | Return only the preferred version of an API. \"`false`\" by default. |\n\n### Request Body\n\nDo not supply a request body with this method.\n\nResponse\n--------\n\nIf successful, this method returns a response body with the following structure:\n\n```text\n{\n \"kind\": \"discovery#directoryList\",\n \"discoveryVersion\": \"v1\",\n \"items\": [\n {\n \"kind\": \"discovery#directoryItem\",\n \"id\": string,\n \"name\": string,\n \"version\": string,\n \"title\": string,\n \"description\": string,\n \"discoveryRestUrl\": string,\n \"discoveryLink\": string,\n \"icons\": {\n \"x16\": string,\n \"x32\": string\n },\n \"documentationLink\": string,\n \"labels\": [\n string\n ],\n \"preferred\": boolean\n }\n ]\n}\n```\n\n| Property Name | Value | Description |\n|-----------------------------|-----------|------------------------------------------------------------------------------------|\n| `kind` | `string` | The fixed string discovery#directoryList |\n| `discoveryVersion` | `string` | Indicate the version of the Discovery API used to generate this doc. |\n| `items[]` | `list` | The individual directory entries. One entry per API/version pair. |\n| items[].`kind` | `string` | The kind for this response. |\n| items[].`id` | `string` | The ID of this API. |\n| items[].`name` | `string` | The name of the API. |\n| items[].`version` | `string` | The version of the API. |\n| items[].`title` | `string` | The title of this API. |\n| items[].`description` | `string` | The description of this API. |\n| items[].`discoveryRestUrl` | `string` | The url for the discovery REST document. |\n| items[].`discoveryLink` | `string` | A link to the discovery document. |\n| items[].`icons` | `object` | Links to 16x16 and 32x32 icons representing the API. |\n| items[].icons.`x16` | `string` | The url of the 16x16 icon. |\n| items[].icons.`x32` | `string` | The url of the 32x32 icon. |\n| items[].`documentationLink` | `string` | A link to human readable documentation for the API. |\n| items[].`labels[]` | `list` | Labels for the status of this API, such as `limited_availability` or `deprecated`. |\n| items[].`preferred` | `boolean` | `true` if this version is the preferred version to use. |"]]