Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Discovery API menyediakan daftar Google API untuk mengambil metadata "Dokumen
Discovery" yang dapat dibaca mesin untuk setiap API.
Dokumen ini ditujukan bagi developer yang ingin menulis library klien, plugin IDE, dan
alat lainnya untuk berinteraksi dengan Google API.
Latar Belakang Layanan Penemuan
Konsep
Layanan Penemuan Google API dibuat berdasarkan dua konsep dasar:
APIs Directory: Daftar semua API yang didukung oleh
Layanan Penemuan API. Setiap entri direktori menampilkan detail tentang API yang didukung, termasuk
nama, deskripsi singkat tentang fungsinya, dan link
dokumentasi. API dapat memiliki beberapa entri Direktori, satu untuk setiap versi yang didukungnya.
Dokumen discovery: Deskripsi API tertentu yang dapat dibaca komputer.
Dokumen Discovery menjelaskan platform untuk versi API tertentu. Dokumen ini memberikan detail tentang cara mengakses berbagai metode setiap API melalui panggilan HTTP RESTful. Dokumen Discovery menyertakan deskripsi data dan metode yang terkait dengan
API, serta informasi tentang cakupan OAuth yang tersedia, dan deskripsi skema,
metode, parameter, dan nilai parameter yang tersedia.
Model data
Resource adalah entitas data individual dengan ID unik. Layanan Penemuan Google API beroperasi pada
dua jenis resource, berdasarkan konsep di atas.
Daftar Direktori API: Daftar API
Setiap entri direktori berisi pasangan name/version API dengan
informasi berikut:
Informasi identifikasi dan deskripsi,: nama, versi, judul, dan
deskripsi.
Informasi dokumentasi: ikon dan link dokumentasi.
Informasi status, termasuk label status, dan indikasi apakah versi ini merupakan versi API yang diinginkan atau tidak.
Link dokumen penemuan, URI dokumen penemuan untuk API ini
(diberikan sebagai URL lengkap—misalnya,
https://serviceusage.googleapis.com/$discovery/rest?version=v1).
Resource Dokumen Discovery: Deskripsi API tertentu yang dapat dibaca mesin
Selain informasi yang diberikan di Direktori API, dokumen Discovery juga
mencakup:
Skema, yang merupakan daftar skema resource API yang mendeskripsikan data yang Anda
miliki aksesnya di setiap API; skema Layanan Penemuan Google API didasarkan pada Skema JSON.
Metode, termasuk daftar metode API dan parameter yang tersedia untuk setiap metode.
Cakupan OAuth, yang mengidentifikasi daftar cakupan OAuth yang tersedia untuk API ini.
Dokumentasi inline, yang memberikan deskripsi singkat tentang skema,
metode, parameter, dan nilai parameter yang tersedia.
Satu Koleksi Direktori adalah penampung konseptual dari satu resource Directory API, dan resource Dokumen Discovery untuk setiap API yang didukung.
Operasi
Anda dapat memanggil dua metode berbeda pada koleksi dan resource di Layanan Penemuan Google API, seperti
yang dijelaskan dalam tabel berikut.
Operasi
Deskripsi
Pemetaan HTTP REST
list
Mencantumkan semua API yang didukung.
GET pada URI resource Direktori.
Gaya panggilan
REST
Operasi Layanan Penemuan Google API yang didukung dipetakan langsung ke kata kerja HTTP
GETREST, seperti yang dijelaskan dalam Operasi.
Format spesifik untuk URI Layanan Penemuan Google API adalah:
https://API/$discovery/rest?version=VERSION
dengan API adalah ID untuk resource Dokumen Discovery, dan
VERSION adalah ID versi API tertentu.
Berikut beberapa contoh cara kerjanya di Layanan Penemuan Google API.
Cantumkan semua API yang didukung oleh Google API Discovery Service:
GET https://discovery.googleapis.com/discovery/v1/apis
[[["Mudah dipahami","easyToUnderstand","thumb-up"],["Memecahkan masalah saya","solvedMyProblem","thumb-up"],["Lainnya","otherUp","thumb-up"]],[["Informasi yang saya butuhkan tidak ada","missingTheInformationINeed","thumb-down"],["Terlalu rumit/langkahnya terlalu banyak","tooComplicatedTooManySteps","thumb-down"],["Sudah usang","outOfDate","thumb-down"],["Masalah terjemahan","translationIssue","thumb-down"],["Masalah kode / contoh","samplesCodeIssue","thumb-down"],["Lainnya","otherDown","thumb-down"]],["Terakhir diperbarui pada 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```"]]
