Method: documents.create

अनुरोध में दिए गए शीर्षक का इस्तेमाल करके, खाली दस्तावेज़ बनाया जाता है. अनुरोध में मौजूद अन्य फ़ील्ड को अनदेखा कर दिया जाता है. इनमें दिया गया कॉन्टेंट भी शामिल है.

बनाया गया दस्तावेज़ दिखाया जाता है.

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

POST https://docs.googleapis.com/v1/documents

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

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

अनुरोध के मुख्य हिस्से में, इस स्ट्रक्चर का डेटा शामिल होता है:

JSON के काेड में दिखाना 
{
  "documentId": string,
  "title": string,
  "tabs": [
    {
      object (Tab)
    }
  ],
  "revisionId": string,
  "suggestionsViewMode": enum (SuggestionsViewMode),
  "commentsViewMode": enum (CommentsViewMode),
  "comments": [
    {
      object (CommentThread)
    }
  ],
  "suggestions": [
    {
      object (SuggestionThread)
    }
  ],
  "body": {
    object (Body)
  },
  "headers": {
    string: {
      object (Header)
    },
    ...
  },
  "footers": {
    string: {
      object (Footer)
    },
    ...
  },
  "footnotes": {
    string: {
      object (Footnote)
    },
    ...
  },
  "documentStyle": {
    object (DocumentStyle)
  },
  "suggestedDocumentStyleChanges": {
    string: {
      object (SuggestedDocumentStyle)
    },
    ...
  },
  "namedStyles": {
    object (NamedStyles)
  },
  "suggestedNamedStylesChanges": {
    string: {
      object (SuggestedNamedStyles)
    },
    ...
  },
  "lists": {
    string: {
      object (List)
    },
    ...
  },
  "namedRanges": {
    string: {
      object (NamedRanges)
    },
    ...
  },
  "inlineObjects": {
    string: {
      object (InlineObject)
    },
    ...
  },
  "positionedObjects": {
    string: {
      object (PositionedObject)
    },
    ...
  }
}
फ़ील्ड
documentId

string

सिर्फ़ आउटपुट के लिए. दस्तावेज़ का आईडी.
title

string

दस्तावेज़ का शीर्षक.
tabs[]

object (Tab)

दस्तावेज़ में शामिल टैब.

टैब में चाइल्ड टैब हो सकते हैं. इसका मतलब है कि एक टैब, दूसरे टैब में नेस्ट किया जा सकता है. चाइल्ड टैब को Tab.childTabs फ़ील्ड से दिखाया जाता है.
revisionId

string

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

रिविज़न आईडी, क्रम से दिया गया नंबर नहीं होता. यह एक अपारदर्शी स्ट्रिंग होती है. रिविज़न आईडी का फ़ॉर्मैट समय के साथ बदल सकता है. रिविज़न आईडी, जवाब के तौर पर मिलने के बाद सिर्फ़ 24 घंटे तक मान्य होता है. इसे उपयोगकर्ताओं के बीच शेयर नहीं किया जा सकता. अगर कॉल के बीच रिविज़न आईडी में कोई बदलाव नहीं होता है, तो इसका मतलब है कि दस्तावेज़ में कोई बदलाव नहीं किया गया है. इसके उलट, अगर एक ही दस्तावेज़ और उपयोगकर्ता के लिए आईडी बदलता है, तो इसका मतलब है कि दस्तावेज़ को अपडेट किया गया है. हालांकि, आईडी फ़ॉर्मैट में बदलाव जैसे अंदरूनी वजहों से भी आईडी बदल सकता है.
suggestionsViewMode

enum (SuggestionsViewMode)

सिर्फ़ आउटपुट के लिए. दस्तावेज़ पर लागू किया गया सुझावों का व्यू मोड.

ध्यान दें: किसी दस्तावेज़ में बदलाव करते समय, बदलाव SUGGESTIONS_INLINE वाले दस्तावेज़ के आधार पर किए जाने चाहिए.
commentsViewMode

enum (CommentsViewMode)

सिर्फ़ आउटपुट के लिए. दस्तावेज़ पर लागू किया गया टिप्पणियों का व्यू मोड.

comments[]

object (CommentThread)

सिर्फ़ आउटपुट के लिए. दस्तावेज़ से जुड़ी टिप्पणियां. यह फ़ील्ड, सिर्फ़ तब दिखता है, जब commentsViewMode पैरामीटर को टिप्पणियां दिखाने के लिए सेट किया जाता है. जैसे, COMMENTS_VIEW_MODE_INCLUDED.

suggestions[]

object (SuggestionThread)

