مستند Discovery

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

الطُرق

يركّز مستند Discovery على طريقة REST API لاستدعاء واجهة برمجة التطبيقات. تعرض طريقة discovery.apis.list جميع واجهات برمجة التطبيقات التي تتوافق مع خدمة استكشاف واجهات Google API، بما في ذلك عناوين 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 المستخدمة لإنشاء هذا المستند.
id string رقم تعريف مستند Discovery لواجهة برمجة التطبيقات. مثلاً: urlshortener:v1.
name string اسم واجهة برمجة التطبيقات: مثلاً، urlshortener.
canonicalName string الاسم الأساسي لواجهة برمجة التطبيقات: مثلاً، Url Shortener.
version string إصدار واجهة برمجة التطبيقات: مثلاً: v1.
revision string مراجعة واجهة برمجة التطبيقات
title string عنوان واجهة برمجة التطبيقات: على سبيل المثال، "Google Url Shortener API".
description string يعرض هذا الحقل وصف واجهة برمجة التطبيقات هذه.
icons object روابط إلى رموز 16×16 و32×32 تمثل واجهة برمجة التطبيقات.
icons.x16 string عنوان URL للرمز 16×16.
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 نوع القيمة لهذا المخطط. يمكن العثور على قائمة بالقيم في القسم"type" ضمن مخطط 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 لمخطط JSON يصف هذه السمة.
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 نوع القيمة لهذا المخطط. يمكن العثور على قائمة بالقيم في قسم "type" ضمن مخطط 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 لمخطط JSON يصف هذه السمة.
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 لمخطط JSON يصف هذه السمة.
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 مسار معرّف الموارد المنتظم (URI) لطريقة 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 لمخطط JSON يصف هذه السمة.
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 وصف أي موارد فرعية حول هذا المورد