Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
A API Discovery fornece uma lista de APIs do Google para recuperar metadados do "documento de descoberta" legível por máquina para cada API.
Este documento é destinado a desenvolvedores que querem criar bibliotecas de cliente, plug-ins de ambiente de desenvolvimento integrado e outras ferramentas para interagir com as APIs do Google.
Base do serviço de descoberta
Conceitos
O serviço de descoberta de APIs do Google foi criado sob dois conceitos básicos:
Diretório de APIs: uma lista de todas as APIs compatíveis com o serviço de descoberta de APIs. Cada entrada do diretório mostra detalhes sobre uma API compatível, incluindo o nome dela, uma descrição breve do que ela faz e um link para a documentação. Uma API pode ter várias entradas do diretório, uma para cada versão compatível.
Documento de descoberta: uma descrição legível por máquina de uma API específica.
O documento de descoberta descreve a plataforma de uma versão específica de uma API. O documento apresenta detalhes sobre como acessar os vários métodos de cada API via chamadas HTTP RESTful. Um documento de descoberta contém descrições dos dados e métodos associados à API, além de informações sobre os escopos disponíveis do OAuth e descrições de esquemas, métodos, parâmetros e valores de parâmetros disponíveis.
Modelo de dados
Um recurso é uma entidade individual de dados com um identificador exclusivo. O serviço de descoberta de APIs do Google opera em dois tipos de recursos, com base nos conceitos acima.
Lista de diretórios de APIs: uma lista de APIs
Cada entrada do diretório contém um par de nome/versão da API com as seguintes informações:
Informações de identificação e descrição: nome, versão, título e descrição.
Informações da documentação: ícones e um link para a documentação.
Informações de status, incluindo rótulos de status e uma indicação se essa é ou não a versão preferencial da API.
Link para o documento de descoberta, o URI do documento de descoberta dessa API (especificado como um URL completo, por exemplo, https://serviceusage.googleapis.com/$discovery/rest?version=v1).
Recurso do documento de descoberta: uma descrição legível por máquina de uma API específica
Além das informações apresentadas no diretório de APIs, o documento de descoberta também contém:
Esquemas, que é uma lista de esquemas de recursos da API que descrevem os dados aos quais você tem acesso em cada API. Os esquemas do serviço de descoberta de APIs do Google são baseados no esquema JSON.
Métodos, incluindo uma lista de métodos de API e parâmetros disponíveis para cada método.
Escopos do OAuth, que identifica a lista de escopos do OAuth disponíveis para essa API.
Documentação inline, que contém descrições breves de esquemas, métodos, parâmetros e valores de parâmetros disponíveis.
A coleção de diretórios individuais é o contêiner conceitual do recurso do diretório de APIs individuais e dos recursos do documento de descoberta para cada API compatível.
Operações
É possível invocar dois métodos diferentes em coleções e recursos no serviço de descoberta de APIs do Google, conforme descrito na tabela a seguir.
Operação
Descrição
Mapeamentos HTTP REST
list
Lista todas as APIs compatíveis.
GET no URI do recurso do diretório.
Como chamar estilos
REST
As operações compatíveis do serviço de descoberta de APIs do Google são mapeadas diretamente com o verbo HTTP GETREST, conforme descrito em Operações.
O formato específico dos URIs do serviço de descoberta de APIs do Google é:
https://API/$discovery/rest?version=VERSION
em que API é o identificador de um recurso do documento de descoberta e VERSION é o identificador da versão específica da API.
Veja alguns exemplos de como isso funciona no serviço de descoberta de APIs do Google.
Liste todas as APIs compatíveis com o serviço de descoberta de APIs do Google:
GET https://discovery.googleapis.com/discovery/v1/apis
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Não contém as informações de que eu preciso","missingTheInformationINeed","thumb-down"],["Muito complicado / etapas demais","tooComplicatedTooManySteps","thumb-down"],["Desatualizado","outOfDate","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Problema com as amostras / o código","samplesCodeIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 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```"]]