सिर्फ़ आउटपुट के लिए. दस्तावेज़ से जुड़े सुझाव. यह फ़ील्ड, सिर्फ़ तब दिखता है, जब commentsViewMode पैरामीटर को टिप्पणियां दिखाने के लिए सेट किया जाता है. जैसे, COMMENTS_VIEW_MODE_INCLUDED.

body

object (Body)

सिर्फ़ आउटपुट के लिए. दस्तावेज़ का मुख्य हिस्सा.

लेगसी फ़ील्ड: इसके बजाय, Document.tabs.documentTab.body का इस्तेमाल करें. इससे, includeTabsContent पैरामीटर को true पर सेट करने पर, सभी टैब से दस्तावेज़ का असल कॉन्टेंट दिखता है. अगर इसे false पर सेट किया जाता है या इसकी कोई वैल्यू सेट नहीं की जाती है, तो इस फ़ील्ड में दस्तावेज़ के पहले टैब के बारे में जानकारी होती है.
headers

map (key: string, value: object (Header))

सिर्फ़ आउटपुट के लिए. दस्तावेज़ में मौजूद हेडर. इन्हें हेडर आईडी के हिसाब से क्रम में लगाया जाता है.

लेगसी फ़ील्ड: इसके बजाय, Document.tabs.documentTab.headers का इस्तेमाल करें. इससे, includeTabsContent पैरामीटर को true पर सेट करने पर, सभी टैब से दस्तावेज़ का असल कॉन्टेंट दिखता है. अगर इसे false पर सेट किया जाता है या इसकी कोई वैल्यू सेट नहीं की जाती है, तो इस फ़ील्ड में दस्तावेज़ के पहले टैब के बारे में जानकारी होती है.
footers

map (key: string, value: object (Footer))

सिर्फ़ आउटपुट के लिए. दस्तावेज़ में मौजूद फ़ुटर. इन्हें फ़ुटर आईडी के हिसाब से क्रम में लगाया जाता है.

लेगसी फ़ील्ड: इसके बजाय, Document.tabs.documentTab.footers का इस्तेमाल करें. इससे, includeTabsContent पैरामीटर को true पर सेट करने पर, सभी टैब से दस्तावेज़ का असल कॉन्टेंट दिखता है. अगर इसे false पर सेट किया जाता है या इसकी कोई वैल्यू सेट नहीं की जाती है, तो इस फ़ील्ड में दस्तावेज़ के पहले टैब के बारे में जानकारी होती है.
footnotes

map (key: string, value: object (Footnote))

सिर्फ़ आउटपुट के लिए. दस्तावेज़ में मौजूद फ़ुटनोट. इन्हें फ़ुटनोट आईडी के हिसाब से क्रम में लगाया जाता है.

लेगसी फ़ील्ड: इसके बजाय, Document.tabs.documentTab.footnotes का इस्तेमाल करें. इससे, includeTabsContent पैरामीटर को true पर सेट करने पर, सभी टैब से दस्तावेज़ का असल कॉन्टेंट दिखता है. अगर इसे false पर सेट किया जाता है या इसकी कोई वैल्यू सेट नहीं की जाती है, तो इस फ़ील्ड में दस्तावेज़ के पहले टैब के बारे में जानकारी होती है.
documentStyle

object (DocumentStyle)

सिर्फ़ आउटपुट के लिए. दस्तावेज़ का स्टाइल.

लेगसी फ़ील्ड: इसके बजाय, Document.tabs.documentTab.documentStyle का इस्तेमाल करें. इससे, includeTabsContent पैरामीटर को true पर सेट करने पर, सभी टैब से दस्तावेज़ का असल कॉन्टेंट दिखता है. अगर इसे false पर सेट किया जाता है या इसकी कोई वैल्यू सेट नहीं की जाती है, तो इस फ़ील्ड में दस्तावेज़ के पहले टैब के बारे में जानकारी होती है.
suggestedDocumentStyleChanges

map (key: string, value: object (SuggestedDocumentStyle))

सिर्फ़ आउटपुट के लिए. दस्तावेज़ के स्टाइल में किए जाने वाले सुझाए गए बदलाव. इन्हें सुझाव आईडी के हिसाब से क्रम में लगाया जाता है.

लेगसी फ़ील्ड: इसके बजाय, Document.tabs.documentTab.suggestedDocumentStyleChanges का इस्तेमाल करें. इससे, includeTabsContent पैरामीटर को true पर सेट करने पर, सभी टैब से दस्तावेज़ का असल कॉन्टेंट दिखता है. अगर इसे false पर सेट किया जाता है या इसकी कोई वैल्यू सेट नहीं की जाती है, तो इस फ़ील्ड में दस्तावेज़ के पहले टैब के बारे में जानकारी होती है.
namedStyles

object (NamedStyles)

