Method: documents.create

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

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

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

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

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

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

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

जेएसओएन के काेड में दिखाना 
{
  "documentId": string,
  "title": string,
  "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)
    },
    ...
  },
  "revisionId": string,
  "suggestionsViewMode": enum (SuggestionsViewMode),
  "inlineObjects": {
    string: {
      object (InlineObject)
    },
    ...
  },
  "positionedObjects": {
    string: {
      object (PositionedObject)
    },
    ...
  }
}
फ़ील्ड
documentId

string

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

string

दस्तावेज़ का शीर्षक.
body

object (Body)

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

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

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

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

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

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

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

object (DocumentStyle)

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

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

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

object (NamedStyles)

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

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

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

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

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

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

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

string

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

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

enum (SuggestionsViewMode)

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

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

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

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

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

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

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

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

अनुमति के दायरे

इनमें से किसी एक OAuth दायरे की ज़रूरत होती है:

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

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