Method: documents.get

इससे, मार्कडाउन के पूरे कॉन्टेंट वाला कोई एक दस्तावेज़ वापस मिलता है.

एचटीटीपी अनुरोध

GET https://developerknowledge.googleapis.com/v1alpha/{name=documents/**}

यह यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

पाथ पैरामीटर

पैरामीटर
name

string

ज़रूरी है. इससे, वापस पाने के लिए दस्तावेज़ का नाम तय किया जाता है. फ़ॉर्मैट: documents/{uri_without_scheme} उदाहरण: documents/docs.cloud.google.com/storage/docs/creating-buckets

नाम में 500 से ज़्यादा वर्ण नहीं होने चाहिए. अगर नाम में 500 से ज़्यादा वर्ण होते हैं, तो INVALID_ARGUMENT गड़बड़ी दिखेगी.

क्वेरी पैरामीटर

पैरामीटर
view

enum (DocumentView)

ज़रूरी नहीं. इससे, दस्तावेज़ का DocumentView तय किया जाता है. अगर कोई वैल्यू तय नहीं की जाती है, तो DeveloperKnowledge.GetDocument के लिए डिफ़ॉल्ट रूप से DOCUMENT_VIEW_CONTENT वैल्यू सेट होती है.

अनुरोध का मुख्य हिस्सा

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

जवाब का मुख्य भाग

कामयाब रहने पर, जवाब के मुख्य हिस्से में Document का एक इंस्टेंस शामिल किया जाता है.

अनुमति पाने के लिंक

इसके लिए, इनमें से किसी एक OAuth अनुमति की ज़रूरत होती है:

  • https://www.googleapis.com/auth/devprofiles.full_control
  • https://www.googleapis.com/auth/developerprofiles.readonly
  • https://www.googleapis.com/auth/cloud-platform

ज़्यादा जानकारी के लिए, देखें OAuth 2.0 Overview.