Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
L'API Discovery fornisce un elenco di API Google per il recupero di metadati di un "documento Discovery" leggibili dalla macchina per ogni API.
Questo documento è rivolto agli sviluppatori che vogliono scrivere librerie client, plug-in IDE e altri strumenti per interagire con le API di Google.
Sfondo del servizio di scoperta
Concetti
Il servizio di rilevamento delle API di Google si basa su due concetti di base:
Directory API: un elenco di tutte le API supportate dal servizio di rilevamento API. Ogni voce della directory mostra i dettagli di un'API supportata, tra cui il nome, una breve descrizione della funzionalità e un link alla documentazione. Un'API può avere più voci di directory, una per ciascuna delle sue versioni supportate.
Documento di rilevamento: una descrizione leggibile da computer di una determinata API.
Il documento di rilevamento descrive l'interfaccia per una determinata versione di un'API. Il
documento fornisce dettagli su come accedere ai vari metodi di ogni API tramite chiamate HTTP REST. Un documento Discovery include descrizioni dei dati e dei metodi associati all'API, nonché informazioni sugli ambiti OAuth disponibili e descrizioni di schemi, metodi, parametri e valori dei parametri disponibili.
Modello dati
Una risorsa è una singola entità di dati con un identificatore univoco. Il servizio di rilevamento delle API di Google opera su
due tipi di risorse, in base ai concetti precedenti.
Elenco di directory API: un elenco di API
Ogni voce della directory contiene una coppia nome/versione dell'API con le seguenti informazioni:
Informazioni di identificazione e descrizione: nome, versione, titolo e
descrizione.
Informazioni sulla documentazione: icone e un link alla documentazione.
Informazioni sullo stato, incluse le etichette di stato, e un'indicazione su se si tratta o meno della versione preferita dell'API.
Link al documento di rilevamento, l'URI del documento di rilevamento per questa API
(specificato come URL completo, ad esempio
https://serviceusage.googleapis.com/$discovery/rest?version=v1).
Risorsa documento di rilevamento: una descrizione leggibile da computer di una determinata API
Oltre alle informazioni fornite nella Directory API, un documento di Discovery include anche:
Schema, ovvero un elenco di schemi di risorse API che descrivono i dati a cui hai accesso in ogni API. Gli schemi di Discovery Service delle API di Google si basano su JSON Schema.
Metodi, incluso un elenco dei metodi API e dei parametri disponibili per ciascun
metodo.
Ambiti OAuth, che identifica l'elenco degli ambiti OAuth disponibili per questa
API.
Documentazione in linea, che fornisce brevi descrizioni di schemi, metodi, parametri e valori dei parametri disponibili.
La singola raccolta di directory è il contenitore concettuale della risorsa Directory
delle singole API e delle risorse del documento di scoperta per ogni API supportata.
Operazioni
Puoi invocare due metodi diversi su raccolte e risorse nel servizio di scoperta delle API di Google, come descritto nella tabella seguente.
Operazione
Descrizione
Mappature HTTP REST
list
Elenca tutte le API supportate.
GET nell'URI della risorsa Directory.
Stile di chiamata
REST
Le operazioni di Discovery Service delle API Google supportate mappano direttamente al verbo GET HTTP REST, come descritto in Operazioni.
Il formato specifico per gli URI del servizio di rilevamento API di Google è:
https://API/$discovery/rest?version=VERSION
dove API è l'identificatore di una risorsa Discovery Document e
VERSION è l'identificatore della versione specifica dell'API.
Ecco un paio di esempi di come funziona nel servizio di rilevamento delle API Google.
Elenca tutte le API supportate dal servizio di scoperta delle API di Google:
GET https://discovery.googleapis.com/discovery/v1/apis
[[["Facile da capire","easyToUnderstand","thumb-up"],["Il problema è stato risolto","solvedMyProblem","thumb-up"],["Altra","otherUp","thumb-up"]],[["Mancano le informazioni di cui ho bisogno","missingTheInformationINeed","thumb-down"],["Troppo complicato/troppi passaggi","tooComplicatedTooManySteps","thumb-down"],["Obsoleti","outOfDate","thumb-down"],["Problema di traduzione","translationIssue","thumb-down"],["Problema relativo a esempi/codice","samplesCodeIssue","thumb-down"],["Altra","otherDown","thumb-down"]],["Ultimo aggiornamento 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```"]]
