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 या unset है, तो इस फ़ील्ड में दस्तावेज़ के पहले टैब के बारे में जानकारी होती है.
headers

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

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

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

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

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

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

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

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

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

object (DocumentStyle)

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

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

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

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

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

object (NamedStyles)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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