खोज से जुड़ा दस्तावेज़

डिस्कवरी दस्तावेज़ ज़्यादातर एपीआई के खास वर्शन के लिए उपलब्ध हैं. हर एपीआई के डिस्कवरी दस्तावेज़ में, एपीआई के प्लैटफ़ॉर्म के बारे में बताया जाता है. साथ ही, यह बताया गया है कि एपीआई को कैसे ऐक्सेस किया जाता है और एपीआई के अनुरोधों और जवाबों को कैसे मैनेज किया जाता है. खोज से जुड़े दस्तावेज़ में दी गई जानकारी में एपीआई लेवल की प्रॉपर्टी शामिल होती हैं, जैसे कि एपीआई की जानकारी, रिसॉर्स स्कीमा, पुष्टि करने के दायरे, और तरीके.

तरीके

डिस्कवरी दस्तावेज़ में, एपीआई को शुरू करने के RESTful तरीके पर ध्यान दिया जाता है.  discovery.apis.list तरीका, Google API Discovery Service के साथ काम करने वाले सभी एपीआई की सूची दिखाता है. इसमें, 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 Shorter API".
description string इस एपीआई के बारे में जानकारी.
icons object एपीआई दिखाने वाले 16x16 और 32x32 आइकॉन के लिंक.
icons.x16 string 16x16 आइकॉन का यूआरएल.
icons.x32 string 32x32 आइकॉन का यूआरएल.
labels[] list इस एपीआई की स्थिति के लिए लेबल. सही वैल्यू में limited_availability या deprecated शामिल हैं.
protocol string दस्तावेज़ में बताए गए प्रोटोकॉल. उदाहरण के लिए, REST.
rootUrl string रूट यूआरएल, जिससे सभी एपीआई सेवाएं मिलती हैं.
endpoints[] list इस एपीआई के लिए, जगह के हिसाब से एंडपॉइंट ऑब्जेक्ट की सूची. हर ऑब्जेक्ट में एंडपॉइंट यूआरएल, जगह, विवरण, और समर्थन नहीं होने की स्थिति होती है.
endpoints[].endpointUrl string एंडपॉइंट टारगेट होस्ट का यूआरएल.
endpoints[].location string एंडपॉइंट की जगह.
endpoints[].description string यूआरएल से जुड़े होस्ट की जानकारी देने वाली स्ट्रिंग.
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 अगर यह enum है, तो इस पैरामीटर में दिखने वाली वैल्यू.
parameters.(key).enumDescriptions[] list Enum का विवरण. हर पोज़िशन, Enum ऐरे में मौजूद वैल्यू के लिए मैप होता है.
parameters.(key).repeated boolean यह पैरामीटर कई बार दिख सकता है या नहीं.
parameters.(key).location string यह पैरामीटर क्वेरी में जाता है या REST के अनुरोधों के पाथ में.
parameters.(key).properties object अगर यह किसी ऑब्जेक्ट के लिए स्कीमा है, तो इस ऑब्जेक्ट की हर प्रॉपर्टी के लिए स्कीमा की सूची बनाएं.
parameters.(key).properties.(key) nested object इस ऑब्जेक्ट की एक प्रॉपर्टी. वैल्यू, इस प्रॉपर्टी के बारे में बताने वाला 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 इस स्कीमा के लिए वैल्यू का टाइप. गड़बड़ियों की सूची देखने के लिए, 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 अगर यह enum है, तो इस पैरामीटर में दिखने वाली वैल्यू.
schemas.(key).enumDescriptions[] list Enum का विवरण. हर पोज़िशन, enum ऐरे में मौजूद वैल्यू के हिसाब से मैप होती है.
schemas.(key).enumDeprecated[] list Enum की सपोर्ट बंद होने की स्थिति. हर पोज़िशन, enum ऐरे में मौजूद वैल्यू के हिसाब से मैप होती है.
schemas.(key).repeated boolean यह पैरामीटर कई बार दिख सकता है या नहीं.
schemas.(key).location string यह पैरामीटर क्वेरी में जाता है या REST के अनुरोधों के पाथ में.
schemas.(key).properties object अगर यह किसी ऑब्जेक्ट के लिए स्कीमा है, तो इस ऑब्जेक्ट की हर प्रॉपर्टी के लिए स्कीमा की सूची बनाएं.
schemas.(key).properties.(key) nested object इस ऑब्जेक्ट की एक प्रॉपर्टी. वैल्यू, इस प्रॉपर्टी के बारे में बताने वाला 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 इस तरीके के लिए यूनीक आईडी. इस प्रॉपर्टी का इस्तेमाल, डिस्कवरी के अलग-अलग वर्शन में बताए गए तरीकों से मिलान करने के लिए किया जा सकता है.
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 इस स्कीमा के लिए वैल्यू का टाइप. जेएसओएन स्कीमा में "टाइप" सेक्शन में वैल्यू की सूची मिल सकती है.
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 अगर यह enum है, तो इस पैरामीटर में दिखने वाली वैल्यू.
methods.(key).parameters.(key).enumDescriptions[] list Enum का विवरण. हर पोज़िशन, enum ऐरे में मौजूद वैल्यू के हिसाब से मैप होती है.
methods.(key).parameters.(key).enumDeprecated[] list Enum की सपोर्ट बंद होने की स्थिति. हर पोज़िशन, 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 स्कीमा ऑब्जेक्ट होता है.
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 मीडिया अपलोड का अधिकतम आकार, जैसे "1MB", "2GB" या "3TB".
methods.(key).supportsSubscription boolean इस तरीके से सदस्यताएं ली जा सकती हैं या नहीं.
baseUrl string [अस्वीकार किया गया] REST के अनुरोधों के लिए बेस यूआरएल.
basePath string [अस्वीकार किया गया] REST के अनुरोधों के लिए बेस पाथ.
servicePath string सभी REST अनुरोधों के लिए बेस पाथ.
batchPath string REST के बैच रिक्वेस्ट का पाथ.
methods.(key).path string इस REST तरीके का यूआरआई पाथ. इसका इस्तेमाल एपीआई लेवल पर servicePath प्रॉपर्टी के साथ किया जाना चाहिए.
methods.(key).httpMethod string इस तरीके में इस्तेमाल किया गया एचटीटीपी तरीका.
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 इसे एक एचटीटीपी अनुरोध के तौर पर अपलोड किया जा सकता है.
methods.(key).mediaUpload.protocols.simple.multipart boolean अगर एंडपॉइंट कई अपलोड मीडिया का इस्तेमाल करता है, तो 'सही'.
methods.(key).mediaUpload.protocols.simple.path string अपलोड करने के लिए इस्तेमाल किया जाने वाला यूआरआई पाथ. इसका इस्तेमाल, एपीआई लेवल पर rootURL प्रॉपर्टी के साथ किया जाना चाहिए.
methods.(key).mediaUpload.protocols.resumable object फिर से शुरू किए जा सकने वाले मीडिया अपलोड प्रोटोकॉल के साथ काम करता है.
methods.(key).mediaUpload.protocols.resumable.multipart boolean अगर यह एंडपॉइंट एक से ज़्यादा हिस्सों वाला मीडिया अपलोड करने की सुविधा देता है, तो true.
methods.(key).mediaUpload.protocols.resumable.path string अपलोड करने के लिए इस्तेमाल किया जाने वाला यूआरआई पाथ. इसका इस्तेमाल एपीआई लेवल पर rootURL प्रॉपर्टी के साथ किया जाना चाहिए.
resources object इस एपीआई में मौजूद रिसॉर्स.
resources.(key) nested object व्यक्तिगत संसाधन का ब्यौरा. इसमें इस रिसॉर्स से जुड़े तरीके और सब-रिसॉर्स शामिल हैं.
resources.(key).methods object इस रिसॉर्स के लिए उपलब्ध तरीके.
resources.(key).methods.(key) nested object इस रिसॉर्स में मौजूद किसी भी तरीके के बारे में जानकारी.
resources.(key).methods.(key).id string इस तरीके के लिए यूनीक आईडी. इस प्रॉपर्टी का इस्तेमाल, डिस्कवरी के अलग-अलग वर्शन में बताए गए तरीकों से मिलान करने के लिए किया जा सकता है.
resources.(key).methods.(key).path string इस REST तरीके का यूआरआई पाथ. इसका इस्तेमाल एपीआई लेवल पर servicePath प्रॉपर्टी के साथ किया जाना चाहिए.
resources.(key).methods.(key).flatPath string इस REST तरीके का यूआरआई पाथ 2 सुविधाओं ({+var}) के बिना (RFC 6570) फ़ॉर्मैट में है. path प्रॉपर्टी का पूरक.
resources.(key).methods.(key).httpMethod string इस तरीके में इस्तेमाल किया गया एचटीटीपी तरीका.
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 इस स्कीमा के लिए वैल्यू का टाइप. जेएसओएन स्कीमा में "टाइप" सेक्शन में वैल्यू की सूची मिल सकती है.
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 अगर यह enum है, तो इस पैरामीटर में दिखने वाली वैल्यू.
resources.(key).methods.(key).parameters.(key).enumDescriptions[] list Enum का विवरण. हर पोज़िशन, enum ऐरे में मौजूद वैल्यू के हिसाब से मैप होती है.
resources.(key).methods.(key).parameters.(key).enumDeprecated[] list Enum की सपोर्ट बंद होने की स्थिति. हर पोज़िशन, 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 स्कीमा ऑब्जेक्ट होता है.
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 मीडिया अपलोड का अधिकतम आकार, जैसे "1MB", "2GB" या "3TB".
resources.(key).methods.(key).mediaUpload.protocols object अपलोड करने के लिए इस्तेमाल किए जा सकने वाले प्रोटोकॉल.
resources.(key).methods.(key).mediaUpload.protocols.simple object इसे एक एचटीटीपी अनुरोध के तौर पर अपलोड किया जा सकता है.
resources.(key).methods.(key).mediaUpload.protocols.simple.multipart boolean अगर यह एंडपॉइंट एक से ज़्यादा हिस्सों वाले मीडिया को अपलोड करने की सुविधा देता है, तो true.
resources.(key).methods.(key).mediaUpload.protocols.simple.path string अपलोड करने के लिए इस्तेमाल किया जाने वाला यूआरआई पाथ. इसका इस्तेमाल एपीआई लेवल पर 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 अपलोड करने के लिए इस्तेमाल किया जाने वाला यूआरआई पाथ. इसका इस्तेमाल एपीआई लेवल पर rootURL प्रॉपर्टी के साथ किया जाना चाहिए.
resources.(key).methods.(key).supportsSubscription boolean इस तरीके से सदस्यताएं ली जा सकती हैं या नहीं.
resources.(key).deprecated boolean इस रिसॉर्स के इस्तेमाल पर रोक लगाई गई है या नहीं.
resources.(key).resources object इस संसाधन पर मौजूद सभी संसाधन.
resources.(key).resources.(key) nested object इस रिसॉर्स से जुड़े किसी भी सब-रिसॉर्स के बारे में जानकारी.