दस्तावेज़

इस गाइड में कॉन्सेप्ट के बारे में बताया गया है. जैसे, Google Docs API, दस्तावेज़ को ऐक्सेस करने का तरीका, दस्तावेज़.

एपीआई के तरीके

documents संसाधन से जानकारी मिलती है Docs API शुरू करने के लिए इस्तेमाल किए जाने वाले तरीके. इन तरीकों से, आपको दस्तावेज़ दस्तावेज़ बनाएं, पढ़ें, और अपडेट करें:

  • documents.create का इस्तेमाल करें दस्तावेज़ बनाने का तरीका.
  • documents.get तरीका इस्तेमाल करें का इस्तेमाल करें.
  • documents.batchUpdate का इस्तेमाल करें का तरीका बताया गया है.

documents.get और documents.batchUpdate तरीकों के लिए, documentId की ज़रूरत होती है का इस्तेमाल एक पैरामीटर के रूप में करता है. documents.create तरीका बनाए गए दस्तावेज़ का एक इंस्टेंस लौटाता है, जिसमें से आप documentId. Docs API के अनुरोधों और रिस्पॉन्स पाने के तरीकों के बारे में ज़्यादा जानने के लिए, अनुरोध और जवाब.

दस्तावेज़ आईडी

documentId, दस्तावेज़ का यूनीक आइडेंटिफ़ायर है और इसे हासिल किया जा सकता है एक्सट्रैक्ट किया जा सकता है. यह एक विशेष स्ट्रिंग है, जिसमें अक्षर, संख्याएं और कुछ विशेष वर्ण शामिल हैं. दस्तावेज़ आईडी एक जैसा काम करते हैं. भले ही, दस्तावेज़ का नाम बदलाव.

https://docs.google.com/document/d/DOCUMENT_ID/edit

रेगुलर एक्सप्रेशन का इस्तेमाल करके documentId को Google दस्तावेज़ URL:

/document/d/([a-zA-Z0-9-_]+)

अगर आप Google Drive API के बारे में जानते हैं, तो documentId id से मेल खाता है files संसाधन में दी गई है.

Google डिस्क में दस्तावेज़ प्रबंधित करें

Docs फ़ाइलें हमारे क्लाउड-आधारित स्टोरेज, Google Drive में सेव की जाती हैं सेवा. Docs API के अपने अलग तरीके हैं. हालांकि, यह अक्सर साथ ही, किसी उपयोगकर्ता की Docs फ़ाइलें. उदाहरण के लिए, Docs फ़ाइलें कॉपी करने के लिए, Drive API का files.copy तरीका. ज़्यादा जानकारी के लिए, किसी मौजूदा रिपोर्ट को कॉपी करना दस्तावेज़ में दिया गया है.

डिफ़ॉल्ट रूप से, Docs API का इस्तेमाल करते समय, एक नया दस्तावेज़ डिस्क पर उपयोगकर्ता का रूट फ़ोल्डर है. यहां फ़ाइल सेव करने के विकल्प मौजूद हैं Drive फ़ोल्डर में. ज़्यादा जानकारी के लिए, इनके साथ काम करना Google Drive फ़ोल्डर.

Docs फ़ाइलों के साथ काम करना

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

दस्तावेज़ के MIME टाइप से डेटा टाइप और फ़ॉर्मैट की जानकारी मिलती है. MIME टाइप फ़ॉर्मैट Docs के लिए application/vnd.google-apps.document है. इनकी सूची के लिए MIME टाइप, Google Workspace और Google Drive पर काम करने वाले MIME का उदाहरण देखें टाइप.

मेरे में केवल दस्तावेज़ फ़ाइलों के लिए MIME प्रकार द्वारा खोजने के लिए Drive में यह क्वेरी स्ट्रिंग फ़िल्टर जोड़ें:

q: mimeType = 'application/vnd.google-apps.document'

क्वेरी स्ट्रिंग फ़िल्टर के बारे में ज़्यादा जानकारी के लिए, फ़ाइलें खोजें और फ़ोल्डर खोलें.

documentId के बारे में जानने के बाद, वापस पाने का documents.get तरीका तय किए गए दस्तावेज़ का पूरा इंस्टेंस. ज़्यादा जानकारी के लिए, यह देखें अनुरोध और जवाब.

Google Workspace के दस्तावेज़ का बाइट कॉन्टेंट एक्सपोर्ट करने के लिए, Drive की files.export तरीका एक्सपोर्ट करने के लिए फ़ाइल का documentId और सही MIME एक्सपोर्ट करें टाइप. ज़्यादा जानकारी के लिए, एक्सपोर्ट करें Google Workspace का दस्तावेज़ कॉन्टेंट.

