अनुरोध में दिए गए टाइटल का इस्तेमाल करके, खाली दस्तावेज़ बनाता है. अनुरोध के अन्य फ़ील्ड को अनदेखा कर दिया जाता है. इनमें, उपलब्ध कराया गया कॉन्टेंट भी शामिल होता है.
बनाया गया दस्तावेज़ दिखाता है.
एचटीटीपी अनुरोध
POST https://docs.googleapis.com/v1/documents
यह यूआरएल gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.
अनुरोध का मुख्य भाग
अनुरोध के मुख्य हिस्से में, यहां दिए गए स्ट्रक्चर का डेटा शामिल होता है:
JSON के काेड में दिखाना |
---|
{ "documentId": string, "title": string, "tabs": [ { object ( |
फ़ील्ड | |
---|---|
documentId |
सिर्फ़ आउटपुट के लिए. दस्तावेज़ का आईडी. |
title |
दस्तावेज़ का टाइटल. |
tabs[] |
वे टैब जो किसी दस्तावेज़ का हिस्सा हैं. टैब में चाइल्ड टैब, यानी दूसरे टैब के अंदर नेस्ट किया गया टैब हो सकता है. चाइल्ड टैब, |
revisionId |
सिर्फ़ आउटपुट के लिए. दस्तावेज़ का रिविज़न आईडी. इसका इस्तेमाल अपडेट के अनुरोधों में यह बताने के लिए किया जा सकता है कि दस्तावेज़ के किस संशोधन पर अपडेट लागू करना है. साथ ही, यह भी बताया जा सकता है कि बदलाव के बाद दस्तावेज़ में बदलाव किए जाने पर अनुरोध कैसे काम करेगा. दस्तावेज़ में बदलाव करने का ऐक्सेस होने पर ही, जानकारी अपने-आप भर जाती है. संशोधन आईडी कोई आनुक्रमिक संख्या नहीं, बल्कि एक ओपेक स्ट्रिंग है. संशोधन आईडी का फ़ॉर्मैट समय के साथ बदल सकता है. इस बात की गारंटी है कि वापस किया गया वर्शन आईडी, वापस करने के 24 घंटे बाद तक ही मान्य रहेगा. साथ ही, इसे अन्य उपयोगकर्ताओं के साथ शेयर नहीं किया जा सकता. अगर कॉल के बीच रिविज़न आईडी में कोई बदलाव नहीं होता है, तो इसका मतलब है कि दस्तावेज़ में कोई बदलाव नहीं हुआ है. इसके उलट, एक ही दस्तावेज़ और उपयोगकर्ता के लिए बदले गए आईडी का मतलब है कि दस्तावेज़ अपडेट कर दिया गया है. हालांकि, आईडी फ़ॉर्मैट में बदलाव जैसी अंदरूनी वजहों से भी आईडी बदल सकता है. |
suggestionsViewMode |
सिर्फ़ आउटपुट के लिए. दस्तावेज़ पर सुझाव व्यू मोड लागू किया गया. नोट: किसी दस्तावेज़ में बदलाव करते समय, बदलाव |
body |
सिर्फ़ आउटपुट के लिए. दस्तावेज़ का मुख्य हिस्सा. लेगसी फ़ील्ड: इसके बजाय, |
headers |
सिर्फ़ आउटपुट के लिए. दस्तावेज़ में हेडर, जिन्हें हेडर आईडी से जोड़ा जाता है. लेगसी फ़ील्ड: इसके बजाय, |
footers |
सिर्फ़ आउटपुट के लिए. दस्तावेज़ में फ़ुटर, जिन्हें फ़ुटर आईडी के साथ लिखा जाता है. लेगसी फ़ील्ड: इसके बजाय, |
footnotes |
सिर्फ़ आउटपुट के लिए. दस्तावेज़ में दिखाए गए फ़ुटनोट, फ़ुटनोट आईडी से जुड़े होते हैं. लेगसी फ़ील्ड: इसके बजाय, |
documentStyle |
सिर्फ़ आउटपुट के लिए. दस्तावेज़ का स्टाइल. लेगसी फ़ील्ड: इसके बजाय, |
suggestedDocumentStyleChanges |
सिर्फ़ आउटपुट के लिए. दस्तावेज़ की स्टाइल में सुझाए गए बदलाव, जिन्हें सुझाव आईडी के साथ दिखाया जाता है. लेगसी फ़ील्ड: इसके बजाय, |
namedStyles |
सिर्फ़ आउटपुट के लिए. दस्तावेज़ के नाम वाले स्टाइल. लेगसी फ़ील्ड: इसके बजाय, |
suggestedNamedStylesChanges |
सिर्फ़ आउटपुट के लिए. दस्तावेज़ की नाम वाली स्टाइल में सुझाए गए बदलाव, जिन्हें सुझाव आईडी के साथ लिखा जाता है. लेगसी फ़ील्ड: इसके बजाय, |
lists |
सिर्फ़ आउटपुट के लिए. दस्तावेज़ में मौजूद सूचियों को सूची आईडी से जोड़ा जाता है. लेगसी फ़ील्ड: इसके बजाय, |
namedRanges |
सिर्फ़ आउटपुट के लिए. दस्तावेज़ में नाम वाली रेंज, जिन्हें नाम से जोड़ा जाता है. लेगसी फ़ील्ड: इसके बजाय, |
inlineObjects |
सिर्फ़ आउटपुट के लिए. दस्तावेज़ में इनलाइन ऑब्जेक्ट, जिन्हें ऑब्जेक्ट आईडी की मदद से हाइलाइट किया जाता है. लेगसी फ़ील्ड: इसके बजाय, |
positionedObjects |
सिर्फ़ आउटपुट के लिए. दस्तावेज़ में मौजूद ऑब्जेक्ट, जिन्हें ऑब्जेक्ट आईडी के हिसाब से लिखा जाता है. लेगसी फ़ील्ड: इसके बजाय, |
जवाब का मुख्य भाग
कामयाब होने पर, जवाब के मुख्य हिस्से में Document
का नया इंस्टेंस शामिल किया जाता है.
अनुमति के दायरे
इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:
https://www.googleapis.com/auth/documents
https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/drive.file
ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.