Method: documents.get

इस तरीके से, चुने गए दस्तावेज़ का नया वर्शन मिलता है.

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

GET https://docs.googleapis.com/v1/documents/{documentId}

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

पाथ पैरामीटर

पैरामीटर
documentId

string

उस दस्तावेज़ का आईडी जिसे वापस पाना है.

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

पैरामीटर
suggestionsViewMode

enum (SuggestionsViewMode)

दस्तावेज़ पर सुझाव देखने का मोड. इससे दस्तावेज़ में सभी सुझावों को इनलाइन तरीके से देखा जा सकता है. साथ ही, यह भी देखा जा सकता है कि कौनसे सुझाव स्वीकार किए गए हैं और कौनसे अस्वीकार किए गए हैं. अगर कोई विकल्प नहीं चुना जाता है, तो DEFAULT_FOR_CURRENT_ACCESS का इस्तेमाल किया जाता है.
includeTabsContent

boolean

Document पर, टेक्स्ट कॉन्टेंट वाले फ़ील्ड, जैसे कि body और documentStyle के बजाय Document.tabs फ़ील्ड में जानकारी भरनी है या नहीं.

  • true: दस्तावेज़ का कॉन्टेंट, Document में मौजूद टेक्स्ट कॉन्टेंट फ़ील्ड के बजाय, Document.tabs फ़ील्ड में अपने-आप भर जाता है.

  • false के लिए: दस्तावेज़ के पहले टैब का कॉन्टेंट, Document में मौजूद कॉन्टेंट फ़ील्ड में अपने-आप भर जाता है. इसमें Document.tabs शामिल नहीं है. अगर किसी दस्तावेज़ में सिर्फ़ एक टैब है, तो दस्तावेज़ के कॉन्टेंट को भरने के लिए उस टैब का इस्तेमाल किया जाता है. Document.tabs खाली हो जाएगा.

अगर आपने फ़ील्ड मास्क का इस्तेमाल किया है, जो Document.tabs फ़ील्ड (या कोई सब-फ़ील्ड) दिखाता है, तो एपीआई अनुरोध को इस तरह से प्रोसेस करेगा जैसे आपने includeTabsContent को true पर सेट किया हो.
commentsViewMode

enum (CommentsViewMode)

दस्तावेज़ पर टिप्पणियां देखने का मोड. इससे टिप्पणियों के साथ या उनके बिना दस्तावेज़ देखा जा सकता है. अगर कोई विकल्प नहीं चुना जाता है, तो COMMENTS_VIEW_MODE_OMITTED का इस्तेमाल किया जाता है.

अगर आपने commentsViewMode को किसी वैल्यू पर सेट किया है, तो आपको includeTabsContent को true पर भी सेट करना होगा. इसके अलावा, Document.tabs फ़ील्ड (या कोई भी सब-फ़ील्ड) का रेफ़रंस देने वाले फ़ील्ड मास्क का इस्तेमाल किया जा सकता है.

commentsViewMode को COMMENTS_VIEW_MODE_INCLUDED पर सेट करने पर, आपको suggestionsViewMode को SUGGESTIONS_INLINE पर भी सेट करना होगा.

अगर आपने commentsViewMode को COMMENTS_VIEW_MODE_INCLUDED या COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS पर सेट किया है, तो suggestionsViewMode को PREVIEW_WITHOUT_SUGGESTIONS या PREVIEW_SUGGESTIONS_ACCEPTED पर सेट नहीं किया जा सकता.

अनुरोध का मुख्य भाग

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

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

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

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

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

  • https://www.googleapis.com/auth/documents
  • https://www.googleapis.com/auth/documents.readonly
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive.file

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.