Document de découverte: liste
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Récupérez la liste des API compatibles à ce point de terminaison.
Essayer maintenant
La méthode discovery.apis.list renvoie la liste de toutes les API compatibles avec le service de découverte des API Google. Les données de chaque entrée constituent un sous-ensemble du document de découverte de cette API, et la liste fournit un répertoire des API compatibles. Si une API spécifique comporte plusieurs versions, chacune d'entre elles possède sa propre entrée dans la liste.
Demande
Requête HTTP
GET https://discovery.googleapis.com/discovery/v1/apis
Paramètres
Nom du paramètre |
Value |
Description |
Paramètres facultatifs |
name |
string |
Incluez uniquement les API portant ce nom.
|
preferred |
boolean |
Renvoie seulement la version préférée d'une API. false par défaut.
|
Corps de la requête
Ne spécifiez pas de corps de requête pour cette méthode.
Réponse
Si la requête aboutit, cette méthode renvoie un corps de réponse présentant la structure suivante :
{
"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
}
]
}
Nom de propriété |
Value |
Description |
Remarques |
kind |
string |
Chaîne fixe discovery#directoryList |
|
discoveryVersion |
string |
Indiquez la version de l'API Discovery utilisée pour générer ce document. |
|
items[] |
list |
Entrées d'annuaire individuelles. Une entrée par paire API/version. |
|
items[].kind |
string |
Genre pour cette réponse. |
|
items[].id |
string |
ID de cette API. |
|
items[].name |
string |
Nom de l'API. |
|
items[].version |
string |
Version de l'API. |
|
items[].title |
string |
Titre de cette API. |
|
items[].description |
string |
Description de cette API. |
|
items[].discoveryRestUrl |
string |
URL du document REST de découverte. |
|
items[].discoveryLink |
string |
Lien vers le document de découverte. |
|
items[].icons |
object |
Liens vers des icônes 16 x 16 et 32 x 32 qui représentent l'API. |
|
items[].icons.x16 |
string |
URL de l'icône 16 x 16. |
|
items[].icons.x32 |
string |
URL de l'icône 32x32. |
|
items[].documentationLink |
string |
Lien vers la documentation lisible pour l'API. |
|
items[].labels[] |
list |
Libellés du statut de cette API, par exemple limited_availability ou deprecated . |
|
items[].preferred |
boolean |
true si vous préférez utiliser cette version. |
|
Essayer
Utilisez l'explorateur ci-dessous pour appeler cette méthode sur des données actives et obtenir la réponse.
Vous pouvez également essayer l'explorateur autonome.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2022/07/27 (UTC).
[null,null,["Dernière mise à jour le 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. |"]]