Get और List के तरीकों की तुलना करें

नीचे दी गई टेबल में, Drive के बीच अंतर के बारे में बताया गया है और प्रत्येक के साथ लौटाया जाने वाला डेटा:

ऑपरेटर ब्यौरा इस्तेमाल
drive.files.get आईडी के हिसाब से फ़ाइल का मेटाडेटा दिखाता है. files संसाधन का इंस्टेंस दिखाता है. किसी खास फ़ाइल के लिए मेटाडेटा पाएं.
drive.files.list उपयोगकर्ता की फ़ाइलें फ़ेच करता है. फ़ाइलों की सूची दिखाता है. जब आपको यह तय न हो कि किस फ़ाइल में बदलाव करना है, तो उपयोगकर्ता की फ़ाइलों की सूची पाएं.
docs.documents.get तय किए गए दस्तावेज़ का सबसे नया वर्शन पाएं. इसमें सभी फ़ॉर्मैट और टेक्स्ट शामिल हैं. documents संसाधन का इंस्टेंस दिखाता है. किसी खास दस्तावेज़ के आईडी के लिए दस्तावेज़ पाएं.

दस्तावेज़ बनाने का वर्कफ़्लो

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

नया वर्कफ़्लो बनाने और नया दस्तावेज़ पॉप्युलेट करें.
पहली इमेज. नया दस्तावेज़ बनाने और उसे अपने-आप भरने के लिए वर्कफ़्लो.

पहली इमेज में, इमेज के साथ इंटरैक्ट करने वाला उपयोगकर्ता documents संसाधन में ये चीज़ें शामिल हैं जानकारी का फ़्लो:

  1. कोई ऐप्लिकेशन, documents.create तरीका चालू है वेब सर्वर में सेव किया जाता है.
  2. वेब सर्वर एक एचटीटीपी रिस्पॉन्स भेजता है, जिसमें documents संसाधन के तौर पर दस्तावेज़ बनाया गया.
  3. वैकल्पिक रूप से, ऐप्लिकेशन documents.batchUpdate को कॉल करता है दस्तावेज़ को पॉप्युलेट करने के लिए बदलाव करने के अनुरोधों का सेट अपने आप करने की विधि के साथ किया जा सकता है.
  4. वेब सर्वर एक एचटीटीपी रिस्पॉन्स भेजता है. कुछ documents.batchUpdate तरीके हम लागू किए गए अनुरोधों के बारे में जानकारी के साथ जवाब देते हैं, जबकि अन्य खाली जवाब दिखाते हैं.

दस्तावेज़ अपडेट वर्कफ़्लो

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

अपडेट करने का वर्कफ़्लो दस्तावेज़.
दूसरी इमेज. किसी दस्तावेज़ को अपडेट करने का वर्कफ़्लो.

दूसरी इमेज में, documents संसाधन के साथ इंटरैक्ट करने वाले उपयोगकर्ता ने जानकारी का फ़्लो इस तरह से होना चाहिए:

  1. कोई ऐप्लिकेशन, वेब पर documents.get तरीका खोजने के लिए फ़ाइल के documentId के साथ.
  2. वेब सर्वर एक एचटीटीपी रिस्पॉन्स भेजता है, जिसमें documents संसाधन के रूप में बताया गया दस्तावेज़. लौटाए गए JSON में दस्तावेज़ का कॉन्टेंट, फ़ॉर्मैटिंग, और अन्य सुविधाएं इस्तेमाल की जा सकती हैं.
  3. ऐप्लिकेशन, JSON को पार्स करता है, ताकि उपयोगकर्ता यह तय कर सके कि कौनसा कॉन्टेंट या फ़ॉर्मैट अपडेट.
  4. यह ऐप्लिकेशन किसी सेट को अपने-आप पूरा करने के लिए, documents.batchUpdate तरीके का इस्तेमाल करता है दस्तावेज़ को अपडेट करने के लिए संपादन अनुरोधों की संख्या.
  5. वेब सर्वर एक एचटीटीपी रिस्पॉन्स भेजता है. कुछ documents.batchUpdate तरीके हम लागू किए गए अनुरोधों के बारे में जानकारी के साथ जवाब देते हैं, जबकि कोई खाली जवाब नहीं दिखाता है.

इस डायग्राम में ऐसे वर्कफ़्लो शामिल नहीं किए गए हैं जिनमें अन्य डिवाइसों की मदद से एक साथ अपडेट किए जाते हैं साथ मिलकर काम करने वाले लोग एक ही दस्तावेज़ पर काम करते हैं. ज़्यादा जानकारी के लिए, सबसे सही प्रैक्टिस सेक्शन सहयोग.