टूल: update_doc
बैच अपडेट के अनुरोधों का इस्तेमाल करके, किसी दस्तावेज़ को अपडेट करता है. यह documents.batchUpdate अनुरोध (JSON के तौर पर) स्वीकार करता है.
REST API में documents.batchUpdate के लिए इस्तेमाल किया जाता है.
संभावित अपडेट की सूची यह है:
replaceAllText: इससे, चुने गए टेक्स्ट के सभी इंस्टेंस बदल जाते हैं. स्कीमा:replaceText(स्ट्रिंग, ज़रूरी है): वह टेक्स्ट जो मैच होने वाले टेक्स्ट की जगह लेगा.- शर्तें (इनमें से कोई एक शर्त पूरी करना ज़रूरी है):
containsText(ऑब्जेक्ट): टेक्स्ट मैच करने की शर्तें:text(स्ट्रिंग, ज़रूरी है): दस्तावेज़ में खोजा जाने वाला टेक्स्ट.matchCase(बूलियन, ज़रूरी नहीं): इससे पता चलता है कि खोज के दौरान केस सेंसिटिविटी का ध्यान रखना चाहिए या नहीं.searchByRegex(बूलियन, ज़रूरी नहीं): खोजे जाने वाले टेक्स्ट को रेगुलर एक्सप्रेशन के तौर पर माना जाता है या नहीं.
tabsCriteria(ऑब्जेक्ट, ज़रूरी नहीं): यह तय करने के लिए इस्तेमाल की जाने वाली शर्तें कि किन टैब में बदलाव किया जाए:tabIds(स्ट्रिंग का कलेक्शन, ज़रूरी नहीं): उन टैब आईडी की सूची जिनमें अनुरोध को लागू किया जाता है.
insertText: तय की गई जगह पर टेक्स्ट डालता है. स्कीमा:text(स्ट्रिंग, ज़रूरी है): वह टेक्स्ट जिसे शामिल करना है.- इंसर्ट करने की जगह (सिर्फ़ एक ज़रूरी है):
location(object): किसी खास इंडेक्स पर टेक्स्ट शामिल करता है:index(इंटीजर, ज़रूरी है): UTF-16 कोड यूनिट में शून्य पर आधारित इंडेक्स. यह किसी मौजूदा पैराग्राफ़ के अंदर होना चाहिए: दस्तावेज़ का मुख्य हिस्सा, इंडेक्स 0 पर सेक्शन ब्रेक से शुरू होता है. इसलिए, मुख्य हिस्से में पहला मान्य इंसर्शन इंडेक्स 1 होता है. दस्तावेज़ की शुरुआत में इंसर्ट करने के लिए,index: 1का इस्तेमाल करें.segmentId(स्ट्रिंग, ज़रूरी नहीं): हेडर, फ़ुटर या फ़ुटनोट का आईडी. दस्तावेज़ के मुख्य हिस्से के लिए खाली छोड़ें.tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें जगह की जानकारी मौजूद है.
endOfSegmentLocation(object): हेडर, फ़ुटर, फ़ुटनोट या दस्तावेज़ के मुख्य हिस्से के आखिर में टेक्स्ट शामिल करता है:segmentId(स्ट्रिंग, ज़रूरी नहीं): हेडर, फ़ुटर या फ़ुटनोट का आईडी. दस्तावेज़ के मुख्य हिस्से के लिए खाली छोड़ें.tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें जगह की जानकारी मौजूद है.
updateTextStyle: इससे तय की गई रेंज में टेक्स्ट की स्टाइल अपडेट होती है. स्कीमा:textStyle(object, required): टेक्स्ट पर सेट की जाने वाली स्टाइल:bold(बूलियन, ज़रूरी नहीं): इससे पता चलता है कि टेक्स्ट को बोल्ड करके रेंडर किया गया है या नहीं.italic(बूलियन, ज़रूरी नहीं): इससे पता चलता है कि टेक्स्ट इटैलिक है या नहीं.underline(बूलियन, ज़रूरी नहीं): टेक्स्ट को अंडरलाइन किया गया है या नहीं.strikethrough(बूलियन, ज़रूरी नहीं): इससे पता चलता है कि टेक्स्ट पर स्ट्राइकथ्रू लागू है या नहीं.smallCaps(बूलियन, ज़रूरी नहीं): इससे पता चलता है कि टेक्स्ट, छोटे कैपिटल लेटर में है या नहीं.backgroundColor(ऑब्जेक्ट, ज़रूरी नहीं): टेक्स्ट के बैकग्राउंड का रंग:{"color": {"rgbColor": {"red": number, "green": number, "blue": number}}}.foregroundColor(ऑब्जेक्ट, ज़रूरी नहीं): टेक्स्ट के फ़ोरग्राउंड का रंग:{"color": {"rgbColor": {"red": number, "green": number, "blue": number}}}.fontSize(ऑब्जेक्ट, ज़रूरी नहीं): फ़ॉन्ट का साइज़:{"magnitude": number, "unit": "PT"}.weightedFontFamily(ऑब्जेक्ट, ज़रूरी नहीं): फ़ॉन्ट फ़ैमिली और मोटाई:{"fontFamily": string, "weight": integer}.baselineOffset(स्ट्रिंग, ज़रूरी नहीं): वर्टिकल ऑफ़सेट:"NONE","SUPERSCRIPT"या"SUBSCRIPT".link(ऑब्जेक्ट, ज़रूरी नहीं): हाइपरलिंक का डेस्टिनेशन:{"url": string}या{"tabId": string}.fields(स्ट्रिंग, ज़रूरी है): अपडेट किए जाने वाले फ़ील्ड की कॉमा लगाकर अलग की गई लिस्ट (उदाहरण के लिए,"bold,foregroundColor"या"*").- इंसर्ट करने की जगह (सिर्फ़ एक ज़रूरी है):
range(ऑब्जेक्ट): टेक्स्ट की वह रेंज जिसे स्टाइल करना है:startIndex(पूर्णांक, ज़रूरी नहीं): इस रेंज का शून्य पर आधारित स्टार्ट इंडेक्स.endIndex(integer, optional): इस रेंज का एंड इंडेक्स, जो शून्य से शुरू होता है.segmentId(स्ट्रिंग, ज़रूरी नहीं): हेडर, फ़ुटर या फ़ुटनोट का आईडी. दस्तावेज़ के मुख्य हिस्से के लिए खाली छोड़ें.tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें यह रेंज शामिल है.
createParagraphBullets: पैराग्राफ़ के लिए बुलेट बनाता है. स्कीमा:range(ऑब्जेक्ट, ज़रूरी है): वह रेंज जिस पर बुलेट प्रीसेट लागू करना है:startIndex(पूर्णांक, ज़रूरी नहीं): इस रेंज का शून्य पर आधारित स्टार्ट इंडेक्स.endIndex(integer, optional): इस रेंज का एंड इंडेक्स, जो शून्य से शुरू होता है.segmentId(स्ट्रिंग, ज़रूरी नहीं): हेडर, फ़ुटर या फ़ुटनोट का आईडी. दस्तावेज़ के मुख्य हिस्से के लिए खाली छोड़ें.tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें यह रेंज शामिल है.bulletPreset(स्ट्रिंग, ज़रूरी है): सूचियों के लिए बुलेट ग्लिफ़ का पहले से सेट पैटर्न:"BULLET_DISC_CIRCLE_SQUARE","BULLET_DIAMONDX_ARROW3D_SQUARE","BULLET_CHECKBOX","BULLET_ARROW_DIAMOND_DISC","BULLET_STAR_CIRCLE_SQUARE","BULLET_ARROW3D_CIRCLE_SQUARE","BULLET_LEFTTRIANGLE_DIAMOND_DISC","BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE","BULLET_DIAMOND_CIRCLE_SQUARE","NUMBERED_DECIMAL_ALPHA_ROMAN","NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS","NUMBERED_DECIMAL_NESTED","NUMBERED_UPPERALPHA_ALPHA_ROMAN","NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL","NUMBERED_ZERODECIMAL_ALPHA_ROMAN".
deleteParagraphBullets: पैराग्राफ़ से बुलेट हटाता है. स्कीमा:range(ऑब्जेक्ट, ज़रूरी है): वह रेंज जिससे बुलेट मिटानी हैं:startIndex(पूर्णांक, ज़रूरी नहीं): इस रेंज का शून्य पर आधारित स्टार्ट इंडेक्स.endIndex(integer, optional): इस रेंज का एंड इंडेक्स, जो शून्य से शुरू होता है.segmentId(स्ट्रिंग, ज़रूरी नहीं): हेडर, फ़ुटर या फ़ुटनोट का आईडी. दस्तावेज़ के मुख्य हिस्से के लिए खाली छोड़ें.tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें यह रेंज शामिल है.
createNamedRange: इससे नाम वाली रेंज बनाई जाती है. स्कीमा:name(स्ट्रिंग, ज़रूरी है): NamedRange का नाम (1 से 256 वर्ण).range(ऑब्जेक्ट, ज़रूरी है): वह रेंज जिस पर नाम लागू करना है:startIndex(पूर्णांक, ज़रूरी नहीं): इस रेंज का शून्य पर आधारित स्टार्ट इंडेक्स.endIndex(integer, optional): इस रेंज का एंड इंडेक्स, जो शून्य से शुरू होता है.segmentId(स्ट्रिंग, ज़रूरी नहीं): हेडर, फ़ुटर या फ़ुटनोट का आईडी. दस्तावेज़ के मुख्य हिस्से के लिए खाली छोड़ें.tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें यह रेंज शामिल है.
deleteNamedRange: नाम वाली रेंज को मिटाता है. स्कीमा:- नाम वाली रेंज का रेफ़रंस (सिर्फ़ एक ज़रूरी है):
namedRangeId(स्ट्रिंग): नाम वाली उस रेंज का आईडी जिसे मिटाना है.name(स्ट्रिंग): मिटाई जाने वाली रेंज के नाम. इस नाम वाली सभी नाम वाली रेंज मिटा दी जाएंगी.tabsCriteria(ऑब्जेक्ट, ज़रूरी नहीं): रेंज मिटाने की सुविधा किन टैब पर लागू होती है, यह बताने के लिए इस्तेमाल की जाने वाली शर्तें:tabIds(स्ट्रिंग का कलेक्शन, ज़रूरी नहीं): टैब आईडी की सूची.
updateParagraphStyle: यह तय की गई रेंज में पैराग्राफ़ की स्टाइल को अपडेट करता है. स्कीमा:paragraphStyle(ऑब्जेक्ट, ज़रूरी है): पैराग्राफ़ पर सेट की जाने वाली स्टाइल:alignment(स्ट्रिंग, ज़रूरी नहीं): टेक्स्ट अलाइनमेंट:"START","CENTER","END","JUSTIFIED".lineSpacing(संख्या, ज़रूरी नहीं): लाइन स्पेसिंग का प्रतिशत (उदाहरण के लिए, 100% के लिए 100).direction(स्ट्रिंग, ज़रूरी नहीं): टेक्स्ट की दिशा:"LEFT_TO_RIGHT","RIGHT_TO_LEFT".spacingMode(स्ट्रिंग, ज़रूरी नहीं): स्पेसिंग मोड:"NEVER_COLLAPSE","COLLAPSE_LISTS".spaceAbove(ऑब्जेक्ट, ज़रूरी नहीं): पैराग्राफ़ के ऊपर की जगह:{"magnitude": number, "unit": "PT"}.spaceBelow(ऑब्जेक्ट, ज़रूरी नहीं): पैराग्राफ़ के नीचे की जगह:{"magnitude": number, "unit": "PT"}.borderBetween/borderTop/borderBottom/borderLeft/borderRight(ऑब्जेक्ट, ज़रूरी नहीं):{"color": {"color": {"rgbColor": ...}}, "width": {"magnitude": number, "unit": "PT"}, "padding": {"magnitude": number, "unit": "PT"}, "dashStyle": "SOLID"|"DOT"|"DASH"}.indentFirstLine(ऑब्जेक्ट, ज़रूरी नहीं): पहली लाइन का इंडेंट:{"magnitude": number, "unit": "PT"}.indentStart(ऑब्जेक्ट, ज़रूरी नहीं): शुरुआत में इंडेंट:{"magnitude": number, "unit": "PT"}.indentEnd(ऑब्जेक्ट, ज़रूरी नहीं): आखिर में इंडेंट:{"magnitude": number, "unit": "PT"}.namedStyleType(स्ट्रिंग, ज़रूरी नहीं): नाम वाली स्टाइल का टाइप:"NORMAL_TEXT","TITLE","SUBTITLE","HEADING_1","HEADING_2","HEADING_3","HEADING_4","HEADING_5","HEADING_6".keepWithNext(बूलियन, ज़रूरी नहीं): इससे यह तय होता है कि पैराग्राफ़ को अगले पैराग्राफ़ के साथ एक ही पेज पर रखना है या नहीं.keepLinesTogether(बूलियन, ज़रूरी नहीं): सभी लाइनों को एक ही पेज पर रखना है या नहीं.avoidWidowAndOrphan(बूलियन, ज़रूरी नहीं): विडो/ऑर्फ़न लाइनों को रोकना है या नहीं.shading(ऑब्जेक्ट, ज़रूरी नहीं): पैराग्राफ़ के बैकग्राउंड की शेडिंग:{"backgroundColor": {"color": {"rgbColor": {"red": number, "green": number, "blue": number}}}}.pageBreakBefore(बूलियन, ज़रूरी नहीं): इससे पता चलता है कि पैराग्राफ़ हमेशा पेज की शुरुआत से शुरू होना चाहिए या नहीं.fields(स्ट्रिंग, ज़रूरी है): अपडेट किए जाने वाले फ़ील्ड की कॉमा लगाकर अलग की गई लिस्ट (उदाहरण के लिए,"alignment,namedStyleType"या"*").- इंसर्ट करने की जगह (सिर्फ़ एक ज़रूरी है):
range(ऑब्जेक्ट): स्टाइल किए जाने वाले पैराग्राफ़ को ओवरलैप करने वाली रेंज:startIndex(पूर्णांक, ज़रूरी नहीं): इस रेंज का शून्य पर आधारित स्टार्ट इंडेक्स.endIndex(integer, optional): इस रेंज का एंड इंडेक्स, जो शून्य से शुरू होता है.segmentId(स्ट्रिंग, ज़रूरी नहीं): हेडर, फ़ुटर या फ़ुटनोट का आईडी. दस्तावेज़ के मुख्य हिस्से के लिए खाली छोड़ें.tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें यह रेंज शामिल है.
deleteContentRange: दस्तावेज़ से कॉन्टेंट मिटाता है. स्कीमा:range(ऑब्जेक्ट, ज़रूरी है): मिटाए जाने वाले कॉन्टेंट की रेंज:startIndex(पूर्णांक, ज़रूरी नहीं): इस रेंज का शून्य पर आधारित स्टार्ट इंडेक्स.endIndex(integer, optional): इस रेंज का एंड इंडेक्स, जो शून्य से शुरू होता है.segmentId(स्ट्रिंग, ज़रूरी नहीं): हेडर, फ़ुटर या फ़ुटनोट का आईडी. दस्तावेज़ के मुख्य हिस्से के लिए खाली छोड़ें.tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें यह रेंज शामिल है.
insertInlineImage: तय की गई जगह पर इनलाइन इमेज जोड़ता है. स्कीमा:uri(स्ट्रिंग, ज़रूरी है): इमेज का यूआरआई. यह सार्वजनिक तौर पर ऐक्सेस किया जा सकता हो और इसकी लंबाई ज़्यादा से ज़्यादा 2 केबी हो.objectSize(ऑब्जेक्ट, ज़रूरी नहीं): दस्तावेज़ में इमेज का साइज़ इस तरह दिखना चाहिए:{"width": {"magnitude": number, "unit": "PT"}, "height": {"magnitude": number, "unit": "PT"}}.- इंसर्ट करने की जगह (सिर्फ़ एक ज़रूरी है):
location(object): इससे किसी खास जगह पर इमेज डाली जाती है:index(इंटीजर, ज़रूरी है): UTF-16 कोड यूनिट में शून्य पर आधारित इंडेक्स.segmentId(स्ट्रिंग, ज़रूरी नहीं): हेडर, फ़ुटर या फ़ुटनोट का आईडी. दस्तावेज़ के मुख्य हिस्से के लिए खाली छोड़ें.tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें जगह की जानकारी मौजूद है.
endOfSegmentLocation(ऑब्जेक्ट): हेडर, फ़ुटर या दस्तावेज़ के मुख्य हिस्से के आखिर में इमेज शामिल करता है:segmentId(स्ट्रिंग, ज़रूरी नहीं): हेडर, फ़ुटर या फ़ुटनोट का आईडी. दस्तावेज़ के मुख्य हिस्से के लिए खाली छोड़ें.tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें जगह की जानकारी मौजूद है.
insertTable: इससे बताई गई जगह पर टेबल शामिल की जाती है. स्कीमा:rows(इंटीजर, ज़रूरी है): टेबल में मौजूद लाइनों की संख्या.columns(integer, ज़रूरी है): टेबल में कॉलम की संख्या.- इंसर्ट करने की जगह (सिर्फ़ एक ज़रूरी है):
location(ऑब्जेक्ट): किसी खास जगह पर टेबल शामिल करता है:index(इंटीजर, ज़रूरी है): UTF-16 कोड यूनिट में शून्य पर आधारित इंडेक्स.segmentId(स्ट्रिंग, ज़रूरी नहीं): हेडर, फ़ुटर या फ़ुटनोट का आईडी. दस्तावेज़ के मुख्य हिस्से के लिए खाली छोड़ें.tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें जगह की जानकारी मौजूद है.
endOfSegmentLocation(object): हेडर, फ़ुटर या दस्तावेज़ के मुख्य हिस्से के आखिर में टेबल शामिल करता है:segmentId(स्ट्रिंग, ज़रूरी नहीं): हेडर, फ़ुटर या फ़ुटनोट का आईडी. दस्तावेज़ के मुख्य हिस्से के लिए खाली छोड़ें.tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें जगह की जानकारी मौजूद है.
insertTableRow: इससे टेबल में एक खाली पंक्ति जोड़ी जाती है. स्कीमा:tableCellLocation(ऑब्जेक्ट, ज़रूरी है): रेफ़रंस टेबल की सेल की वह जगह जहां से पंक्तियां डाली जाएंगी:tableStartLocation(ऑब्जेक्ट, ज़रूरी है): दस्तावेज़ में टेबल की शुरुआत की जगह:index(इंटीजर, ज़रूरी है): UTF-16 कोड यूनिट में टेबल की शुरुआत का शून्य-आधारित इंडेक्स.segmentId(स्ट्रिंग, ज़रूरी नहीं): हेडर, फ़ुटर या फ़ुटनोट का आईडी. दस्तावेज़ की मुख्य बॉडी के लिए खाली या छोड़ा गया.tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें टेबल मौजूद है.
rowIndex(integer, required): शून्य से शुरू होने वाला पंक्ति इंडेक्स.columnIndex(इंटीजर, ज़रूरी है): शून्य से शुरू होने वाला कॉलम इंडेक्स.insertBelow(बूलियन, ज़रूरी है): इससे यह तय होता है कि रेफ़रंस सेल के नीचे नई लाइन जोड़ी जाए या नहीं. इसके लिए, नीचे के लिएtrueऔर ऊपर के लिएfalseका इस्तेमाल करें.
insertTableColumn: इससे टेबल में एक खाली कॉलम जुड़ जाता है. स्कीमा:tableCellLocation(ऑब्जेक्ट, ज़रूरी है): रेफ़रंस टेबल के सेल की जगह की जानकारी, जहां से कॉलम डाले जाएंगे:tableStartLocation(ऑब्जेक्ट, ज़रूरी है): दस्तावेज़ में टेबल की शुरुआत की जगह:index(इंटीजर, ज़रूरी है): UTF-16 कोड यूनिट में टेबल की शुरुआत का शून्य-आधारित इंडेक्स.segmentId(स्ट्रिंग, ज़रूरी नहीं): हेडर, फ़ुटर या फ़ुटनोट का आईडी. दस्तावेज़ की मुख्य बॉडी के लिए खाली या छोड़ा गया.tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें टेबल मौजूद है.
rowIndex(integer, required): शून्य से शुरू होने वाला पंक्ति इंडेक्स.columnIndex(इंटीजर, ज़रूरी है): शून्य से शुरू होने वाला कॉलम इंडेक्स.insertRight(बूलियन, ज़रूरी है): रेफ़रंस सेल की दाईं ओर नया कॉलम शामिल करना है या नहीं (दाईं ओर के लिएtrue, बाईं ओर के लिएfalse).
deleteTableRow: टेबल से किसी पंक्ति को मिटाता है. स्कीमा:tableCellLocation(ऑब्जेक्ट, ज़रूरी है): रेफ़रंस टेबल की उस सेल की जगह की जानकारी जिससे पंक्ति मिटाई जाएगी:tableStartLocation(ऑब्जेक्ट, ज़रूरी है): दस्तावेज़ में टेबल की शुरुआत की जगह:index(इंटीजर, ज़रूरी है): UTF-16 कोड यूनिट में टेबल की शुरुआत का शून्य-आधारित इंडेक्स.segmentId(स्ट्रिंग, ज़रूरी नहीं): हेडर, फ़ुटर या फ़ुटनोट का आईडी. दस्तावेज़ की मुख्य बॉडी के लिए खाली या छोड़ा गया.tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें टेबल मौजूद है.
rowIndex(integer, required): शून्य से शुरू होने वाला पंक्ति इंडेक्स.columnIndex(इंटीजर, ज़रूरी है): शून्य से शुरू होने वाला कॉलम इंडेक्स.
deleteTableColumn: इससे टेबल से कोई कॉलम मिटाया जाता है. स्कीमा:tableCellLocation(ऑब्जेक्ट, ज़रूरी है): रेफ़रंस टेबल की सेल की वह जगह जहां से कॉलम मिटाया जाएगा:tableStartLocation(ऑब्जेक्ट, ज़रूरी है): दस्तावेज़ में टेबल की शुरुआत की जगह:index(इंटीजर, ज़रूरी है): UTF-16 कोड यूनिट में टेबल की शुरुआत का शून्य-आधारित इंडेक्स.segmentId(स्ट्रिंग, ज़रूरी नहीं): हेडर, फ़ुटर या फ़ुटनोट का आईडी. दस्तावेज़ की मुख्य बॉडी के लिए खाली या छोड़ा गया.tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें टेबल मौजूद है.
rowIndex(integer, required): शून्य से शुरू होने वाला पंक्ति इंडेक्स.columnIndex(इंटीजर, ज़रूरी है): शून्य से शुरू होने वाला कॉलम इंडेक्स.
insertPageBreak: इससे बताई गई जगह पर पेज ब्रेक जुड़ जाता है. स्कीमा:- इंसर्ट करने की जगह (सिर्फ़ एक ज़रूरी है):
location(object): किसी खास इंडेक्स पर पेज ब्रेक डालता है:index(इंटीजर, ज़रूरी है): UTF-16 कोड यूनिट में शून्य पर आधारित इंडेक्स.segmentId(स्ट्रिंग, ज़रूरी नहीं): हेडर, फ़ुटर या फ़ुटनोट का आईडी. दस्तावेज़ के मुख्य हिस्से के लिए खाली छोड़ें.tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें जगह की जानकारी मौजूद है.
endOfSegmentLocation(ऑब्जेक्ट): दस्तावेज़ के मुख्य हिस्से के आखिर में पेज ब्रेक जोड़ता है:segmentId(स्ट्रिंग, ज़रूरी नहीं): हेडर, फ़ुटर या फ़ुटनोट का आईडी. दस्तावेज़ के मुख्य हिस्से के लिए खाली छोड़ें.tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें जगह की जानकारी मौजूद है.
deletePositionedObject: दस्तावेज़ से किसी ऑब्जेक्ट को मिटाता है. स्कीमा:objectId(स्ट्रिंग, ज़रूरी है): मिटाए जाने वाले ऑब्जेक्ट का आईडी.tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें पोज़िशन किया गया ऑब्जेक्ट मौजूद है.
updateTableColumnProperties: यह किसी टेबल में मौजूद कॉलम की प्रॉपर्टी अपडेट करता है. स्कीमा:tableStartLocation(ऑब्जेक्ट, ज़रूरी है): दस्तावेज़ में टेबल की शुरुआत की जगह:index(इंटीजर, ज़रूरी है): UTF-16 कोड यूनिट में टेबल की शुरुआत का शून्य-आधारित इंडेक्स.segmentId(स्ट्रिंग, ज़रूरी नहीं): हेडर, फ़ुटर या फ़ुटनोट का आईडी. दस्तावेज़ की मुख्य बॉडी के लिए खाली या छोड़ा गया.tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें टेबल मौजूद है.columnIndices(array of integers, optional): अपडेट किए जाने वाले कॉलम के इंडेक्स, जो शून्य से शुरू होते हैं. अगर इसे शामिल नहीं किया जाता है, तो सभी कॉलम अपडेट हो जाते हैं.tableColumnProperties(ऑब्जेक्ट, ज़रूरी है): अपडेट की जाने वाली कॉलम प्रॉपर्टी:width(ऑब्जेक्ट, ज़रूरी नहीं): कॉलम की चौड़ाई:{"magnitude": number, "unit": "PT"}.widthType(स्ट्रिंग, ज़रूरी नहीं):"EVENLY_DISTRIBUTED","FIXED_WIDTH".fields(स्ट्रिंग, ज़रूरी है): अपडेट किए जाने वाले फ़ील्ड की कॉमा लगाकर अलग की गई लिस्ट (उदाहरण के लिए,"width"या"*").
updateTableCellStyle: टेबल की सेल की स्टाइल अपडेट करता है. स्कीमा:- सेल (सिर्फ़ एक सेल ज़रूरी है):
tableRange(ऑब्जेक्ट): टेबल की सेल का सबसेट, जिसे अपडेट करना है:tableCellLocation(ऑब्जेक्ट, ज़रूरी है): रेफ़रंस सेल की जगह की जानकारी:tableStartLocation(ऑब्जेक्ट, ज़रूरी है): दस्तावेज़ में टेबल की शुरुआत की जगह:index(इंटीजर, ज़रूरी है): UTF-16 कोड यूनिट में टेबल की शुरुआत का शून्य-आधारित इंडेक्स.segmentId(स्ट्रिंग, ज़रूरी नहीं): हेडर, फ़ुटर या फ़ुटनोट का आईडी. दस्तावेज़ की मुख्य बॉडी के लिए खाली या छोड़ा गया.tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें टेबल मौजूद है.
rowIndex(integer, required): शून्य से शुरू होने वाला पंक्ति इंडेक्स.columnIndex(इंटीजर, ज़रूरी है): शून्य से शुरू होने वाला कॉलम इंडेक्स.rowSpan(इंटीजर, ज़रूरी है): टेबल की रेंज का पंक्ति स्पैन.columnSpan(इंटीजर, ज़रूरी है): टेबल रेंज का कॉलम स्पैन.
tableStartLocation(ऑब्जेक्ट): टेबल की सभी सेल पर लागू होने वाली टेबल की शुरुआत की जगह:index(इंटीजर, ज़रूरी है): UTF-16 कोड यूनिट में टेबल की शुरुआत का शून्य-आधारित इंडेक्स.segmentId(स्ट्रिंग, ज़रूरी नहीं): हेडर, फ़ुटर या फ़ुटनोट का आईडी. दस्तावेज़ की मुख्य बॉडी के लिए खाली या छोड़ा गया.tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें टेबल मौजूद है.
tableCellStyle(ऑब्जेक्ट, ज़रूरी है): सेट की जाने वाली सेल स्टाइल:backgroundColor(ऑब्जेक्ट, ज़रूरी नहीं):{"color": {"rgbColor": {"red": number, "green": number, "blue": number}}}.paddingTop/paddingBottom/paddingLeft/paddingRight(ऑब्जेक्ट, ज़रूरी नहीं):{"magnitude": number, "unit": "PT"}.contentAlignment(स्ट्रिंग, ज़रूरी नहीं):"TOP","MIDDLE","BOTTOM".borderTop/borderBottom/borderLeft/borderRight(ऑब्जेक्ट, ज़रूरी नहीं):{"color": {"color": {"rgbColor": ...}}, "width": {"magnitude": number, "unit": "PT"}, "dashStyle": "SOLID"|"DOT"|"DASH"}.fields(स्ट्रिंग, ज़रूरी है): अपडेट किए जाने वाले फ़ील्ड की कॉमा लगाकर अलग की गई लिस्ट (उदाहरण के लिए,"backgroundColor,contentAlignment"या"*").
updateTableRowStyle: टेबल में पंक्ति की स्टाइल को अपडेट करता है. स्कीमा:tableStartLocation(ऑब्जेक्ट, ज़रूरी है): दस्तावेज़ में टेबल की शुरुआत की जगह:index(इंटीजर, ज़रूरी है): UTF-16 कोड यूनिट में टेबल की शुरुआत का शून्य-आधारित इंडेक्स.segmentId(स्ट्रिंग, ज़रूरी नहीं): हेडर, फ़ुटर या फ़ुटनोट का आईडी. दस्तावेज़ की मुख्य बॉडी के लिए खाली या छोड़ा गया.tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें टेबल मौजूद है.rowIndices(array of integers, optional): अपडेट करने के लिए, शून्य से शुरू होने वाली पंक्ति के इंडेक्स. अगर इसे शामिल नहीं किया जाता है, तो सभी पंक्तियां अपडेट हो जाती हैं.tableRowStyle(ऑब्जेक्ट, ज़रूरी है): सेट करने के लिए लाइन की स्टाइल:minRowHeight(ऑब्जेक्ट, ज़रूरी नहीं): पंक्ति की कम से कम ऊंचाई:{"magnitude": number, "unit": "PT"}.preventOverflow(बूलियन, ज़रूरी नहीं): इससे पता चलता है कि पंक्ति को सभी पेजों पर ओवरफ़्लो होने की अनुमति है या नहीं.fields(स्ट्रिंग, ज़रूरी है): अपडेट किए जाने वाले फ़ील्ड की कॉमा लगाकर अलग की गई लिस्ट (उदाहरण के लिए,"minRowHeight"या"*").
replaceImage: दस्तावेज़ में मौजूद किसी इमेज को बदलता है. स्कीमा:imageObjectId(स्ट्रिंग, ज़रूरी है): उस मौजूदा इमेज का आईडी जिसे बदलना है.uri(स्ट्रिंग, ज़रूरी है): नई इमेज का यूआरआई. यह सार्वजनिक तौर पर ऐक्सेस किया जा सकता हो.imageReplaceMethod(स्ट्रिंग, ज़रूरी नहीं):"CENTER_CROP".tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें मौजूद इमेज को बदलना है.
updateDocumentStyle: दस्तावेज़ की स्टाइल अपडेट करता है. स्कीमा:documentStyle(ऑब्जेक्ट, ज़रूरी है): सेट की जाने वाली दस्तावेज़ की स्टाइल:background(ऑब्जेक्ट, ज़रूरी नहीं):{"color": {"color": {"rgbColor": {"red": number, "green": number, "blue": number}}}}.marginTop/marginBottom/marginLeft/marginRight(ऑब्जेक्ट, ज़रूरी नहीं):{"magnitude": number, "unit": "PT"}.pageSize(ऑब्जेक्ट, ज़रूरी नहीं):{"width": {"magnitude": number, "unit": "PT"}, "height": {"magnitude": number, "unit": "PT"}}.useCustomHeaderFooterMargins(बूलियन, ज़रूरी नहीं): कस्टम हेडर/फ़ुटर मार्जिन का इस्तेमाल करना है या नहीं.marginHeader/marginFooter(ऑब्जेक्ट, ज़रूरी नहीं):{"magnitude": number, "unit": "PT"}.fields(स्ट्रिंग, ज़रूरी है): अपडेट किए जाने वाले फ़ील्ड की कॉमा लगाकर अलग की गई लिस्ट (उदाहरण के लिए,"background,marginTop"या"*").tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें अपडेट की जाने वाली दस्तावेज़ की स्टाइल मौजूद है.
mergeTableCells: टेबल में कई सेल को मिलाकर एक सेल बनाता है. स्कीमा:tableRange(ऑब्जेक्ट, ज़रूरी है): टेबल की रेंज, जिससे पता चलता है कि किन सेल को मर्ज करना है:tableCellLocation(ऑब्जेक्ट, ज़रूरी है): रेफ़रंस सेल की जगह:tableStartLocation(ऑब्जेक्ट, ज़रूरी है): दस्तावेज़ में टेबल की शुरुआत की जगह:index(इंटीजर, ज़रूरी है): UTF-16 कोड यूनिट में टेबल की शुरुआत का शून्य-आधारित इंडेक्स.segmentId(स्ट्रिंग, ज़रूरी नहीं): हेडर, फ़ुटर या फ़ुटनोट का आईडी. दस्तावेज़ की मुख्य बॉडी के लिए खाली या छोड़ा गया.tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें टेबल मौजूद है.rowIndex(integer, required): शून्य से शुरू होने वाला पंक्ति इंडेक्स.columnIndex(इंटीजर, ज़रूरी है): शून्य से शुरू होने वाला कॉलम इंडेक्स.
rowSpan(इंटीजर, ज़रूरी है): टेबल की रेंज का पंक्ति स्पैन.columnSpan(इंटीजर, ज़रूरी है): टेबल रेंज का कॉलम स्पैन.
unmergeTableCells: टेबल में मौजूद सेल को अनमर्ज करता है. स्कीमा:tableRange(ऑब्जेक्ट, ज़रूरी है): टेबल की रेंज, जिससे यह पता चलता है कि किन सेल को अनमर्ज करना है:tableCellLocation(ऑब्जेक्ट, ज़रूरी है): रेफ़रंस सेल की जगह:tableStartLocation(ऑब्जेक्ट, ज़रूरी है): दस्तावेज़ में टेबल की शुरुआत की जगह:index(इंटीजर, ज़रूरी है): UTF-16 कोड यूनिट में टेबल की शुरुआत का शून्य-आधारित इंडेक्स.segmentId(स्ट्रिंग, ज़रूरी नहीं): हेडर, फ़ुटर या फ़ुटनोट का आईडी. दस्तावेज़ की मुख्य बॉडी के लिए खाली या छोड़ा गया.tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें टेबल मौजूद है.rowIndex(integer, required): शून्य से शुरू होने वाला पंक्ति इंडेक्स.columnIndex(इंटीजर, ज़रूरी है): शून्य से शुरू होने वाला कॉलम इंडेक्स.
rowSpan(इंटीजर, ज़रूरी है): टेबल की रेंज का पंक्ति स्पैन.columnSpan(इंटीजर, ज़रूरी है): टेबल रेंज का कॉलम स्पैन.
createHeader: इससे हेडर बनता है. स्कीमा:type(स्ट्रिंग, ज़रूरी है): हेडर का टाइप:"DEFAULT","FIRST_PAGE".sectionBreakLocation(ऑब्जेक्ट, ज़रूरी नहीं): सेक्शन ब्रेक की जगह, जिससे वह सेक्शन शुरू होता है जिससे यह हेडर जुड़ा है. अगर इसे शामिल नहीं किया जाता है, तो यह दस्तावेज़ की स्टाइल पर लागू होता है:index(इंटीजर, ज़रूरी है): UTF-16 कोड यूनिट में शून्य पर आधारित इंडेक्स.segmentId(स्ट्रिंग, ज़रूरी नहीं): हेडर, फ़ुटर या फ़ुटनोट का आईडी. दस्तावेज़ की मुख्य बॉडी के लिए खाली या छोड़ा गया.tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें सेक्शन ब्रेक मौजूद है.
createFooter: इससे फ़ुटर बनता है. स्कीमा:type(स्ट्रिंग, ज़रूरी है): फ़ुटर का टाइप:"DEFAULT","FIRST_PAGE".sectionBreakLocation(ऑब्जेक्ट, ज़रूरी नहीं): इस फ़ुटर से जुड़े सेक्शन से पहले मौजूद सेक्शन ब्रेक की जगह. अगर इसे शामिल नहीं किया जाता है, तो यह दस्तावेज़ की स्टाइल पर लागू होता है:index(इंटीजर, ज़रूरी है): UTF-16 कोड यूनिट में शून्य पर आधारित इंडेक्स.segmentId(स्ट्रिंग, ज़रूरी नहीं): हेडर, फ़ुटर या फ़ुटनोट का आईडी. दस्तावेज़ की मुख्य बॉडी के लिए खाली या छोड़ा गया.tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें सेक्शन ब्रेक मौजूद है.
createFootnote: इससे फ़ुटनोट बनता है. स्कीमा:- फ़ुटनोट रेफ़रंस की जगह (सिर्फ़ एक ज़रूरी है):
location(ऑब्जेक्ट): किसी खास इंडेक्स पर फ़ुटनोट का रेफ़रंस शामिल करता है:index(इंटीजर, ज़रूरी है): UTF-16 कोड यूनिट में शून्य पर आधारित इंडेक्स.tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें जगह की जानकारी मौजूद है.
endOfSegmentLocation(ऑब्जेक्ट): दस्तावेज़ के मुख्य हिस्से के आखिर में फ़ुटनोट का रेफ़रंस शामिल करता है:tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें जगह की जानकारी मौजूद है.
replaceNamedRangeContent: नाम वाली रेंज में मौजूद कॉन्टेंट को बदलता है. स्कीमा:text(स्ट्रिंग, ज़रूरी है): वह टेक्स्ट जिससे कॉन्टेंट को बदलना है.- नाम वाली रेंज का रेफ़रंस (सिर्फ़ एक ज़रूरी है):
namedRangeId(स्ट्रिंग): नाम वाली रेंज का आईडी जिसे बदलना है.namedRangeName(स्ट्रिंग): नाम वाली रेंज का नाम, जिसे बदलना है.tabsCriteria(ऑब्जेक्ट, ज़रूरी नहीं):tabIds(स्ट्रिंग का कलेक्शन, ज़रूरी नहीं): उन टैब आईडी की सूची जिनमें बदलाव किया गया है.
updateSectionStyle: तय की गई रेंज के सेक्शन की स्टाइल को अपडेट करता है. स्कीमा:range(ऑब्जेक्ट, ज़रूरी है): स्टाइल करने के लिए, रेंज के ओवरलैप होने वाले सेक्शन:startIndex(integer, optional): रेंज का शून्य पर आधारित स्टार्ट इंडेक्स.endIndex(integer, optional): रेंज का ज़ीरो-बेस्ड एंड इंडेक्स.tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें यह रेंज शामिल है.sectionStyle(ऑब्जेक्ट, ज़रूरी है): सेक्शन की स्टाइल प्रॉपर्टी:columnProperties(ऑब्जेक्ट का कलेक्शन, ज़रूरी नहीं): हर कॉलम की प्रॉपर्टी (ज़्यादा से ज़्यादा तीन कॉलम):paddingEnd(ऑब्जेक्ट, ज़रूरी नहीं): कॉलम के आखिर में पैडिंग:{"magnitude": number, "unit": "PT"}.width(ऑब्जेक्ट, ज़रूरी नहीं): कॉलम की चौड़ाई:{"magnitude": number, "unit": "PT"}.
columnSeparatorStyle(स्ट्रिंग, ज़रूरी नहीं):"NONE","BETWEEN_EACH_COLUMN".contentDirection(स्ट्रिंग, ज़रूरी नहीं):"LEFT_TO_RIGHT","RIGHT_TO_LEFT".marginTop/marginBottom/marginLeft/marginRight/marginHeader/marginFooter(ऑब्जेक्ट, ज़रूरी नहीं):{"magnitude": number, "unit": "PT"}.sectionType(स्ट्रिंग, ज़रूरी नहीं):"CONTINUOUS","NEXT_PAGE".fields(स्ट्रिंग, ज़रूरी है): अपडेट किए जाने वाले फ़ील्ड की कॉमा लगाकर अलग की गई लिस्ट (उदाहरण के लिए,"marginTop,sectionType"या"*").
insertSectionBreak: इससे बताई गई जगह पर सेक्शन ब्रेक जुड़ जाता है. स्कीमा:sectionType(स्ट्रिंग, ज़रूरी है): सेक्शन का टाइप:"CONTINUOUS"या"NEXT_PAGE".- इंसर्ट करने की जगह (सिर्फ़ एक ज़रूरी है):
location(ऑब्जेक्ट): दस्तावेज़ में किसी खास इंडेक्स पर सेक्शन ब्रेक शामिल करता है:index(इंटीजर, ज़रूरी है): UTF-16 कोड यूनिट में शून्य पर आधारित इंडेक्स.tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें जगह की जानकारी मौजूद है.
endOfSegmentLocation(object): दस्तावेज़ के मुख्य हिस्से के आखिर में सेक्शन ब्रेक शामिल करता है:tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें जगह की जानकारी मौजूद है.
deleteHeader: दस्तावेज़ से हेडर मिटाता है. स्कीमा:headerId(स्ट्रिंग, ज़रूरी है): मिटाए जाने वाले हेडर का आईडी.tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें मौजूद हेडर को मिटाना है.
deleteFooter: दस्तावेज़ से फ़ुटर मिटाता है. स्कीमा:footerId(स्ट्रिंग, ज़रूरी है): मिटाए जाने वाले फ़ुटर का आईडी.tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें मौजूद फ़ुटर को मिटाना है.
pinTableHeaderRows: टेबल में पिन की गई हेडर पंक्तियों की संख्या को अपडेट करता है. स्कीमा:tableStartLocation(ऑब्जेक्ट, ज़रूरी है): दस्तावेज़ में टेबल की शुरुआत की जगह:index(इंटीजर, ज़रूरी है): UTF-16 कोड यूनिट में टेबल की शुरुआत का शून्य-आधारित इंडेक्स.segmentId(स्ट्रिंग, ज़रूरी नहीं): हेडर, फ़ुटर या फ़ुटनोट का आईडी. दस्तावेज़ की मुख्य बॉडी के लिए खाली या छोड़ा गया.tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें टेबल मौजूद है.pinnedHeaderRowsCount(इंटीजर, ज़रूरी है): टेबल की उन पंक्तियों की संख्या जिन्हें पिन करना है. 0 डालने पर, सभी पंक्तियां अनपिन हो जाती हैं.
addDocumentTab: इससे दस्तावेज़ में एक टैब जुड़ जाता है. स्कीमा:tabProperties(ऑब्जेक्ट, ज़रूरी नहीं): जोड़े जाने वाले टैब की प्रॉपर्टी:tabId(स्ट्रिंग, ज़रूरी नहीं): उपयोगकर्ता का दिया गया टैब आईडी.title(स्ट्रिंग, ज़रूरी नहीं): टैब का टाइटल.index(इंटीजर, ज़रूरी नहीं): शून्य से शुरू होने वाला इंडेक्स, जहां टैब को शामिल किया जाएगा.parentTabId(स्ट्रिंग, ज़रूरी नहीं): नेस्ट किए गए टैब के लिए पैरंट टैब आईडी.iconEmoji(स्ट्रिंग, ज़रूरी नहीं): टैब के साथ दिखने वाला इमोजी आइकॉन.
deleteTab: दस्तावेज़ का कोई टैब मिटाता है. स्कीमा:tabId(स्ट्रिंग, ज़रूरी है): मिटाए जाने वाले टैब का आईडी.
updateDocumentTabProperties: दस्तावेज़ के टैब की प्रॉपर्टी अपडेट करता है. स्कीमा:tabProperties(ऑब्जेक्ट, ज़रूरी है): अपडेट करने के लिए टैब की प्रॉपर्टी:tabId(स्ट्रिंग, ज़रूरी है): अपडेट किए जाने वाले टैब का आईडी.title(स्ट्रिंग, ज़रूरी नहीं): टैब का अपडेट किया गया टाइटल.index(इंटीजर, ज़रूरी नहीं): टैब का अपडेट किया गया ज़ीरो-बेस्ड इंडेक्स.parentTabId(स्ट्रिंग, ज़रूरी नहीं): अपडेट किया गया पैरंट टैब आईडी.iconEmoji(स्ट्रिंग, ज़रूरी नहीं): टैब के साथ दिखने वाला अपडेट किया गया इमोजी आइकॉन.fields(स्ट्रिंग, ज़रूरी है): अपडेट किए जाने वाले फ़ील्ड की कॉमा लगाकर अलग की गई लिस्ट (उदाहरण के लिए,"title,iconEmoji"या"*").
insertPerson: इससे किसी व्यक्ति का नाम टैग किया जाता है. स्कीमा:personProperties(ऑब्जेक्ट, ज़रूरी है): व्यक्ति की प्रॉपर्टी:email(स्ट्रिंग, ज़रूरी है): व्यक्ति का ईमेल पता.name(स्ट्रिंग, ज़रूरी नहीं): व्यक्ति का नाम.- इंसर्ट करने की जगह (सिर्फ़ एक ज़रूरी है):
location(object): किसी व्यक्ति के नाम के टैग को किसी खास जगह पर शामिल करता है:index(इंटीजर, ज़रूरी है): UTF-16 कोड यूनिट में शून्य पर आधारित इंडेक्स.segmentId(स्ट्रिंग, ज़रूरी नहीं): हेडर, फ़ुटर या फ़ुटनोट का आईडी. दस्तावेज़ के मुख्य हिस्से के लिए खाली छोड़ें.tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें जगह की जानकारी मौजूद है.
endOfSegmentLocation(object): हेडर, फ़ुटर, फ़ुटनोट या दस्तावेज़ के मुख्य हिस्से के आखिर में, किसी व्यक्ति का नाम टैग करता है:segmentId(स्ट्रिंग, ज़रूरी नहीं): हेडर, फ़ुटर या फ़ुटनोट का आईडी. दस्तावेज़ के मुख्य हिस्से के लिए खाली छोड़ें.tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें जगह की जानकारी मौजूद है.
updateNamedStyle: नाम वाली स्टाइल को अपडेट करता है. स्कीमा:namedStyle(ऑब्जेक्ट, ज़रूरी है): अपडेट की जाने वाली स्टाइल का नाम:namedStyleType(स्ट्रिंग, ज़रूरी है): नाम वाली स्टाइल का टाइप:"NORMAL_TEXT","TITLE","SUBTITLE","HEADING_1","HEADING_2","HEADING_3","HEADING_4","HEADING_5","HEADING_6".textStyle(object, optional): इस नाम वाली स्टाइल के लिए, टेक्स्ट स्टाइल की प्रॉपर्टी.paragraphStyle(ऑब्जेक्ट, ज़रूरी नहीं): इस नाम वाली स्टाइल के लिए, पैराग्राफ़ की स्टाइल प्रॉपर्टी.fields(स्ट्रिंग, ज़रूरी है): अपडेट किए जाने वाले फ़ील्ड की कॉमा लगाकर अलग की गई लिस्ट (उदाहरण के लिए,"textStyle,paragraphStyle"या"*").tabId(स्ट्रिंग, ज़रूरी नहीं): अपडेट करने के लिए इस्तेमाल किया जाने वाला टैब.
insertRichLink: रिच लिंक डालें. स्कीमा:richLinkProperties(ऑब्जेक्ट, ज़रूरी है): रिच लिंक की प्रॉपर्टी:uri(स्ट्रिंग, ज़रूरी है): रिच लिंक का यूआरआई.title(स्ट्रिंग, ज़रूरी नहीं): रिच लिंक का टाइटल.mimeType(स्ट्रिंग, ज़रूरी नहीं): रिच लिंक का एमआईएमई टाइप.- इंसर्ट करने की जगह (सिर्फ़ एक ज़रूरी है):
location(object): किसी खास जगह पर रिच लिंक शामिल करता है:index(इंटीजर, ज़रूरी है): UTF-16 कोड यूनिट में शून्य पर आधारित इंडेक्स.segmentId(स्ट्रिंग, ज़रूरी नहीं): हेडर, फ़ुटर या फ़ुटनोट का आईडी. दस्तावेज़ के मुख्य हिस्से के लिए खाली छोड़ें.tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें जगह की जानकारी मौजूद है.
endOfSegmentLocation(object): हेडर, फ़ुटर, फ़ुटनोट या दस्तावेज़ के मुख्य हिस्से के आखिर में रिच लिंक शामिल करता है:segmentId(स्ट्रिंग, ज़रूरी नहीं): हेडर, फ़ुटर या फ़ुटनोट का आईडी. दस्तावेज़ के मुख्य हिस्से के लिए खाली छोड़ें.tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें जगह की जानकारी मौजूद है.
insertDate: इससे कोई तारीख डाली जाती है. स्कीमा:dateElementProperties(ऑब्जेक्ट, ज़रूरी है): तारीख की प्रॉपर्टी:timestamp(स्ट्रिंग, ज़रूरी है): यूटीसी टाइमस्टैंप.timeZoneId(स्ट्रिंग, ज़रूरी नहीं): टाइम ज़ोन (जैसे,"America/New_York"). डिफ़ॉल्ट रूप से,"etc/UTC"पर सेट होता है.locale(स्ट्रिंग, ज़रूरी नहीं): स्थानीय भाषा का कोड (जैसे,"en").dateFormat(स्ट्रिंग, ज़रूरी नहीं):"DATE_FORMAT_MONTH_DAY_ABBREVIATED","DATE_FORMAT_MONTH_DAY_FULL","DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED","DATE_FORMAT_ISO8601".timeFormat(स्ट्रिंग, ज़रूरी नहीं):"TIME_FORMAT_DISABLED","TIME_FORMAT_HOUR_MINUTE","TIME_FORMAT_HOUR_MINUTE_TIMEZONE".- इंसर्ट करने की जगह (सिर्फ़ एक ज़रूरी है):
location(object): किसी खास जगह पर तारीख डालता है:index(इंटीजर, ज़रूरी है): UTF-16 कोड यूनिट में शून्य पर आधारित इंडेक्स.segmentId(स्ट्रिंग, ज़रूरी नहीं): हेडर, फ़ुटर या फ़ुटनोट का आईडी. दस्तावेज़ के मुख्य हिस्से के लिए खाली छोड़ें.tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें जगह की जानकारी मौजूद है.
endOfSegmentLocation(ऑब्जेक्ट): हेडर, फ़ुटर या दस्तावेज़ के मुख्य हिस्से के आखिर में तारीख डालता है:segmentId(स्ट्रिंग, ज़रूरी नहीं): हेडर, फ़ुटर या फ़ुटनोट का आईडी. दस्तावेज़ के मुख्य हिस्से के लिए खाली छोड़ें.tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें जगह की जानकारी मौजूद है.
insertComment: दस्तावेज़ में टिप्पणी शामिल करता है. स्कीमा:content(स्ट्रिंग, ज़रूरी है): सामान्य टेक्स्ट वाली टिप्पणी का कॉन्टेंट.assigneeEmailAddress(स्ट्रिंग, ज़रूरी नहीं): उस व्यक्ति का ईमेल पता जिसे टिप्पणी असाइन की गई है. अगर आपको किसी टिप्पणी को असाइन नहीं करना है, तो इस फ़ील्ड को खाली छोड़ दें.- ऐंकर (सिर्फ़ एक ज़रूरी है):
range(ऑब्जेक्ट): दस्तावेज़ में मौजूद वह रेंज जिसमें टिप्पणी को ऐंकर करना है:startIndex(integer, optional): इस रेंज का शून्य पर आधारित स्टार्ट इंडेक्स.endIndex(integer, optional): इस रेंज का शून्य पर आधारित एंड इंडेक्स.segmentId(स्ट्रिंग, ज़रूरी नहीं): हेडर, फ़ुटर या फ़ुटनोट का आईडी. दस्तावेज़ के मुख्य हिस्से के लिए खाली छोड़ें.tabId(स्ट्रिंग, ज़रूरी नहीं): वह टैब जिसमें यह रेंज शामिल है.
addCommentReply: इससे किसी मौजूदा टिप्पणी या सुझाव के थ्रेड में जवाब जोड़ा जाता है. स्कीमा:- थ्रेड आईडी (सिर्फ़ एक आईडी डालना ज़रूरी है):
commentId(स्ट्रिंग): टिप्पणी की थ्रेड का आईडी.suggestionId(स्ट्रिंग): सुझाव वाले थ्रेड का आईडी.post(ऑब्जेक्ट, ज़रूरी है):content(स्ट्रिंग, ज़रूरी है, जब तक कि समस्या हल न हो जाए/फिर से न खुल जाए): जवाब का कॉन्टेंट, सादे टेक्स्ट में होना चाहिए.commentAction(स्ट्रिंग, ज़रूरी नहीं): टिप्पणी की थ्रेड के लिए कार्रवाई ("NO_COMMENT_ACTION_CHANGE","RESOLVE","REOPEN").assigneeEmail(स्ट्रिंग, ज़रूरी नहीं): उस उपयोगकर्ता का ईमेल पता जिसे इस पोस्ट के तहत, थ्रेड में नया असाइन किया जा रहा है.
updateCommentPost: इससे टिप्पणी की थ्रेड या सुझाव की थ्रेड में मौजूद टिप्पणी पोस्ट का कॉन्टेंट अपडेट होता है. स्कीमा:- थ्रेड आईडी (सिर्फ़ एक आईडी डालना ज़रूरी है):
commentId(स्ट्रिंग): टिप्पणी की थ्रेड का आईडी.suggestionId(स्ट्रिंग): सुझाव वाले थ्रेड का आईडी.postId(स्ट्रिंग, ज़रूरी है): अपडेट की जाने वाली टिप्पणी पोस्ट का आईडी.content(स्ट्रिंग, ज़रूरी है): टिप्पणी पोस्ट का अपडेट किया गया कॉन्टेंट.
deleteComment: इससे टिप्पणी की थ्रेड मिट जाती है. स्कीमा:commentId(स्ट्रिंग, ज़रूरी है): टिप्पणी की उस थ्रेड का आईडी जिसे मिटाना है.
deleteCommentReply: इससे टिप्पणी की थ्रेड या सुझाव की थ्रेड से, जवाब वाली पोस्ट मिट जाती है. स्कीमा:- थ्रेड आईडी (सिर्फ़ एक आईडी डालना ज़रूरी है):
commentId(स्ट्रिंग): टिप्पणी की थ्रेड का आईडी.suggestionId(स्ट्रिंग): सुझाव वाले थ्रेड का आईडी.postId(स्ट्रिंग, ज़रूरी है): जवाब वाली उस पोस्ट का आईडी जिसे मिटाना है.
acceptSuggestion: कोई सुझाव स्वीकार करता है. स्कीमा:suggestionId(स्ट्रिंग, ज़रूरी है): स्वीकार किए जाने वाले सुझाव का आईडी.
rejectSuggestion: इससे कोई सुझाव अस्वीकार किया जाता है. स्कीमा:suggestionId(स्ट्रिंग, ज़रूरी है): अस्वीकार किए जाने वाले सुझाव का आईडी.
deleteSuggestion: इससे कोई सुझाव मिटाया जाता है. स्कीमा:suggestionId(स्ट्रिंग, ज़रूरी है): मिटाए जाने वाले सुझाव का आईडी.
यहां दिए गए कोड सैंपल में, update_doc एमसीपी टूल को कॉल करने के लिए curl का इस्तेमाल करने का तरीका बताया गया है.
| Curl अनुरोध |
|---|
curl --location 'https://docsmcp.googleapis.com/mcp/v1' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'content-type: application/json' \ --header 'accept: application/json, text/event-stream' \ --data '{ "method": "tools/call", "params": { "name": "update_doc", "arguments": { // Provide these details according to the MCP tool specification. } }, "jsonrpc": "2.0", "id": 1 }' |
इनपुट स्कीमा
UpdateDocRequest
| JSON के काेड में दिखाना |
|---|
{
"documentId": string,
"requests": [
{
object
}
],
"writeControl": {
object ( |
| फ़ील्ड | |
|---|---|
documentId |
ज़रूरी है. उस दस्तावेज़ का आईडी जिसे अपडेट करना है. यह Drive टूल के file_id जैसा ही है. |
requests[] |
दस्तावेज़ में लागू किए जाने वाले अपडेट की सूची. हर अनुरोध, एक मान्य documents.batchUpdate Request ऑब्जेक्ट होना चाहिए. इसके लिए, इस स्कीमा का इस्तेमाल किया जाना चाहिए: https://developers.google.com/workspace/docs/api/reference/rest/v1/documents/request अनुरोधों को उनके तय किए गए क्रम में लागू किया जाएगा. अगर कोई अनुरोध मान्य नहीं है, तो कोई भी अनुरोध लागू नहीं किया जाएगा. |
writeControl |
ज़रूरी नहीं. इससे यह कंट्रोल किया जा सकता है कि डेटा लिखने के अनुरोधों को कैसे लागू किया जाए. |
स्ट्रक्ट
| JSON के काेड में दिखाना |
|---|
{ "fields": { string: value, ... } } |
| फ़ील्ड | |
|---|---|
fields |
डाइनैमिक तौर पर टाइप की गई वैल्यू का अनऑर्डर किया गया मैप. एक ऑब्जेक्ट, जिसमें |
FieldsEntry
| JSON के काेड में दिखाना |
|---|
{ "key": string, "value": value } |
| फ़ील्ड | |
|---|---|
key |
|
value |
|
वैल्यू
| JSON के काेड में दिखाना |
|---|
{ "nullValue": null, "numberValue": number, "stringValue": string, "boolValue": boolean, "structValue": { object }, "listValue": array } |
| फ़ील्ड | |
|---|---|
यूनियन फ़ील्ड kind. वैल्यू किस तरह की है. kind इनमें से सिर्फ़ एक हो सकता है: |
|
nullValue |
यह JSON |
numberValue |
यह JSON नंबर को दिखाता है. यह |
stringValue |
यह JSON स्ट्रिंग को दिखाता है. |
boolValue |
यह JSON बूलियन (JSON में |
structValue |
यह JSON ऑब्जेक्ट को दिखाता है. |
listValue |
यह JSON कलेक्शन को दिखाता है. |
ListValue
| JSON के काेड में दिखाना |
|---|
{ "values": [ value ] } |
| फ़ील्ड | |
|---|---|
values[] |
डाइनैमिक तौर पर टाइप की गई वैल्यू का दोहराया गया फ़ील्ड. |
WriteControl
| JSON के काेड में दिखाना |
|---|
{
"writeMode": enum ( |
| फ़ील्ड | |
|---|---|
writeMode |
ज़रूरी नहीं. अनुरोध का राइट मोड. |
यूनियन फ़ील्ड control. इससे यह तय होता है कि दस्तावेज़ के किस वर्शन में बदलाव करना है. साथ ही, अगर वह वर्शन दस्तावेज़ का मौजूदा वर्शन नहीं है, तो अनुरोध को कैसे मैनेज किया जाना चाहिए. control इनमें से सिर्फ़ एक हो सकता है: |
|
requiredRevisionId |
उस दस्तावेज़ का बदलाव आईडी जिस पर लिखने का अनुरोध लागू किया जाएगा. अगर यह दस्तावेज़ का सबसे नया वर्शन नहीं है, तो अनुरोध को प्रोसेस नहीं किया जाएगा. साथ ही, 400 Bad Request वाली गड़बड़ी का मैसेज दिखेगा. जब जवाब में ज़रूरी बदलाव का आईडी दिखता है, तो इससे अनुरोध लागू होने के बाद दस्तावेज़ के बदलाव का आईडी पता चलता है. |
targetRevisionId |
दस्तावेज़ का टारगेट रिविज़न आईडी, जिस पर लिखने का अनुरोध लागू किया जाएगा. अगर टारगेट रिविज़न आईडी को वापस पाने के बाद, साथ मिलकर काम करने वाले व्यक्ति ने बदलाव किए हैं, तो हो सकता है कि बदलावों का नतीजा, टारगेट रिविज़न आईडी पर लागू किए गए बदलावों से अलग हो. जब टारगेट रिविज़न आईडी तय किया जाता है, तो लिखने का अनुरोध, टारगेट रिविज़न आईडी के आधार पर लागू होता है. साथ ही, दस्तावेज़ का रिविज़न आईडी 1 से बढ़ जाता है. अगर आपने टारगेट रिविज़न आईडी की जानकारी नहीं दी है, तो डेटा डालने का अनुरोध, सबसे नए रिविज़न आईडी पर लागू होता है. साथ ही, दस्तावेज़ का रिविज़न आईडी एक अंक बढ़ जाता है. जब किसी जवाब में टारगेट रिविज़न आईडी दिखता है, तो इससे अनुरोध लागू होने के बाद दस्तावेज़ के रिविज़न आईडी का पता चलता है. |
NullValue
यह JSON null को दिखाता है.
NullValue एक सेंटिनल है. यह Value टाइप यूनियन के लिए, शून्य वैल्यू दिखाने के लिए सिर्फ़ एक वैल्यू वाले enum का इस्तेमाल करता है.
NullValue टाइप के फ़ील्ड में 0 के अलावा कोई भी वैल्यू अमान्य मानी जाती है. ज़्यादातर ProtoJSON सीरियलाइज़र, पूर्णांक वैल्यू के बावजूद, JSON null के तौर पर सेट किए गए null_value के साथ Value को एमिट करेंगे. साथ ही, 0 वैल्यू पर दोतरफ़ा यात्रा करेंगे.
| Enums | |
|---|---|
NULL_VALUE |
Null वैल्यू. |
WriteMode
डेटा लिखने के अनुरोधों के लिए मोड.
| Enums | |
|---|---|
WRITE_MODE_UNSPECIFIED |
डिफ़ॉल्ट राइट मोड. अगर किसी अनुरोध में राइट मोड की जानकारी नहीं दी जाती है, तो उसे EDIT माना जाता है. |
EDIT |
बदलाव सीधे दस्तावेज़ में लागू होते हैं. |
SUGGEST |
बदलावों को सुझावों के तौर पर जोड़ा जाता है. |
आउटपुट स्कीमा
UpdateDocResponse
| JSON के काेड में दिखाना |
|---|
{
"replies": [
{
object
}
],
"writeControl": {
object ( |
| फ़ील्ड | |
|---|---|
replies[] |
बैच अपडेट के अनुरोधों को लागू करने से मिले जवाब. इसमें गड़बड़ियां, चेतावनियां, और एपीआई से मिली रॉ जानकारी शामिल होती है. इससे मॉडल को अडजस्टमेंट करने में मदद मिलती है. रॉ एपीआई से मिली जानकारी, इस स्कीमा का इस्तेमाल करती है: https://developers.google.com/workspace/docs/api/reference/rest/v1/documents/response |
writeControl |
अपडेट लागू होने के बाद, दस्तावेज़ का बदलाव. अगर इस दौरान दस्तावेज़ में बदलाव किया गया है, तो बदलाव को अस्वीकार करने के लिए, अगले |
स्ट्रक्ट
| JSON के काेड में दिखाना |
|---|
{ "fields": { string: value, ... } } |
| फ़ील्ड | |
|---|---|
fields |
डाइनैमिक तौर पर टाइप की गई वैल्यू का अनऑर्डर किया गया मैप. एक ऑब्जेक्ट, जिसमें |
FieldsEntry
| JSON के काेड में दिखाना |
|---|
{ "key": string, "value": value } |
| फ़ील्ड | |
|---|---|
key |
|
value |
|
वैल्यू
| JSON के काेड में दिखाना |
|---|
{ "nullValue": null, "numberValue": number, "stringValue": string, "boolValue": boolean, "structValue": { object }, "listValue": array } |
| फ़ील्ड | |
|---|---|
यूनियन फ़ील्ड kind. वैल्यू किस तरह की है. kind इनमें से सिर्फ़ एक हो सकता है: |
|
nullValue |
यह JSON |
numberValue |
यह JSON नंबर को दिखाता है. यह |
stringValue |
यह JSON स्ट्रिंग को दिखाता है. |
boolValue |
यह JSON बूलियन (JSON में |
structValue |
यह JSON ऑब्जेक्ट को दिखाता है. |
listValue |
यह JSON कलेक्शन को दिखाता है. |
ListValue
| JSON के काेड में दिखाना |
|---|
{ "values": [ value ] } |
| फ़ील्ड | |
|---|---|
values[] |
डाइनैमिक तौर पर टाइप की गई वैल्यू का दोहराया गया फ़ील्ड. |
WriteControl
| JSON के काेड में दिखाना |
|---|
{
"writeMode": enum ( |
| फ़ील्ड | |
|---|---|
writeMode |
ज़रूरी नहीं. अनुरोध का राइट मोड. |
यूनियन फ़ील्ड control. इससे यह तय होता है कि दस्तावेज़ के किस वर्शन में बदलाव करना है. साथ ही, अगर वह वर्शन दस्तावेज़ का मौजूदा वर्शन नहीं है, तो अनुरोध को कैसे मैनेज किया जाना चाहिए. control इनमें से सिर्फ़ एक हो सकता है: |
|
requiredRevisionId |
उस दस्तावेज़ का बदलाव आईडी जिस पर लिखने का अनुरोध लागू किया जाएगा. अगर यह दस्तावेज़ का सबसे नया वर्शन नहीं है, तो अनुरोध को प्रोसेस नहीं किया जाएगा. साथ ही, 400 Bad Request वाली गड़बड़ी का मैसेज दिखेगा. जब जवाब में ज़रूरी बदलाव का आईडी दिखता है, तो इससे अनुरोध लागू होने के बाद दस्तावेज़ के बदलाव का आईडी पता चलता है. |
targetRevisionId |
दस्तावेज़ का टारगेट रिविज़न आईडी, जिस पर लिखने का अनुरोध लागू किया जाएगा. अगर टारगेट रिविज़न आईडी को वापस पाने के बाद, साथ मिलकर काम करने वाले व्यक्ति ने बदलाव किए हैं, तो हो सकता है कि बदलावों का नतीजा, टारगेट रिविज़न आईडी पर लागू किए गए बदलावों से अलग हो. जब टारगेट रिविज़न आईडी तय किया जाता है, तो लिखने का अनुरोध, टारगेट रिविज़न आईडी के आधार पर लागू होता है. साथ ही, दस्तावेज़ का रिविज़न आईडी 1 से बढ़ जाता है. अगर आपने टारगेट रिविज़न आईडी की जानकारी नहीं दी है, तो डेटा डालने का अनुरोध, सबसे नए रिविज़न आईडी पर लागू होता है. साथ ही, दस्तावेज़ का रिविज़न आईडी एक अंक बढ़ जाता है. जब किसी जवाब में टारगेट रिविज़न आईडी दिखता है, तो इससे अनुरोध लागू होने के बाद दस्तावेज़ के रिविज़न आईडी का पता चलता है. |
NullValue
यह JSON null को दिखाता है.
NullValue एक सेंटिनल है. यह Value टाइप यूनियन के लिए, शून्य वैल्यू दिखाने के लिए सिर्फ़ एक वैल्यू वाले enum का इस्तेमाल करता है.
NullValue टाइप के फ़ील्ड में 0 के अलावा कोई भी वैल्यू अमान्य मानी जाती है. ज़्यादातर ProtoJSON सीरियलाइज़र, पूर्णांक वैल्यू के बावजूद, JSON null के तौर पर सेट किए गए null_value के साथ Value को एमिट करेंगे. साथ ही, 0 वैल्यू पर दोतरफ़ा यात्रा करेंगे.
| Enums | |
|---|---|
NULL_VALUE |
Null वैल्यू. |
WriteMode
डेटा लिखने के अनुरोधों के लिए मोड.
| Enums | |
|---|---|
WRITE_MODE_UNSPECIFIED |
डिफ़ॉल्ट राइट मोड. अगर किसी अनुरोध में राइट मोड की जानकारी नहीं दी जाती है, तो उसे EDIT माना जाता है. |
EDIT |
बदलाव सीधे दस्तावेज़ में लागू होते हैं. |
SUGGEST |
बदलावों को सुझावों के तौर पर जोड़ा जाता है. |
टूल एनोटेशन
टूल के एनोटेशन, एमसीपी क्लाइंट को भेजे जाते हैं. इससे उन्हें किसी टूल से जुड़े बुनियादी जोखिम के बारे में जानकारी मिलती है. ज़्यादातर क्लाइंट इन संकेतों को भरोसेमंद नहीं मानते. हालांकि, इनका इस्तेमाल यह तय करने के लिए किया जा सकता है कि उपयोगकर्ता को पुष्टि करने का अनुरोध कब भेजा जाए.
टाइटल स्ट्रिंग के साथ-साथ, बूलियन हिंट के बारे में यहां बताया गया है:
readOnlyHint: अगर इसकी वैल्यू true है, तो टूल अपने एनवायरमेंट में बदलाव नहीं करता. डिफ़ॉल्ट: false.destructiveHint: अगर इसकी वैल्यू true है, तो टूल नुकसान पहुंचाने वाली कार्रवाइयां कर सकता है. अगर यह वैल्यू false पर सेट है, तो टूल सिर्फ़ जोड़ने वाली कार्रवाइयां कर सकता है. डिफ़ॉल्ट: true.idempotentHint: अगर इसकी वैल्यू true है, तो टूल को एक ही आर्ग्युमेंट के साथ बार-बार कॉल करने पर, उसके एनवायरमेंट पर कोई और असर नहीं पड़ेगा. डिफ़ॉल्ट: false.openWorldHint: सही होने पर, टूल बाहरी इकाइयों की 'विशाल दुनिया' के साथ इंटरैक्ट कर सकता है. अगर यह वैल्यू false पर सेट है, तो टूल सिर्फ़ इंटरनल इकाइयों के साथ इंटरैक्ट कर सकता है. उदाहरण के लिए, वेब सर्च टूल ओपन वर्ल्ड होगा, जबकि मेमोरी टूल ओपन वर्ल्ड नहीं होगा.
Destructive Hint: ❌ | Idempotent Hint: ❌ | Read Only Hint: ❌ | Open World Hint: ✅
अनुमति पाने के लिंक
इनमें से किसी एक OAuth स्कोप की ज़रूरत हाेती है:
https://www.googleapis.com/auth/drivehttps://www.googleapis.com/auth/drive.filehttps://www.googleapis.com/auth/documents