מסמך Discovery: רשימה

אחזור רשימת ממשקי ה-API שנתמכים בנקודת הקצה הזו.

השיטה discovery.apis.list מחזירה את רשימת כל ממשקי ה-API שנתמכים על ידי Google APIs Discovery Service. הנתונים של כל רשומה הם קבוצת משנה של Discovery Document של אותו API, והרשימה מספקת ספרייה של ממשקי API נתמכים.  אם ל-API מסוים יש כמה גרסאות, לכל אחת מהגרסאות יש רשומה משלה ברשימה.

בקשה

בקשת HTTP

GET https://discovery.googleapis.com/discovery/v1/apis

פרמטרים

שם פרמטר ערך תיאור
פרמטרים אופציונליים
name string כולל רק ממשקי API עם השם שצוין.
preferred boolean החזרת רק את הגרסה המועדפת של API.  ‫ "false" כברירת מחדל.

גוף הבקשה

אין לספק גוף בקשה בשיטה הזו.

תשובה

אם הפעולה בוצעה ללא שגיאות, השיטה הזו מחזירה גוף תגובה עם המבנה הבא:

{
  "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
    }
  ]
}
שם הנכס ערך תיאור
kind string The fixed string discovery#directoryList
discoveryVersion string מציינים את הגרסה של Discovery API ששימשה ליצירת המסמך הזה.
items[] list הערכים האישיים בספרייה. רשומה אחת לכל צמד API/גרסה.
items[].kind string הסוג של התשובה הזו.
items[].id string המזהה של ה-API הזה.
items[].name string שם ה-API.
items[].version string גרסת ה-API.
items[].title string השם של ה-API.
items[].description string התיאור של ה-API הזה.
items[].discoveryRestUrl string כתובת ה-URL של מסמך הגילוי של REST.
items[].icons object קישורים לסמלים בגודל 16x16 ו-32x32 שמייצגים את ה-API.
items[].icons.x16 string כתובת ה-URL של הסמל בגודל 16x16.
items[].icons.x32 string כתובת ה-URL של הסמל בגודל 32x32.
items[].labels[] list תוויות לסטטוס של ה-API הזה, כמו limited_availability או deprecated.
items[].preferred boolean true אם זו הגרסה המועדפת לשימוש.