सिर्फ़ आउटपुट के लिए. दस्तावेज़ के नाम वाले स्टाइल.

लेगसी फ़ील्ड: इसके बजाय, Document.tabs.documentTab.namedStyles का इस्तेमाल करें. इससे, includeTabsContent पैरामीटर को true पर सेट करने पर, सभी टैब से दस्तावेज़ का असल कॉन्टेंट दिखता है. अगर इसे false पर सेट किया जाता है या इसकी कोई वैल्यू सेट नहीं की जाती है, तो इस फ़ील्ड में दस्तावेज़ के पहले टैब के बारे में जानकारी होती है.
suggestedNamedStylesChanges

map (key: string, value: object (SuggestedNamedStyles))

सिर्फ़ आउटपुट के लिए. दस्तावेज़ के नाम वाले स्टाइल में किए जाने वाले सुझाए गए बदलाव. इन्हें सुझाव आईडी के हिसाब से क्रम में लगाया जाता है.

लेगसी फ़ील्ड: इसके बजाय, Document.tabs.documentTab.suggestedNamedStylesChanges का इस्तेमाल करें. इससे, includeTabsContent पैरामीटर को true पर सेट करने पर, सभी टैब से दस्तावेज़ का असल कॉन्टेंट दिखता है. अगर इसे false पर सेट किया जाता है या इसकी कोई वैल्यू सेट नहीं की जाती है, तो इस फ़ील्ड में दस्तावेज़ के पहले टैब के बारे में जानकारी होती है.
lists

map (key: string, value: object (List))

सिर्फ़ आउटपुट के लिए. दस्तावेज़ में मौजूद सूचियां. इन्हें सूची आईडी के हिसाब से क्रम में लगाया जाता है.

लेगसी फ़ील्ड: इसके बजाय, Document.tabs.documentTab.lists का इस्तेमाल करें. इससे, includeTabsContent पैरामीटर को true पर सेट करने पर, सभी टैब से दस्तावेज़ का असल कॉन्टेंट दिखता है. अगर इसे false पर सेट किया जाता है या इसकी कोई वैल्यू सेट नहीं की जाती है, तो इस फ़ील्ड में दस्तावेज़ के पहले टैब के बारे में जानकारी होती है.
namedRanges

map (key: string, value: object (NamedRanges))

सिर्फ़ आउटपुट के लिए. दस्तावेज़ में मौजूद नाम वाले रेंज. इन्हें नाम के हिसाब से क्रम में लगाया जाता है.

लेगसी फ़ील्ड: इसके बजाय, Document.tabs.documentTab.namedRanges का इस्तेमाल करें. इससे, includeTabsContent पैरामीटर को true पर सेट करने पर, सभी टैब से दस्तावेज़ का असल कॉन्टेंट दिखता है. अगर इसे false पर सेट किया जाता है या इसकी कोई वैल्यू सेट नहीं की जाती है, तो इस फ़ील्ड में दस्तावेज़ के पहले टैब के बारे में जानकारी होती है.
inlineObjects

map (key: string, value: object (InlineObject))

सिर्फ़ आउटपुट के लिए. दस्तावेज़ में मौजूद इनलाइन ऑब्जेक्ट. इन्हें ऑब्जेक्ट आईडी के हिसाब से क्रम में लगाया जाता है.

लेगसी फ़ील्ड: इसके बजाय, Document.tabs.documentTab.inlineObjects का इस्तेमाल करें. इससे, includeTabsContent पैरामीटर को true पर सेट करने पर, सभी टैब से दस्तावेज़ का असल कॉन्टेंट दिखता है. अगर इसे false पर सेट किया जाता है या इसकी कोई वैल्यू सेट नहीं की जाती है, तो इस फ़ील्ड में दस्तावेज़ के पहले टैब के बारे में जानकारी होती है.
positionedObjects

map (key: string, value: object (PositionedObject))

सिर्फ़ आउटपुट के लिए. दस्तावेज़ में मौजूद पॉज़िशन वाले ऑब्जेक्ट. इन्हें ऑब्जेक्ट आईडी के हिसाब से क्रम में लगाया जाता है.

लेगसी फ़ील्ड: इसके बजाय, Document.tabs.documentTab.positionedObjects का इस्तेमाल करें. इससे, includeTabsContent पैरामीटर को true पर सेट करने पर, सभी टैब से दस्तावेज़ का असल कॉन्टेंट दिखता है. अगर इसे false पर सेट किया जाता है या इसकी कोई वैल्यू सेट नहीं की जाती है, तो इस फ़ील्ड में दस्तावेज़ के पहले टैब के बारे में जानकारी होती है.

जवाब का मुख्य हिस्सा

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

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

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

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

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