इस गाइड में, मुख्य अनुरोध और जवाब देने के उन तरीकों के बारे में बताया गया है जो डेटा की मदद से, Google Docs API और किसी दस्तावेज़ को बैच में अपडेट करने का तरीका.
Google Docs API को एचटीटीपी अनुरोध का इस्तेमाल करके या किसी भाषा के हिसाब से बनाई गई क्लाइंट लाइब्रेरी में, किसी तरीके को शुरू करके चालू किया जा सकता है. मोटे तौर पर, ये दोनों तरीके एक जैसे हैं.
Google Docs API एक एचटीटीपी रिस्पॉन्स दिखाता है, जिसमें आम तौर पर नतीजा शामिल होता है विकल्प मौजूद है. अनुरोध करने के लिए, क्लाइंट लाइब्रेरी का इस्तेमाल करते समय, जवाबों को एक भाषा-विशिष्ट तरीक़े से दिखाया जाता है.
अनुरोध के तरीके
Docs API में, ये तरीके इस्तेमाल किए जा सकते हैं:
documents.create: किसी खाली Google दस्तावेज़ दस्तावेज़.documents.get: दिए गए दस्तावेज़ का पूरा इंस्टेंस दिखाता है. आपके पास, दिए गए JSON को पार्स करने का विकल्प है का इस्तेमाल करें.documents.batchUpdate: दस्तावेज़ पर अपने-आप लागू होने के लिए, बदलाव करने के अनुरोधों की सूची सबमिट करें और नतीजों की सूची दिखाएं.
documents.get और documents.batchUpdate तरीकों के लिए, documentId की ज़रूरत होती है
का इस्तेमाल एक पैरामीटर के रूप में करता है. documents.create तरीका
बनाए गए दस्तावेज़ का एक इंस्टेंस लौटाता है, जिसमें से आप
documentId. documentId के बारे में ज़्यादा जानकारी के लिए, दस्तावेज़ देखें
आईडी.
बैच अपडेट
documents.batchUpdate
तरीका,
request ऑब्जेक्ट, हर एक
करने के लिए एक ही अनुरोध तय करता है. उदाहरण के लिए, पहले एक पैराग्राफ़ को फ़ॉर्मैट करें और
इनलाइन इमेज जोड़ें. हर अनुरोध को लागू किए जाने से पहले उसकी पुष्टि की जाती है और
अनुरोधों को उसी क्रम में प्रोसेस किया जाता है जिस क्रम में वे बैच रिक्वेस्ट में दिखते हैं.
एक साथ कई बदलाव करने के अनुरोध, एक साथ लागू किए जाते हैं. इसका मतलब है कि अगर कोई अनुरोध मान्य नहीं है, तो पूरा अपडेट पूरा नहीं हो पाता और कोई भी बदलाव लागू नहीं होता.
कुछ documents.batchUpdate तरीके, इस बारे में जानकारी के साथ जवाब देते हैं
लागू किए गए अनुरोधों को. ये तरीके इस्तेमाल करने पर रिस्पॉन्स मिलता है
शरीर को
response की सूची मौजूद है
ऑब्जेक्ट हैं. अन्य अनुरोधों के लिए जानकारी वापस करने और उसे खाली दिखाने की ज़रूरत नहीं होती
जवाब दें. जवाब सूची में मौजूद ऑब्जेक्ट, इंडेक्स के उसी क्रम का इस्तेमाल करते हैं जिसमें
संबंधित अनुरोध.
बैच अनुरोध करने का लोकप्रिय पैटर्न इस तरह दिखता है:
requests = []
requests.append(first request)
requests.append(second request)
...
body = ... & requests & ...
...batchUpdate(body)
पूरी जानकारी के लिए, बैच से अनुरोध करने के सबसे सही तरीके देखें
अपने Docs API कॉल को एक साथ बैच करने का तरीका और
documents.batchUpdate
अनुरोध और रिस्पॉन्स के टाइप के लिए रेफ़रंस दस्तावेज़.
बैच अपडेट कार्रवाइयां
बैच अपडेट करने के अनुरोध कई तरह के होते हैं. यहां ब्रेकडाउन के बारे में बताया गया है अनुरोध के टाइप, जिन्हें इन ग्रुप में बांटा गया है अलग-अलग कैटगरी के हिसाब से विज्ञापन दिखाता है.