Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
L'API Discovery fournit une liste d'API Google permettant de récupérer les métadonnées du document de découverte exploitables par ordinateur pour chaque API.
Ce document est destiné aux développeurs qui souhaitent écrire des bibliothèques clientes, des plug-ins IDE et d'autres outils pour interagir avec les API Google.
Informations sur le service de découverte
Concepts
Le service de découverte des API Google repose sur deux concepts fondamentaux :
Répertoire des API : liste de toutes les API compatibles avec le service de découverte des API. Chaque entrée du répertoire présente des informations sur une API compatible, y compris son nom, une brève description de son utilité et un lien vers la documentation. Une API peut contenir plusieurs entrées de répertoire, à raison d'une par version compatible.
Document de découverte : description d'une API particulière, exploitable par ordinateur.
Le document de découverte décrit la surface d'une version particulière d'une API. Il explique comment accéder aux différentes méthodes de chaque API via des appels HTTP RESTful. Un document de découverte comprend des descriptions des données et des méthodes associées à l'API, ainsi que des informations sur les champs d'application OAuth disponibles et des descriptions de schémas, de méthodes, de paramètres et de valeurs de paramètre disponibles.
Modèle de données
Une ressource est une entité de données individuelle disposant d'un identifiant unique. Le service de découverte des API Google fonctionne sur deux types de ressources, basés sur les concepts ci-dessus.
Liste de répertoires des API : liste des API
Chaque entrée du répertoire contient une paire nom/version d'API avec les informations suivantes :
Informations d'identification et de description : nom, version, intitulé et description.
Informations sur la documentation : icônes et lien vers la documentation.
Informations sur l'état, y compris les étiquettes d'état et une indication précisant s'il s'agit ou non de la version de l'API à privilégier.
Lien vers le document de découverte : URI du document de découverte pour cette API, fourni en tant qu'URL complète (par exemple, https://serviceusage.googleapis.com/$discovery/rest?version=v1).
Ressource du document de découverte : description d'une API particulière exploitable par ordinateur
En plus des informations fournies dans le répertoire des API, un document de découverte inclut également les éléments suivants :
Schémas : liste de schémas de ressources d'API décrivant les données auxquelles vous avez accès dans chaque API. Les schémas du service de découverte des API Google sont basés sur le schéma JSON.
Méthodes, y compris une liste des méthodes d'API et des paramètres disponibles pour chaque méthode.
Champs d'application OAuth : identifient la liste des champs d'application OAuth disponibles pour cette API.
Documentation intégrée : fournit de brèves descriptions des schémas, des méthodes, des paramètres et des valeurs de paramètre disponibles.
La collection unique du répertoire est le conteneur conceptuel de la ressource unique du répertoire des API et des ressources du document de découverte pour chaque API compatible.
Opérations
Vous pouvez appeler deux méthodes différentes sur les collections et les ressources du service de découverte des API Google, comme décrit dans le tableau suivant.
Opération
Description
Mappages HTTP REST
liste
Répertorie toutes les API compatibles.
GET sur l'URI de la ressource de répertoire.
Style d'appel
REST
Les opérations du service de découverte des API Google compatibles sont directement mappées au verbe HTTP GETREST, comme décrit dans la section Opérations.
Le format spécifique des URI du service de découverte des API Google est le suivant :
https://API/$discovery/rest?version=VERSION
où API est l'identifiant d'une ressource du document de découverte et VERSION l'identifiant de la version spécifique de l'API.
Voici quelques exemples de fonctionnement dans le service de découverte des API Google.
Répertoriez toutes les API compatibles avec le service de découverte des API Google :
GET https://discovery.googleapis.com/discovery/v1/apis
Obtenez le document de découverte pour l'API Service Usage, version 1:
GET https://serviceusage.googleapis.com/$discovery/rest?version=v1
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 2025/07/25 (UTC).
[[["Facile à comprendre","easyToUnderstand","thumb-up"],["J'ai pu résoudre mon problème","solvedMyProblem","thumb-up"],["Autre","otherUp","thumb-up"]],[["Il n'y a pas l'information dont j'ai besoin","missingTheInformationINeed","thumb-down"],["Trop compliqué/Trop d'étapes","tooComplicatedTooManySteps","thumb-down"],["Obsolète","outOfDate","thumb-down"],["Problème de traduction","translationIssue","thumb-down"],["Mauvais exemple/Erreur de code","samplesCodeIssue","thumb-down"],["Autre","otherDown","thumb-down"]],["Dernière mise à jour le 2025/07/25 (UTC)."],[[["\u003cp\u003eThe Google Discovery API provides machine-readable metadata ("Discovery documents") for various Google APIs, aiding developers in building client libraries and tools.\u003c/p\u003e\n"],["\u003cp\u003eThe service relies on an APIs Directory, listing available APIs, and Discovery documents detailing each API's structure, methods, and schemas.\u003c/p\u003e\n"],["\u003cp\u003eDiscovery documents employ JSON Schema to describe data structures and offer inline documentation for better understanding.\u003c/p\u003e\n"],["\u003cp\u003eYou can retrieve the APIs Directory or a specific API's Discovery document through simple RESTful HTTP GET requests.\u003c/p\u003e\n"],["\u003cp\u003eThe service is publicly accessible for general API discovery, though private APIs may require authentication.\u003c/p\u003e\n"]]],[],null,["# Overview of the Discovery API\n\nThe Discovery API provides a list of Google APIs for retrieving a machine-readable \"Discovery\ndocument\" metadata for each API.\n\n\nThis document is intended for developers who want to write client libraries, IDE plugins, and\nother tools for interacting with Google APIs.\n\nDiscovery Service Background\n----------------------------\n\n### Concepts\n\nThe Google APIs Discovery Service is built upon two basic concepts:\n\n- **APIs Directory** : A list of all APIs that are supported by the APIs Discovery Service. Each directory entry shows details about a supported API, including its *name* , a brief *description* of what it does, and a *documentation\n link*. An API can have multiple Directory entries, one for each of its supported versions.\n- **Discovery document**: A machine-readable description of a particular API. The Discovery document describes the surface for a particular version of an API. The document provides details on how to access the various methods of each API via RESTful HTTP calls. A Discovery document includes descriptions of the data and methods associated with the API, as well as information about available OAuth scopes, and descriptions of schemas, methods, parameters and available parameter values.\n\n### Data model\n\n\nA resource is an individual data entity with a unique identifier. The Google APIs Discovery Service operates on\ntwo types of resources, based on the above concepts.\n\n#### APIs Directory List: A list of APIs\n\n\nEach directory entry contains an API **name** /**version** pair with the\nfollowing information:\n\n- **Identification and description information,**: name, version, title, and description.\n- **Documentation information**: icons and a documentation link.\n- **Status information**, including status labels, and an indication as to whether or not this is the preferred version of the API.\n- **Discovery document link** , the URI of the discovery document for this API (given as a full URL---for example, `https://serviceusage.googleapis.com/$discovery/rest?version=v1`).\n\n#### Discovery Document resource: A machine-readable description of a particular API\n\n\nIn addition to the information provided in the APIs Directory, a Discovery document also\nincludes:\n\n- **Schemas** , which is a list of API resource schemas that describe the data you have access to in each API; the Google APIs Discovery Service schemas are based on [JSON Schema](https://json-schema.org/).\n- **Methods**, including a list of API methods and available parameters for each method.\n- **OAuth scopes**, which identifies the list of OAuth scopes available for this API.\n- **Inline documentation**, which provides brief descriptions of schemas, methods, parameters and available parameter values.\n\n\nThe single Directory Collection is the conceptual container of the single APIs Directory\nresource, and the Discovery Document resources for each supported API.\n\n### Operations\n\n\nYou can invoke two different methods on collections and resources in the Google APIs Discovery Service, as\ndescribed in the following table.\n\n| Operation | Description | REST HTTP mappings |\n|-----------|---------------------------|--------------------------------------|\n| list | Lists all supported APIs. | `GET` on the Directory resource URI. |\n\nCalling style\n-------------\n\n| **Note:** Public APIs *do not* need authentication. Private APIs require an [API key](https://cloud.google.com/docs/authentication/api-keys).\n\n### REST\n\n\nThe supported Google APIs Discovery Service operations map directly to the [REST](https://en.wikipedia.org/wiki/Representational_State_Transfer) HTTP\n`GET` verb, as described in [Operations](#background-operations).\n\nThe specific format for Google APIs Discovery Service URIs are: \n\n```\nhttps://API/$discovery/rest?version=VERSION\n```\n\n\nwhere \u003cvar translate=\"no\"\u003eAPI\u003c/var\u003e is the identifier for a Discovery Document resource, and\n\u003cvar translate=\"no\"\u003eVERSION\u003c/var\u003e is the identifier of the particular version of the API.\n\nHere are a couple of examples of how this works in the Google APIs Discovery Service.\n\nList all the Google APIs Discovery Service supported APIs: \n\n```\nGET https://discovery.googleapis.com/discovery/v1/apis\n```\n\n\n[Try it now in APIs Explorer!](//developers.google.com/apis-explorer/#p/discovery/v1/discovery.apis.list)\n\nGet the Discovery document for Service Usage API, version 1: \n\n```\nGET https://serviceusage.googleapis.com/$discovery/rest?version=v1\n```"]]