مستند الاستكشاف: قائمة

استرداد قائمة واجهات برمجة التطبيقات المتوافقة في نقطة النهاية هذه

تعرض الطريقة discovery.apis.list قائمة بجميع واجهات برمجة التطبيقات التي تتيحها خدمة Google APIs Discovery Service. تمثّل البيانات الخاصة بكل إدخال مجموعة فرعية من مستند الاكتشاف الخاص بواجهة برمجة التطبيقات هذه، وتوفّر القائمة دليلاً لواجهات برمجة التطبيقات المتوافقة.  إذا كان هناك إصدارات متعددة من واجهة برمجة تطبيقات معيّنة، سيكون لكل إصدار إدخاله الخاص في القائمة.

طلب

طلب HTTP

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

المعلمات

اسم المَعلمة القيمة الوصف
المَعلمات الاختيارية
name string لا تدرِج سوى واجهات برمجة التطبيقات التي تحمل الاسم المحدّد.
preferred boolean عرض النسخة المفضّلة فقط من واجهة برمجة التطبيقات  "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 إدخالات الدليل الفردية يجب تضمين إدخال واحد لكل زوج من واجهة برمجة التطبيقات والإصدار.
items[].kind string نوع هذا الردّ.
items[].id string معرّف واجهة برمجة التطبيقات هذه
items[].name string اسم واجهة برمجة التطبيقات.
items[].version string إصدار واجهة برمجة التطبيقات
items[].title string تمثّل هذه السمة عنوان واجهة برمجة التطبيقات هذه.
items[].description string وصف واجهة برمجة التطبيقات هذه.
items[].discoveryRestUrl string عنوان URL لمستند REST الخاص بخدمة Discovery
items[].icons object روابط تؤدي إلى رموز بحجم 16x16 و32x32 تمثّل واجهة برمجة التطبيقات
items[].icons.x16 string تمثّل هذه السمة عنوان URL الخاص بالرمز 16x16.
items[].icons.x32 string تمثّل هذه السمة عنوان URL للرمز بحجم 32×32.
items[].labels[] list تصنيفات لحالة واجهة برمجة التطبيقات هذه، مثل limited_availability أو deprecated
items[].preferred boolean true إذا كان هذا الإصدار هو الإصدار المفضّل للاستخدام.