مستند Discovery

تتوفّر مستندات Discovery لإصدارات معيّنة من معظم واجهات برمجة التطبيقات. يصف مستند Discovery لكل واجهة برمجة تطبيقات مساحة سطح واجهة برمجة التطبيقات وطريقة الوصول إليها وطريقة تنظيم طلبات واجهة برمجة التطبيقات وردودها. تتضمّن المعلومات المقدَّمة في مستند الاكتشاف خصائص على مستوى واجهة برمجة التطبيقات، مثل وصف لواجهة برمجة التطبيقات ومخططات الموارد ونطاقات المصادقة والطرق.

الطُرق

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

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

تمثيلات الموارد

{
  "kind": "discovery#restDescription",
  "discoveryVersion": "v1",
  "id": string,
  "name": string,
  "canonicalName": string,
  "version": string,
  "revision": string,
  "title": string,
  "description": string,
  "icons": {
    "x16": string,
    "x32": string
  },
  "documentationLink": string,
  "labels": [
    string
  ],
  "protocol": "rest",
  "baseUrl": string,
  "basePath": string,
  "rootUrl": string,
  "servicePath": string,
  "batchPath": "batch",
  "endpoints": [
    {
      "endpointUrl": string,
      "location": string,
      "deprecated": boolean,
      "description": string
    }
  ],
  "parameters": {
    (key): {
      "id": string,
      "type": string,
      "$ref": string,
      "description": string,
      "default": string,
      "required": boolean,
      "format": string,
      "pattern": string,
      "minimum": string,
      "maximum": string,
      "enum": [
        string
      ],
      "enumDescriptions": [
        string
      ],
      "repeated": boolean,
      "location": string,
      "properties": {
        (key): (JsonSchema)
      },
      "additionalProperties": (JsonSchema),
      "items": (JsonSchema),
      "annotations": {
        "required": [
          string
        ]
      }
    }
  },
  "auth": {
    "oauth2": {
      "scopes": {
        (key): {
          "description": string
        }
      }
    }
  },
  "features": [
    string
  ],
  "schemas": {
    (key): {
      "id": string,
      "type": string,
      "$ref": string,
      "description": string,
      "default": string,
      "required": boolean,
      "deprecated": boolean,
      "format": string,
      "pattern": string,
      "minimum": string,
      "maximum": string,
      "enum": [
        string
      ],
      "enumDescriptions": [
        string
      ],
      "enumDeprecated": [
        boolean
      ],
      "repeated": boolean,
      "location": string,
      "properties": {
        (key): (JsonSchema)
      },
      "additionalProperties": (JsonSchema),
      "items": (JsonSchema),
      "annotations": {
        "required": [
          string
        ]
      }
    }
  },
  "methods": {
    (key): {
      "id": string,
      "path": string,
      "httpMethod": string,
      "description": string,
      "deprecated": boolean,
      "parameters": {
        (key): {
          "id": string,
          "type": string,
          "$ref": string,
          "description": string,
          "default": string,
          "required": boolean,
          "deprecated": boolean,
          "format": string,
          "pattern": string,
          "minimum": string,
          "maximum": string,
          "enum": [
            string
          ],
          "enumDescriptions": [
            string
          ],
          "enumDeprecated": [
            boolean
          ],
          "repeated": boolean,
          "location": string,
          "properties": {
            (key): (JsonSchema)
          },
          "additionalProperties": (JsonSchema),
          "items": (JsonSchema),
          "annotations": {
            "required": [
              string
            ]
          }
        }
      },
      "parameterOrder": [
        string
      ],
      "request": {
        "$ref": string
      },
      "response": {
        "$ref": string
      },
      "scopes": [
        (value)
      ],
      "supportsMediaDownload": boolean,
      "supportsMediaUpload": boolean,
      "mediaUpload": {
        "accept": [
          string
        ],
        "maxSize": string,
        "protocols": {
          "simple": {
            "multipart": true,
            "path": string
          },
          "resumable": {
            "multipart": true,
            "path": string
          }
        }
      },
      "supportsSubscription": boolean
    }
  },
  "resources": {
    (key): {
      "methods": {
        (key): {
          "id": string,
          "path": string,
          "httpMethod": string,
          "description": string,
          "deprecated": boolean,
          "parameters": {
            (key): {
              "id": string,
              "type": string,
              "$ref": string,
              "description": string,
              "default": string,
              "required": boolean,
              "deprecated": boolean,
              "format": string,
              "pattern": string,
              "minimum": string,
              "maximum": string,
              "enum": [
                string
              ],
              "enumDescriptions": [
                string
              ],
              "enumDeprecated": [
                boolean
              ],
              "repeated": boolean,
              "location": string,
              "properties": {
                (key): (JsonSchema)
              },
              "additionalProperties": (JsonSchema),
              "items": (JsonSchema),
              "annotations": {
                "required": [
                  string
                ]
              }
            }
          },
          "parameterOrder": [
            string
          ],
          "request": {
            "$ref": string
          },
          "response": {
            "$ref": string
          },
          "scopes": [
            (value)
          ],
          "supportsMediaDownload": boolean,
          "supportsMediaUpload": boolean,
          "mediaUpload": {
            "accept": [
              string
            ],
            "maxSize": string,
            "protocols": {
              "simple": {
                "multipart": true,
                "path": string
              },
              "resumable": {
                "multipart": true,
                "path": string
              }
            }
          },
          "supportsSubscription": boolean
        }
      },
      "deprecated": boolean,
      "resources": {
        (key): (RestResource)
      }
    }
  }
}
اسم السمة القيمة الوصف
kind string نوع هذا الردّ. السلسلة الثابتة discovery#restDescription.
discoveryVersion string يشير هذا الحقل إلى إصدار Discovery API المستخدَم لإنشاء هذا المستند.
id string معرّف مستند الاستكشاف الخاص بواجهة برمجة التطبيقات. على سبيل المثال، urlshortener:v1.
name string اسم واجهة برمجة التطبيقات على سبيل المثال، urlshortener.
canonicalName string الاسم الأساسي لواجهة برمجة التطبيقات. على سبيل المثال، Url Shortener.
version string إصدار واجهة برمجة التطبيقات: على سبيل المثال، v1.
revision string مراجعة واجهة برمجة التطبيقات
title string تمثّل هذه السمة عنوان واجهة برمجة التطبيقات. على سبيل المثال، "Google Url Shortener API".
description string وصف واجهة برمجة التطبيقات هذه.
icons object روابط تؤدي إلى رموز بحجم 16x16 و32x32 تمثّل واجهة برمجة التطبيقات
icons.x16 string تمثّل هذه السمة عنوان URL للرمز بحجم 16x16.
icons.x32 string تمثّل هذه السمة عنوان URL للرمز بحجم 32x32.
labels[] list تصنيفات لحالة واجهة برمجة التطبيقات هذه تشمل القيم الصالحة limited_availability أو deprecated.
protocol string البروتوكول الموضّح في المستند على سبيل المثال، REST.
rootUrl string عنوان URL الأساسي الذي تتوفّر فيه جميع خدمات واجهة برمجة التطبيقات.
endpoints[] list قائمة بعناصر نقاط النهاية المستندة إلى الموقع الجغرافي لهذه الواجهة. يحتوي كل عنصر على عنوان URL لنقطة النهاية والموقع الجغرافي والوصف وحالة الإيقاف النهائي.
endpoints[].endpointUrl string عنوان URL للمضيف المستهدف لنقطة النهاية.
endpoints[].location string موقع نقطة النهاية
endpoints[].description string سلسلة تصف المضيف الذي يحدّده عنوان URL
endpoints[].deprecated boolean تُستخدَم لتحديد ما إذا كانت نقطة النهاية هذه متوقّفة نهائيًا.
parameters object المَعلمات الشائعة التي تنطبق على جميع واجهات برمجة التطبيقات
parameters.(key) nested object وصف مَعلمة واحدة
parameters.(key).id string معرّف فريد لهذا المخطط.
parameters.(key).type string تمثّل هذه السمة نوع القيمة لهذا المخطط. يمكنك الاطّلاع على قائمة بالقيم في قسم "النوع" ضمن مخطط JSON.
parameters.(key).$ref string تمثّل هذه السمة مرجعًا إلى مخطط آخر. قيمة هذه السمة هي معرّف مخطط آخر.
parameters.(key).description string تمثّل هذه السمة وصفًا لهذا العنصر.
parameters.(key).default string القيمة التلقائية لهذه السمة (إذا كانت متوفرة)
parameters.(key).required boolean تُستخدَم لتحديد ما إذا كانت المَعلمة مطلوبة.
parameters.(key).format string تعبير عادي أو مفتاح إضافي يساعد في تقييد القيمة. لمزيد من التفاصيل، يُرجى الاطّلاع على ملخّص الأنواع والتنسيقات.
parameters.(key).pattern string التعبير العادي الذي يجب أن تتوافق معه هذه المَعلمة.
parameters.(key).minimum string الحدّ الأدنى لقيمة هذه المَعلمة
parameters.(key).maximum string الحدّ الأقصى لقيمة هذه المَعلمة
parameters.(key).enum[] list القيم التي يمكن أن تأخذها هذه المَعلمة (إذا كانت تعدادًا)
parameters.(key).enumDescriptions[] list أوصاف القيم التعدادية. يتوافق كل موضع مع القيمة المقابلة في صفيف التعداد.
parameters.(key).repeated boolean تحديد ما إذا كان يمكن أن تظهر هذه المَعلمة عدة مرات
parameters.(key).location string تحديد ما إذا كانت هذه المَعلمة ستُدرَج في طلب البحث أو المسار لطلبات REST
parameters.(key).properties object إذا كان هذا مخططًا لكائن، أدرِج مخططًا لكل سمة من سمات هذا الكائن.
parameters.(key).properties.(key) nested object تمثّل هذه السمة سمة واحدة من سمات هذا العنصر. القيمة هي نفسها عنصر JSON Schema يصف هذه السمة.
parameters.(key).additionalProperties nested object إذا كان هذا مخططًا لكائن، تكون هذه السمة هي المخطط لأي سمات إضافية ذات مفاتيح ديناميكية في هذا الكائن.
parameters.(key).items nested object إذا كان هذا المخطط خاصًا بمصفوفة، تكون هذه السمة هي المخطط الخاص بكل عنصر في المصفوفة.
parameters.(key).annotations object معلومات إضافية حول هذا المكان المخصّص للاستئجار
parameters.(key).annotations.required[] list قائمة بالطُرق التي تتطلّب هذه السمة في الطلبات.
auth object معلومات المصادقة
auth.oauth2 object معلومات مصادقة OAuth 2.0
auth.oauth2.scopes object نطاقات OAuth 2.0 المتاحة
auth.oauth2.scopes.(key) object قيمة النطاق.
auth.oauth2.scopes.(key).description string وصف النطاق
features[] list قائمة بالميزات المتوافقة مع واجهة برمجة التطبيقات هذه.
schemas object مخططات هذه الواجهة
schemas.(key) nested object وصف فردي للرسم البياني
schemas.(key).id string معرّف فريد لهذا المخطط. مثلاً: URL
schemas.(key).type string تمثّل هذه السمة نوع القيمة لهذا المخطط. يمكن العثور على قائمة بالقيم في قسم "النوع" في مخطط JSON.
schemas.(key).$ref string تمثّل هذه السمة مرجعًا إلى مخطط آخر. قيمة هذه السمة هي معرّف مخطط آخر.
schemas.(key).description string تمثّل هذه السمة وصفًا لهذا العنصر.
schemas.(key).default string القيمة التلقائية لهذه السمة (إذا كانت متوفرة)
schemas.(key).required boolean تُستخدَم لتحديد ما إذا كانت المَعلمة مطلوبة.
schemas.(key).deprecated boolean تُستخدَم لتحديد ما إذا كان هذا المخطط متوقفًا نهائيًا.
schemas.(key).format string تعبير عادي أو مفتاح إضافي يساعد في تقييد القيمة. لمزيد من التفاصيل، يُرجى الاطّلاع على ملخّص الأنواع والتنسيقات.
schemas.(key).pattern string التعبير العادي الذي يجب أن تتوافق معه هذه المَعلمة.
schemas.(key).minimum string الحدّ الأدنى لقيمة هذه المَعلمة
schemas.(key).maximum string الحدّ الأقصى لقيمة هذه المَعلمة
schemas.(key).enum[] list القيم التي يمكن أن تأخذها هذه المَعلمة (إذا كانت تعدادًا)
schemas.(key).enumDescriptions[] list أوصاف القيم التعدادية. يتوافق كل موضع مع القيمة المناسبة في الصفيف enum.
schemas.(key).enumDeprecated[] list حالة الإيقاف النهائي لقيم التعداد. يتوافق كل موضع مع القيمة المقابلة في الصفيف enum.
schemas.(key).repeated boolean تحديد ما إذا كان يمكن أن تظهر هذه المَعلمة عدة مرات
schemas.(key).location string تحديد ما إذا كانت هذه المَعلمة ستُدرَج في طلب البحث أو المسار لطلبات REST
schemas.(key).properties object إذا كان هذا مخططًا لكائن، أدرِج مخططًا لكل سمة من سمات هذا الكائن.
schemas.(key).properties.(key) nested object تمثّل هذه السمة سمة واحدة من سمات هذا العنصر. القيمة هي نفسها عنصر JSON Schema يصف هذه السمة.
schemas.(key).additionalProperties nested object إذا كان هذا مخططًا لكائن، تكون هذه السمة هي المخطط لأي سمات إضافية ذات مفاتيح ديناميكية في هذا الكائن.
schemas.(key).items nested object إذا كان هذا المخطط خاصًا بمصفوفة، تكون هذه السمة هي المخطط الخاص بكل عنصر في المصفوفة.
schemas.(key).annotations object معلومات إضافية حول هذا المكان المخصّص للاستئجار
schemas.(key).annotations.required[] list قائمة بالطُرق التي تتطلّب هذه السمة في الطلبات.
methods object طُرق على مستوى واجهة برمجة التطبيقات لهذه الواجهة
methods.(key) nested object تمثّل هذه السمة وصفًا لطريقة فردية.
methods.(key).id string معرّف فريد لهذه الطريقة. يمكن استخدام هذه السمة لمطابقة الطرق بين إصدارات مختلفة من Discovery.
methods.(key).description string وصف لهذه الطريقة
methods.(key).deprecated boolean تُستخدَم لتحديد ما إذا كانت هذه الطريقة متوقفة نهائيًا.
methods.(key).parameters object تفاصيل جميع المَعلمات في هذه الطريقة
methods.(key).parameters.(key) nested object تفاصيل مَعلمة واحدة في هذه الطريقة
methods.(key).parameters.(key).id string معرّف فريد لهذا المخطط.
methods.(key).parameters.(key).type string تمثّل هذه السمة نوع القيمة لهذا المخطط.   يمكن العثور على قائمة بالقيم في قسم "النوع" في مخطط JSON.
methods.(key).parameters.(key).$ref string تمثّل هذه السمة مرجعًا إلى مخطط آخر. قيمة هذه السمة هي معرّف مخطط آخر.
methods.(key).parameters.(key).description string تمثّل هذه السمة وصفًا لهذا العنصر.
methods.(key).parameters.(key).default string القيمة التلقائية لهذه السمة (إذا كانت متوفرة)
methods.(key).parameters.(key).required boolean تُستخدَم لتحديد ما إذا كانت المَعلمة مطلوبة.
methods.(key).parameters.(key).deprecated boolean تُستخدَم لتحديد ما إذا كانت المَعلمة متوقفة نهائيًا.
methods.(key).parameters.(key).format string تعبير عادي أو مفتاح إضافي يساعد في تقييد القيمة. لمزيد من التفاصيل، يُرجى الاطّلاع على ملخّص الأنواع والتنسيقات.
methods.(key).parameters.(key).pattern string التعبير العادي الذي يجب أن تتوافق معه هذه المَعلمة.
methods.(key).parameters.(key).minimum string الحدّ الأدنى لقيمة هذه المَعلمة
methods.(key).parameters.(key).maximum string الحدّ الأقصى لقيمة هذه المَعلمة
methods.(key).parameters.(key).enum[] list القيم التي يمكن أن تأخذها هذه المَعلمة (إذا كانت تعدادًا)
methods.(key).parameters.(key).enumDescriptions[] list أوصاف القيم التعدادية. يتوافق كل موضع مع القيمة المناسبة في الصفيف enum.
methods.(key).parameters.(key).enumDeprecated[] list حالة الإيقاف النهائي لقيم التعداد. يتوافق كل موضع مع القيمة المقابلة في الصفيف enum.
methods.(key).parameters.(key).repeated boolean تحديد ما إذا كان يمكن أن تظهر هذه المَعلمة عدة مرات
methods.(key).parameters.(key).location string تحديد ما إذا كانت هذه المَعلمة ستُدرَج في طلب البحث أو المسار لطلبات REST
methods.(key).parameters.(key).properties object إذا كان هذا مخططًا لكائن، أدرِج مخططًا لكل سمة من سمات هذا الكائن.
methods.(key).parameters.(key).properties.(key) nested object تمثّل هذه السمة سمة واحدة من سمات هذا العنصر. القيمة هي نفسها عنصر JSON Schema يصف هذه السمة.
methods.(key).parameters.(key).additionalProperties nested object إذا كان هذا مخططًا لكائن، تكون هذه السمة هي المخطط لأي سمات إضافية ذات مفاتيح ديناميكية في هذا الكائن.
methods.(key).parameters.(key).items nested object إذا كان هذا المخطط خاصًا بمصفوفة، تكون هذه السمة هي المخطط الخاص بكل عنصر في المصفوفة.
methods.(key).parameters.(key).annotations object معلومات إضافية حول هذا المكان المخصّص للاستئجار
methods.(key).parameters.(key).annotations.required[] list قائمة بالطُرق التي تتطلّب هذه السمة في الطلبات.
methods.(key).parameterOrder[] list قائمة مرتّبة بالمعلَمات المطلوبة ويُستخدَم هذا كإشارة للعملاء حول كيفية تنظيم توقيعات الطرق. يتم ترتيب المصفوفة بحيث تظهر المَعلمة الأكثر أهمية أولاً.
methods.(key).scopes[] list نطاقات OAuth 2.0 التي تنطبق على هذه الطريقة
methods.(key).supportsMediaDownload boolean تُستخدَم لتحديد ما إذا كانت هذه الطريقة تتيح تنزيل الوسائط.
methods.(key).supportsMediaUpload boolean تُستخدَم لتحديد ما إذا كانت هذه الطريقة تتيح تحميل الوسائط.
methods.(key).mediaUpload object مَعلمات تحميل الوسائط
methods.(key).mediaUpload.accept[] list نطاقات وسائط MIME لعمليات تحميل الوسائط المقبولة إلى هذه الطريقة
methods.(key).mediaUpload.maxSize string الحد الأقصى لحجم ملف الوسائط الذي يتم تحميله، مثل "1 ميغابايت" أو "2 غيغابايت" أو "3 تيرابايت"
methods.(key).supportsSubscription boolean تُستخدَم لتحديد ما إذا كانت طريقة الدفع هذه تتيح الاشتراكات.
baseUrl string [تم إيقافها نهائيًا] عنوان URL الأساسي لطلبات REST.
basePath string [تم إيقافها نهائيًا] المسار الأساسي لطلبات REST.
servicePath string المسار الأساسي لجميع طلبات REST.
batchPath string مسار الطلبات المجمّعة في REST
methods.(key).path string مسار معرّف الموارد المنتظم (URI) لطريقة REST هذه. يجب استخدامها مع السمة servicePath على مستوى واجهة برمجة التطبيقات.
methods.(key).httpMethod string طريقة HTTP المستخدَمة في هذه الطريقة.
methods.(key).request object مخطط الطلب
methods.(key).request.$ref string معرّف المخطط الخاص بمخطط الطلب
methods.(key).request.parameterName string [تم إيقاف هذا الحقل نهائيًا] تتضمّن بعض واجهات برمجة التطبيقات هذا الحقل لأسباب تتعلّق بالتوافق مع الإصدارات القديمة. ويمكن تجاهله بأمان.
methods.(key).response object مخطط الردّ
methods.(key).response.$ref string رقم تعريف المخطط الخاص بالردّ
methods.(key).mediaUpload.protocols object بروتوكولات التحميل المتوافقة
methods.(key).mediaUpload.protocols.simple object يتيح إمكانية التحميل كطلب HTTP واحد.
methods.(key).mediaUpload.protocols.simple.multipart boolean تكون القيمة "صحيح" إذا كانت نقطة النهاية هذه تتيح تحميل وسائط متعددة الأجزاء.
methods.(key).mediaUpload.protocols.simple.path string مسار معرّف URI الذي سيتم استخدامه للتحميل يجب استخدامها مع السمة rootURL على مستوى واجهة برمجة التطبيقات.
methods.(key).mediaUpload.protocols.resumable object يتوافق مع بروتوكول "تحميل الوسائط القابل للاستئناف".
methods.(key).mediaUpload.protocols.resumable.multipart boolean true إذا كانت نقطة النهاية هذه تتيح تحميل وسائط متعددة الأجزاء
methods.(key).mediaUpload.protocols.resumable.path string مسار معرّف URI الذي سيتم استخدامه للتحميل يجب استخدامها مع السمة rootURL على مستوى واجهة برمجة التطبيقات.
resources object المراجع في واجهة برمجة التطبيقات هذه
resources.(key) nested object تمثّل هذه السمة وصفًا لمورد فردي. تحتوي على طرق ومراجع فرعية ذات صلة بهذا المرجع.
resources.(key).methods object الطُرق المتاحة في هذا المرجع
resources.(key).methods.(key) nested object وصف لأي طرق في هذا المرجع
resources.(key).methods.(key).id string معرّف فريد لهذه الطريقة. يمكن استخدام هذه السمة لمطابقة الطرق بين إصدارات مختلفة من Discovery.
resources.(key).methods.(key).path string مسار معرّف الموارد المنتظم (URI) لطريقة REST هذه. يجب استخدامها مع السمة servicePath على مستوى واجهة برمجة التطبيقات.
resources.(key).methods.(key).flatPath string مسار معرّف الموارد المنتظم لطريقة REST هذه بتنسيق (RFC 6570) بدون ميزات المستوى 2 ({+var}). تكمّل هذه السمة السمة path.
resources.(key).methods.(key).httpMethod string طريقة HTTP المستخدَمة في هذه الطريقة.
resources.(key).methods.(key).description string وصف لهذه الطريقة
resources.(key).methods.(key).deprecated boolean تُستخدَم لتحديد ما إذا كانت هذه الطريقة متوقفة نهائيًا.
resources.(key).methods.(key).parameters object تفاصيل جميع المَعلمات في هذه الطريقة
resources.(key).methods.(key).parameters.(key) nested object تفاصيل مَعلمة واحدة في هذه الطريقة
resources.(key).methods.(key).parameters.(key).id string معرّف فريد لهذا المخطط.
resources.(key).methods.(key).parameters.(key).type string تمثّل هذه السمة نوع القيمة لهذا المخطط.  يمكن العثور على قائمة بالقيم في قسم "النوع" في مخطط JSON.
resources.(key).methods.(key).parameters.(key).$ref string تمثّل هذه السمة مرجعًا إلى مخطط آخر. قيمة هذه السمة هي "رقم التعريف" لمخطط آخر.
resources.(key).methods.(key).parameters.(key).description string تمثّل هذه السمة وصفًا لهذا العنصر.
resources.(key).methods.(key).parameters.(key).default string القيمة التلقائية لهذه السمة (إذا كانت متوفرة)
resources.(key).methods.(key).parameters.(key).required boolean تُستخدَم لتحديد ما إذا كانت المَعلمة مطلوبة.
resources.(key).methods.(key).parameters.(key).deprecated boolean تُستخدَم لتحديد ما إذا كانت المَعلمة متوقفة نهائيًا.
resources.(key).methods.(key).parameters.(key).format string تعبير عادي أو مفتاح إضافي يساعد في تقييد القيمة. لمزيد من التفاصيل، يُرجى الاطّلاع على ملخّص الأنواع والتنسيقات.
resources.(key).methods.(key).parameters.(key).pattern string التعبير العادي الذي يجب أن تتوافق معه هذه المَعلمة.
resources.(key).methods.(key).parameters.(key).minimum string الحدّ الأدنى لقيمة هذه المَعلمة
resources.(key).methods.(key).parameters.(key).maximum string الحدّ الأقصى لقيمة هذه المَعلمة
resources.(key).methods.(key).parameters.(key).enum[] list القيم التي يمكن أن تأخذها هذه المَعلمة (إذا كانت تعدادًا)
resources.(key).methods.(key).parameters.(key).enumDescriptions[] list أوصاف القيم التعدادية. يتوافق كل موضع مع القيمة المناسبة في الصفيف enum.
resources.(key).methods.(key).parameters.(key).enumDeprecated[] list حالة الإيقاف النهائي لقيم التعداد. يتوافق كل موضع مع القيمة المقابلة في الصفيف enum.
resources.(key).methods.(key).parameters.(key).repeated boolean تحديد ما إذا كان يمكن أن تظهر هذه المَعلمة عدة مرات
resources.(key).methods.(key).parameters.(key).location string تحديد ما إذا كانت هذه المَعلمة ستُدرَج في طلب البحث أو المسار لطلبات REST
resources.(key).methods.(key).parameters.(key).properties object إذا كان هذا مخططًا لكائن، أدرِج مخططًا لكل سمة من سمات هذا الكائن.
resources.(key).methods.(key).parameters.(key).properties.(key) nested object تمثّل هذه السمة سمة واحدة من سمات هذا العنصر. القيمة هي نفسها عنصر JSON Schema يصف هذه السمة.
resources.(key).methods.(key).parameters.(key).additionalProperties nested object إذا كان هذا مخططًا لكائن، تكون هذه السمة هي المخطط لأي سمات إضافية ذات مفاتيح ديناميكية في هذا الكائن.
resources.(key).methods.(key).parameters.(key).items nested object إذا كان هذا المخطط خاصًا بمصفوفة، تكون هذه السمة هي المخطط الخاص بكل عنصر في المصفوفة.
resources.(key).methods.(key).parameters.(key).annotations object معلومات إضافية حول هذا المكان المخصّص للاستئجار
resources.(key).methods.(key).parameters.(key).annotations.required[] list قائمة بالطُرق التي تتطلّب هذه السمة في الطلبات.
resources.(key).methods.(key).parameterOrder[] list قائمة مرتّبة بالمعلَمات المطلوبة ويُستخدَم هذا كإشارة للعملاء حول كيفية تنظيم توقيعات الطرق. يتم ترتيب المصفوفة بحيث تظهر المَعلمة الأكثر أهمية أولاً.
resources.(key).methods.(key).request object مخطط الطلب
resources.(key).methods.(key).request.$ref string معرّف المخطط الخاص بمخطط الطلب
resources.(key).methods.(key).response object مخطط الردّ
resources.(key).methods.(key).response.$ref string رقم تعريف المخطط الخاص بالردّ
resources.(key).methods.(key).scopes[] list نطاقات OAuth 2.0 التي تنطبق على هذه الطريقة
resources.(key).methods.(key).supportsMediaDownload boolean تُستخدَم لتحديد ما إذا كانت هذه الطريقة تتيح تنزيل الوسائط.
resources.(key).methods.(key).supportsMediaUpload boolean تُستخدَم لتحديد ما إذا كانت هذه الطريقة تتيح تحميل الوسائط.
resources.(key).methods.(key).mediaUpload object مَعلمات تحميل الوسائط
resources.(key).methods.(key).mediaUpload.accept[] list نطاقات وسائط MIME لعمليات تحميل الوسائط المقبولة إلى هذه الطريقة
resources.(key).methods.(key).mediaUpload.maxSize string الحد الأقصى لحجم ملف الوسائط الذي يتم تحميله، مثل "1 ميغابايت" أو "2 غيغابايت" أو "3 تيرابايت"
resources.(key).methods.(key).mediaUpload.protocols object بروتوكولات التحميل المتوافقة
resources.(key).methods.(key).mediaUpload.protocols.simple object يتيح إمكانية التحميل كطلب HTTP واحد.
resources.(key).methods.(key).mediaUpload.protocols.simple.multipart boolean true إذا كانت نقطة النهاية هذه تتيح تحميل وسائط متعددة الأجزاء
resources.(key).methods.(key).mediaUpload.protocols.simple.path string مسار معرّف URI الذي سيتم استخدامه للتحميل يجب استخدامها مع السمة rootURL على مستوى واجهة برمجة التطبيقات.
resources.(key).methods.(key).mediaUpload.protocols.resumable object يتوافق مع بروتوكول "تحميل الوسائط القابل للاستئناف".
resources.(key).methods.(key).mediaUpload.protocols.resumable.multipart boolean true إذا كانت نقطة النهاية هذه تتيح تحميل وسائط متعددة الأجزاء
resources.(key).methods.(key).mediaUpload.protocols.resumable.path string مسار معرّف URI الذي سيتم استخدامه للتحميل يجب استخدامها مع السمة rootURL على مستوى واجهة برمجة التطبيقات.
resources.(key).methods.(key).supportsSubscription boolean تُستخدَم لتحديد ما إذا كانت طريقة الدفع هذه تتيح الاشتراكات.
resources.(key).deprecated boolean تُستخدَم لتحديد ما إذا كان هذا المرجع متوقفًا نهائيًا.
resources.(key).resources object الموارد الفرعية في هذا المرجع
resources.(key).resources.(key) nested object وصف لأي موارد فرعية في هذا المورد