Method: documents.create

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

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

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

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

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

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

अनुरोध के मुख्य भाग में नीचे दिए गए स्ट्रक्चर वाला डेटा होता है:

JSON के काेड में दिखाना 
{
  "documentId": string,
  "title": string,
  "tabs": [
    {
      object (Tab)
    }
  ],
  "revisionId": string,
  "suggestionsViewMode": enum (SuggestionsViewMode),
  "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 वाले दस्तावेज़ के आधार पर होने चाहिए.
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

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