Discovery-Dokument: Liste
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Liste der an diesem Endpunkt unterstützten APIs abrufen.
Jetzt testen.
Die Methode discovery.apis.list gibt eine Liste aller APIs zurück, die vom Google APIs Discovery Service unterstützt werden. Die Daten für jeden Eintrag sind eine Teilmenge des Discovery-Dokuments für diese API und die Liste enthält ein Verzeichnis mit unterstützten APIs. Wenn eine bestimmte API mehrere Versionen hat, hat jede Version einen eigenen Eintrag in der Liste.
Anfrage
HTTP-Request
GET https://discovery.googleapis.com/discovery/v1/apis
Parameter
Parametername |
Wert |
Beschreibung |
Optionale Parameter |
name |
string |
Fügen Sie nur APIs mit dem angegebenen Namen ein.
|
preferred |
boolean |
Nur die bevorzugte Version einer API zurückgeben. "false " standardmäßig.
|
Anfragetext
Mit dieser Methode keinen Anfragetext bereitstellen.
Antwort
Bei Erfolg gibt diese Methode einen Antworttext mit der folgenden Struktur zurück:
{
"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
}
]
}
Property-Name |
Wert |
Beschreibung |
Hinweise |
kind |
string |
Fester String Discovery#directoryList |
|
discoveryVersion |
string |
Geben Sie die Version der Discovery API an, die zum Generieren dieses Dokuments verwendet wird. |
|
items[] |
list |
Die einzelnen Verzeichniseinträge. Ein Eintrag pro API/Versionspaar. |
|
items[].kind |
string |
Der Typ für diese Antwort. |
|
items[].id |
string |
Die ID dieser API. |
|
items[].name |
string |
Der Name der API. |
|
items[].version |
string |
Die Version der API. |
|
items[].title |
string |
Der Titel dieser API. |
|
items[].description |
string |
Die Beschreibung dieser API. |
|
items[].discoveryRestUrl |
string |
Die URL für das Discovery-REST-Dokument. |
|
items[].discoveryLink |
string |
Ein Link zum Discovery-Dokument. |
|
items[].icons |
object |
Links zu den Symbolen 16 x 16 und 32 x 32 für die API. |
|
items[].icons.x16 |
string |
Die URL des Symbols im Format 16 x 16. |
|
items[].icons.x32 |
string |
Die URL des Symbols im Format 32 x 32. |
|
items[].documentationLink |
string |
Ein Link zur menschenlesbaren Dokumentation für die API. |
|
items[].labels[] |
list |
Labels für den Status dieser API, z. B. limited_availability oder deprecated . |
|
items[].preferred |
boolean |
true , wenn diese Version die bevorzugte Version ist. |
|
Jetzt testen
Verwenden Sie den Explorer unten, um diese Methode für Live-Daten aufzurufen und sich die Antwort anzusehen.
Alternativ können Sie den eigenständigen Explorer ausprobieren.
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2022-07-27 (UTC).
[null,null,["Zuletzt aktualisiert: 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. |"]]