Requests

अनुरोध

किसी दस्तावेज़ पर लागू करने के लिए एक अपडेट.

JSON के काेड में दिखाना 
{

  "replaceAllText": {
    object (ReplaceAllTextRequest)
  },
  "insertText": {
    object (InsertTextRequest)
  },
  "updateTextStyle": {
    object (UpdateTextStyleRequest)
  },
  "createParagraphBullets": {
    object (CreateParagraphBulletsRequest)
  },
  "deleteParagraphBullets": {
    object (DeleteParagraphBulletsRequest)
  },
  "createNamedRange": {
    object (CreateNamedRangeRequest)
  },
  "deleteNamedRange": {
    object (DeleteNamedRangeRequest)
  },
  "updateParagraphStyle": {
    object (UpdateParagraphStyleRequest)
  },
  "deleteContentRange": {
    object (DeleteContentRangeRequest)
  },
  "insertInlineImage": {
    object (InsertInlineImageRequest)
  },
  "insertTable": {
    object (InsertTableRequest)
  },
  "insertTableRow": {
    object (InsertTableRowRequest)
  },
  "insertTableColumn": {
    object (InsertTableColumnRequest)
  },
  "deleteTableRow": {
    object (DeleteTableRowRequest)
  },
  "deleteTableColumn": {
    object (DeleteTableColumnRequest)
  },
  "insertPageBreak": {
    object (InsertPageBreakRequest)
  },
  "deletePositionedObject": {
    object (DeletePositionedObjectRequest)
  },
  "updateTableColumnProperties": {
    object (UpdateTableColumnPropertiesRequest)
  },
  "updateTableCellStyle": {
    object (UpdateTableCellStyleRequest)
  },
  "updateTableRowStyle": {
    object (UpdateTableRowStyleRequest)
  },
  "replaceImage": {
    object (ReplaceImageRequest)
  },
  "updateDocumentStyle": {
    object (UpdateDocumentStyleRequest)
  },
  "mergeTableCells": {
    object (MergeTableCellsRequest)
  },
  "unmergeTableCells": {
    object (UnmergeTableCellsRequest)
  },
  "createHeader": {
    object (CreateHeaderRequest)
  },
  "createFooter": {
    object (CreateFooterRequest)
  },
  "createFootnote": {
    object (CreateFootnoteRequest)
  },
  "replaceNamedRangeContent": {
    object (ReplaceNamedRangeContentRequest)
  },
  "updateSectionStyle": {
    object (UpdateSectionStyleRequest)
  },
  "insertSectionBreak": {
    object (InsertSectionBreakRequest)
  },
  "deleteHeader": {
    object (DeleteHeaderRequest)
  },
  "deleteFooter": {
    object (DeleteFooterRequest)
  },
  "pinTableHeaderRows": {
    object (PinTableHeaderRowsRequest)
  },
  "addDocumentTab": {
    object (AddDocumentTabRequest)
  },
  "deleteTab": {
    object (DeleteTabRequest)
  },
  "updateDocumentTabProperties": {
    object (UpdateDocumentTabPropertiesRequest)
  },
  "insertPerson": {
    object (InsertPersonRequest)
  },
  "updateNamedStyle": {
    object (UpdateNamedStyleRequest)
  },
  "insertRichLink": {
    object (InsertRichLinkRequest)
  },
  "insertDate": {
    object (InsertDateRequest)
  },
  "insertComment": {
    object (InsertCommentRequest)
  },
  "addCommentReply": {
    object (AddCommentReplyRequest)
  },
  "updateCommentPost": {
    object (UpdateCommentPostRequest)
  },
  "deleteComment": {
    object (DeleteCommentRequest)
  },
  "deleteCommentReply": {
    object (DeleteCommentReplyRequest)
  },
  "acceptSuggestion": {
    object (AcceptSuggestionRequest)
  },
  "rejectSuggestion": {
    object (RejectSuggestionRequest)
  },
  "deleteSuggestion": {
    object (DeleteSuggestionRequest)
  }
}
फ़ील्ड
यूनियन फ़ील्ड request. लागू करने के लिए खास अनुरोध. सिर्फ़ एक फ़ील्ड की ज़रूरत है. request इनमें से सिर्फ़ एक हो सकता है:
replaceAllText

object (ReplaceAllTextRequest)

यह फ़ंक्शन, बताए गए टेक्स्ट के सभी इंस्टेंस को बदलता है.

insertText

object (InsertTextRequest)

यह फ़ंक्शन, बताई गई जगह पर टेक्स्ट डालता है.

updateTextStyle

object (UpdateTextStyleRequest)

इससे, तय की गई रेंज में टेक्स्ट की स्टाइल अपडेट की जाती है.

createParagraphBullets

object (CreateParagraphBulletsRequest)

यह फ़ंक्शन, पैराग्राफ़ के लिए बुलेट बनाता है.

deleteParagraphBullets

object (DeleteParagraphBulletsRequest)

इससे पैराग्राफ़ से बुलेट मिट जाते हैं.

createNamedRange

object (CreateNamedRangeRequest)

नाम वाली रेंज बनाता है.

deleteNamedRange

object (DeleteNamedRangeRequest)

यह फ़ंक्शन, किसी नामित रेंज को मिटाता है.

updateParagraphStyle

object (UpdateParagraphStyleRequest)

इससे पैराग्राफ़ की स्टाइल को तय की गई रेंज में अपडेट किया जाता है.

deleteContentRange

object (DeleteContentRangeRequest)

यह कुकी, दस्तावेज़ से कॉन्टेंट मिटाती है.

insertInlineImage

object (InsertInlineImageRequest)

इस फ़ंक्शन की मदद से, बताई गई जगह पर इनलाइन इमेज डाली जा सकती है.

insertTable

object (InsertTableRequest)

इस फ़ंक्शन की मदद से, बताई गई जगह पर टेबल डाली जाती है.

insertTableRow

object (InsertTableRowRequest)

इस फ़ंक्शन की मदद से, टेबल में एक खाली लाइन जोड़ी जा सकती है.

insertTableColumn

object (InsertTableColumnRequest)

इस फ़ंक्शन की मदद से, टेबल में एक खाली कॉलम जोड़ा जा सकता है.

deleteTableRow

object (DeleteTableRowRequest)

यह फ़ंक्शन, टेबल से किसी पंक्ति को मिटाता है.

deleteTableColumn

object (DeleteTableColumnRequest)

यह फ़ंक्शन, टेबल से किसी कॉलम को मिटाता है.

insertPageBreak

object (InsertPageBreakRequest)

यह फ़ंक्शन, बताई गई जगह पर पेज ब्रेक डालता है.

deletePositionedObject

object (DeletePositionedObjectRequest)

यह फ़ंक्शन, दस्तावेज़ से किसी ऑब्जेक्ट को मिटाता है.

updateTableColumnProperties

object (UpdateTableColumnPropertiesRequest)

यह फ़ंक्शन, टेबल में मौजूद कॉलम की प्रॉपर्टी अपडेट करता है.

updateTableCellStyle

object (UpdateTableCellStyleRequest)

इससे टेबल सेल की स्टाइल अपडेट की जाती है.

updateTableRowStyle

object (UpdateTableRowStyleRequest)

यह विकल्प, टेबल में लाइन की स्टाइल को अपडेट करता है.

replaceImage

object (ReplaceImageRequest)

दस्तावेज़ में मौजूद किसी इमेज को बदलता है.

updateDocumentStyle

object (UpdateDocumentStyleRequest)

दस्तावेज़ की स्टाइल को अपडेट करता है.

mergeTableCells

object (MergeTableCellsRequest)

इस फ़ंक्शन का इस्तेमाल, टेबल में मौजूद सेल को मर्ज करने के लिए किया जाता है.

unmergeTableCells

object (UnmergeTableCellsRequest)

इस विकल्प का इस्तेमाल करके, टेबल में सेल को अलग किया जा सकता है.

createHeader

object (CreateHeaderRequest)

इससे हेडर बनता है.

createFootnote

object (CreateFootnoteRequest)

फ़ुटनोट बनाता है.

replaceNamedRangeContent

object (ReplaceNamedRangeContentRequest)

नाम वाली किसी रेंज में मौजूद कॉन्टेंट को बदलता है.

updateSectionStyle

object (UpdateSectionStyleRequest)

इससे चुनी गई रेंज के सेक्शन की स्टाइल अपडेट की जाती है.

insertSectionBreak

object (InsertSectionBreakRequest)

यह फ़ंक्शन, बताई गई जगह पर सेक्शन ब्रेक डालता है.

deleteHeader

object (DeleteHeaderRequest)

यह दस्तावेज़ से हेडर मिटाता है.

pinTableHeaderRows

object (PinTableHeaderRowsRequest)

यह फ़ंक्शन, किसी टेबल में पिन की गई हेडर लाइनों की संख्या को अपडेट करता है.

addDocumentTab

object (AddDocumentTabRequest)

यह कुकी, दस्तावेज़ टैब जोड़ती है.

deleteTab

object (DeleteTabRequest)

यह दस्तावेज़ का टैब मिटाता है.

updateDocumentTabProperties

object (UpdateDocumentTabPropertiesRequest)

यह फ़ंक्शन, किसी दस्तावेज़ टैब की प्रॉपर्टी अपडेट करता है.

insertPerson

object (InsertPersonRequest)

इससे किसी व्यक्ति का नाम टैग किया जाता है.

updateNamedStyle

object (UpdateNamedStyleRequest)

यह फ़ंक्शन, नाम वाली स्टाइल को अपडेट करता है.

insertDate

object (InsertDateRequest)

यह फ़ंक्शन, तारीख डालता है.

insertComment

object (InsertCommentRequest)

दस्तावेज़ में CommentThread शामिल करता है.

addCommentReply

object (AddCommentReplyRequest)

यह CommentThread या SuggestionThread में जवाब जोड़ता है.

updateCommentPost

object (UpdateCommentPostRequest)

इस फ़ंक्शन का इस्तेमाल, CommentThread या SuggestionThread की किसी मौजूदा पोस्ट (मुख्य पोस्ट या जवाब) को अपडेट करने के लिए किया जाता है.

deleteComment

object (DeleteCommentRequest)

यह CommentThread को मिटाता है.

deleteCommentReply

object (DeleteCommentReplyRequest)

यह Post से CommentThread या SuggestionThread के जवाब को मिटाता है.

acceptSuggestion

object (AcceptSuggestionRequest)

सुझाव स्वीकार करता है.

rejectSuggestion

object (RejectSuggestionRequest)

सुझाव को अस्वीकार करता है.

deleteSuggestion

object (DeleteSuggestionRequest)

यह कुकी, सुझाव को मिटाती है.

ReplaceAllTextRequest

किसी शर्त से मेल खाने वाले टेक्स्ट के सभी इंस्टेंस को replace text से बदलता है.

JSON के काेड में दिखाना 
{
  "replaceText": string,
  "tabsCriteria": {
    object (TabsCriteria)
  },

  "containsText": {
    object (SubstringMatchCriteria)
  }
}
फ़ील्ड
replaceText

string

वह टेक्स्ट जो मैच किए गए टेक्स्ट की जगह लेगा.

tabsCriteria

object (TabsCriteria)

ज़रूरी नहीं. यह तय करने के लिए इस्तेमाल की जाने वाली शर्तें कि किस टैब में बदलाव किया जाएगा.

अगर इस विकल्प को शामिल नहीं किया जाता है, तो बदलाव सभी टैब पर लागू होता है.

एक टैब वाले दस्तावेज़ में:

  • अगर यह वैल्यू दी गई है, तो यह सिंगुलर टैब के आईडी से मेल खानी चाहिए.

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

एक से ज़्यादा टैब वाले दस्तावेज़ में:

  • अगर बदलाव दिया गया है, तो यह बदलाव चुने गए टैब पर लागू होगा.

  • अगर इसे शामिल नहीं किया जाता है, तो बदलाव सभी टैब पर लागू होगा.

यूनियन फ़ील्ड criteria. बदले जाने वाले टेक्स्ट से मैच करने के लिए इस्तेमाल की गई शर्तें. criteria इनमें से सिर्फ़ एक हो सकता है:
containsText

object (SubstringMatchCriteria)

दस्तावेज़ में इस सबस्ट्रिंग से मेल खाने वाला टेक्स्ट ढूंढता है.

SubstringMatchCriteria

ऐसी शर्त जो दस्तावेज़ में मौजूद टेक्स्ट की किसी खास स्ट्रिंग से मेल खाती हो.

JSON के काेड में दिखाना 
{
  "text": string,
  "matchCase": boolean,
  "searchByRegex": boolean
}
फ़ील्ड
text

string

दस्तावेज़ में खोजे जाने वाला टेक्स्ट.

matchCase

boolean

इससे पता चलता है कि खोज में केस का ध्यान रखना चाहिए या नहीं:

  • True : खोज के लिए इस्तेमाल होने वाले शब्दों में, केस-सेंसिटिव (बड़े और छोटे अक्षरों में अंतर) का ध्यान रखने की ज़रूरत होती है.
  • False : खोज केस-इनसेंसिटिव होती है.
searchByRegex

boolean

ज़रूरी नहीं. अगर खोजी जाने वाली वैल्यू को रेगुलर एक्सप्रेशन के तौर पर माना जाना चाहिए, तो यह विकल्प सही होता है. पैटर्न में मौजूद किसी भी बैकस्लैश को एस्केप किया जाना चाहिए.

  • True : खोजे जाने वाले टेक्स्ट को रेगुलर एक्सप्रेशन माना जाता है.
  • False : खोज के लिए इस्तेमाल किए गए टेक्स्ट को मैचिंग के लिए सबस्ट्रिंग के तौर पर माना जाता है.

TabsCriteria

यह एक ऐसी शर्त है जिससे यह तय होता है कि अनुरोध किन टैब में पूरा होगा.

JSON के काेड में दिखाना 
{
  "tabIds": [
    string
  ]
}
फ़ील्ड
tabIds[]

string

उन टैब आईडी की सूची जिनमें अनुरोध पूरा किया जाता है.

InsertTextRequest

यह फ़ंक्शन, बताई गई जगह पर टेक्स्ट डालता है.

JSON के काेड में दिखाना 
{
  "text": string,

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
फ़ील्ड
text

string

वह टेक्स्ट जिसे शामिल करना है.

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

जोड़ा गया टेक्स्ट किस स्टाइल में दिखेगा, यह अपने-आप तय होगा. आम तौर पर, यह आस-पास के टेक्स्ट की स्टाइल के हिसाब से तय होता है. ज़्यादातर मामलों में, डाले गए टेक्स्ट की स्टाइल, डालने के इंडेक्स से ठीक पहले मौजूद टेक्स्ट से मेल खाएगी.

कंट्रोल वाले कुछ वर्ण (U+0000-U+0008, U+000C-U+001F) और यूनिकोड बेसिक मल्टीलिंग्वल प्लेन प्राइवेट यूज़ एरिया (U+E000-U+F8FF) के वर्ण, डाले गए टेक्स्ट से हटा दिए जाएंगे.

यूनियन फ़ील्ड insertion_location. वह जगह जहां टेक्स्ट डाला जाएगा. insertion_location इनमें से सिर्फ़ एक हो सकता है:
location

object (Location)

दस्तावेज़ में किसी खास इंडेक्स पर टेक्स्ट डालता है.

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

endOfSegmentLocation

object (EndOfSegmentLocation)

यह हेडर, फ़ुटर, फ़ुटनोट या दस्तावेज़ के मुख्य हिस्से के आखिर में टेक्स्ट जोड़ता है.

जगह

दस्तावेज़ में कोई खास जगह.

JSON के काेड में दिखाना 
{
  "segmentId": string,
  "index": integer,
  "tabId": string
}
फ़ील्ड
segmentId

string

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

index

integer

UTF-16 कोड यूनिट में, ज़ीरो पर आधारित इंडेक्स.

यह इंडेक्स, segmentId में बताए गए सेगमेंट की शुरुआत से जुड़ा होता है.

tabId

string

वह टैब जिसमें जगह की जानकारी मौजूद है. इस विकल्प को शामिल न करने पर, अनुरोध पहले टैब पर लागू होता है.

एक टैब वाले दस्तावेज़ में:

  • अगर यह वैल्यू दी गई है, तो यह सिंगुलर टैब के आईडी से मेल खानी चाहिए.

  • अगर इसे शामिल नहीं किया जाता है, तो अनुरोध सिर्फ़ एक टैब पर लागू होता है.

एक से ज़्यादा टैब वाले दस्तावेज़ में:

  • अगर यह विकल्प चुना जाता है, तो अनुरोध बताए गए टैब पर लागू होता है.

  • अगर इसे शामिल नहीं किया जाता है, तो अनुरोध दस्तावेज़ के पहले टैब पर लागू होता है.

EndOfSegmentLocation

मुख्य जानकारी, हेडर, फ़ुटर या फ़ुटनोट के आखिर में मौजूद जगह. जगह की जानकारी, दस्तावेज़ सेगमेंट में आखिरी नई लाइन से ठीक पहले मौजूद हो.

JSON के काेड में दिखाना 
{
  "segmentId": string,
  "tabId": string
}
फ़ील्ड
segmentId

string

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

tabId

string

वह टैब जिसमें जगह की जानकारी मौजूद है. इस विकल्प को शामिल न करने पर, अनुरोध पहले टैब पर लागू होता है.

एक टैब वाले दस्तावेज़ में:

  • अगर यह वैल्यू दी गई है, तो यह सिंगुलर टैब के आईडी से मेल खानी चाहिए.

  • अगर इसे शामिल नहीं किया जाता है, तो अनुरोध सिर्फ़ एक टैब पर लागू होता है.

एक से ज़्यादा टैब वाले दस्तावेज़ में:

  • अगर यह विकल्प चुना जाता है, तो अनुरोध बताए गए टैब पर लागू होता है.

  • अगर इसे शामिल नहीं किया जाता है, तो अनुरोध दस्तावेज़ के पहले टैब पर लागू होता है.

UpdateTextStyleRequest

टेक्स्ट की स्टाइल अपडेट करें.

JSON के काेड में दिखाना 
{
  "textStyle": {
    object (TextStyle)
  },
  "fields": string,

  "range": {
    object (Range)
  }
}
फ़ील्ड
textStyle

object (TextStyle)

टेक्स्ट पर सेट किए जाने वाले स्टाइल.

अगर किसी स्टाइल की वैल्यू, पैरंट स्टाइल की वैल्यू से मैच करती है, तो उस स्टाइल को इनहेरिट करने के लिए सेट किया जाएगा.

टेक्स्ट स्टाइल में कुछ बदलाव करने से, Docs एडिटर के व्यवहार को दिखाने के लिए अन्य बदलाव हो सकते हैं. ज़्यादा जानकारी के लिए, TextStyle का दस्तावेज़ देखें.

fields

string (FieldMask format)

वे फ़ील्ड जिन्हें अपडेट किया जाना चाहिए.

कम से कम एक फ़ील्ड के बारे में बताना ज़रूरी है. रूट textStyle अपने-आप जुड़ जाता है और इसकी वैल्यू सबमिट करने की ज़रूरत नहीं होती. हर फ़ील्ड को लिस्ट करने के लिए, एक "*" का इस्तेमाल शॉर्ट-हैंड के तौर पर किया जा सकता है.

उदाहरण के लिए, टेक्स्ट की स्टाइल को बोल्ड में अपडेट करने के लिए, fields को "bold" पर सेट करें.

किसी प्रॉपर्टी को उसकी डिफ़ॉल्ट वैल्यू पर रीसेट करने के लिए, फ़ील्ड मास्क में उसका फ़ील्ड नाम शामिल करें. हालांकि, फ़ील्ड को अनसेट छोड़ दें.

यूनियन फ़ील्ड insertion_location. इस्तेमाल की गई रेंज का टाइप, जहां टेक्स्ट स्टाइल अपडेट की जाएगी. insertion_location इनमें से सिर्फ़ एक हो सकता है:
range

object (Range)

स्टाइल करने के लिए टेक्स्ट की रेंज.

रेंज को बढ़ाकर, आस-पास की नई लाइनों को शामिल किया जा सकता है.

अगर रेंज में सूची का कोई पैराग्राफ़ पूरी तरह से शामिल है, तो पैराग्राफ़ के बुलेट को भी मिलती-जुलती टेक्स्ट स्टाइल के साथ अपडेट किया जाता है.

UpdateTextStyleRequest से मिलते-जुलते अनुरोध में रेंज नहीं डाली जा सकती.

CreateParagraphBulletsRequest

यह उन सभी पैराग्राफ़ के लिए बुलेट बनाता है जो दी गई रेंज से ओवरलैप होते हैं.

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

अगर अपडेट किए जा रहे पैराग्राफ़ से ठीक पहले वाला पैराग्राफ़, मेल खाने वाले प्रीसेट वाली सूची में है, तो अपडेट किए जा रहे पैराग्राफ़ को उस सूची में जोड़ दिया जाता है.

JSON के काेड में दिखाना 
{
  "range": {
    object (Range)
  },
  "bulletPreset": enum (BulletGlyphPreset)
}
फ़ील्ड
range

object (Range)

वह रेंज जिस पर बुलेट प्रीसेट लागू करना है.

bulletPreset

enum (BulletGlyphPreset)

इस्तेमाल किए जाने वाले बुलेट ग्लिफ़ के टाइप.

BulletGlyphPreset

सूचियों के लिए, बुलेट ग्लिफ़ के प्रीसेट पैटर्न.

इन पैटर्न में इस तरह की बुलेट का इस्तेमाल किया जाता है:

  • ARROW : यह यूनिकोड U+2794 कोड पॉइंट के हिसाब से एक ऐरो है
  • ARROW3D : यह एक ऐरो है, जिसमें 3D शेडिंग है. यह यूनिकोड U+27a2 कोड पॉइंट से मेल खाता है
  • CHECKBOX : यह एक खाली वर्ग है. यह यूनिकोड U+274f कोड पॉइंट के बराबर है
  • CIRCLE : यह एक खाली सर्कल है. यह यूनिकोड U+25cb कोड पॉइंट के बराबर होता है
  • DIAMOND : यह एक सॉलिड डायमंड है. यह यूनिकोड U+25c6 कोड पॉइंट के बराबर है
  • DIAMONDX : 'x' वाला डायमंड, जो यूनिकोड U+2756 कोड पॉइंट के बराबर होता है
  • HOLLOWDIAMOND : A hollow diamond, corresponding to a Unicode U+25c7 code point
  • DISC : यह एक सॉलिड सर्कल है, जो यूनिकोड U+25cf कोड पॉइंट के बराबर है
  • SQUARE : यह एक सॉलिड स्क्वेयर है. यह यूनिकोड U+25a0 कोड पॉइंट के बराबर होता है
  • STAR : एक स्टार, जो यूनिकोड U+2605 कोड पॉइंट के मुताबिक है
  • ALPHA : अंग्रेज़ी का कोई छोटा अक्षर, जैसे कि 'a', 'b' या 'c'.
  • UPPERALPHA : अंग्रेज़ी का कोई बड़ा अक्षर, जैसे कि 'A', 'B' या 'C'.
  • DECIMAL : कोई संख्या, जैसे कि '1', '2' या '3'.
  • ZERODECIMAL : ऐसा नंबर जिसमें एक अंक वाली संख्याओं से पहले शून्य लगाया जाता है. जैसे, '01', '02' या '03'. एक से ज़्यादा अंकों वाले नंबरों के पहले शून्य नहीं लगाया जाता.
  • ROMAN : रोमन अंकों का छोटा अक्षर, जैसे कि 'i', 'ii' या 'iii'.
  • UPPERROMAN : यह कैपिटल लेटर वाला रोमन अंक होता है, जैसे कि 'I', 'II' या 'III'.
  • LEFTTRIANGLE : बाईं ओर इशारा करने वाला त्रिकोण. यह यूनिकोड U+25c4 कोड पॉइंट से मेल खाता है
Enums
BULLET_GLYPH_PRESET_UNSPECIFIED बुलेट ग्लिफ़ प्रीसेट की जानकारी नहीं दी गई है.
BULLET_DISC_CIRCLE_SQUARE बुलेट वाली सूची में, सूची के पहले तीन नेस्टिंग लेवल के लिए DISC, CIRCLE, और SQUARE बुलेट ग्लिफ़ मौजूद हैं.
BULLET_DIAMONDX_ARROW3D_SQUARE बुलेट वाली सूची में, सूची के पहले तीन नेस्टिंग लेवल के लिए DIAMONDX, ARROW3D, और SQUARE बुलेट ग्लिफ़ मौजूद हैं.
BULLET_CHECKBOX बुलेट वाली सूची, जिसमें CHECKBOX सूची के सभी नेस्टिंग लेवल के लिए बुलेट ग्लिफ़ मौजूद हैं.
BULLET_ARROW_DIAMOND_DISC बुलेट वाली सूची में, सूची नेस्टिंग के पहले तीन लेवल के लिए ARROW, DIAMOND, और DISC बुलेट ग्लिफ़ दिए गए हैं.
BULLET_STAR_CIRCLE_SQUARE बुलेट वाली सूची में, सूची के पहले तीन नेस्टिंग लेवल के लिए STAR, CIRCLE, और SQUARE बुलेट ग्लिफ़ मौजूद हैं.
BULLET_ARROW3D_CIRCLE_SQUARE बुलेट वाली सूची में, सूची नेस्टिंग के पहले तीन लेवल के लिए ARROW3D, CIRCLE, और SQUARE बुलेट ग्लिफ़ दिए गए हैं.
BULLET_LEFTTRIANGLE_DIAMOND_DISC बुलेट वाली सूची में, सूची नेस्टिंग के पहले तीन लेवल के लिए LEFTTRIANGLE, DIAMOND, और DISC बुलेट ग्लिफ़ दिए गए हैं.
BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE बुलेट वाली सूची में, सूची नेस्टिंग के पहले तीन लेवल के लिए DIAMONDX, HOLLOWDIAMOND, और SQUARE बुलेट ग्लिफ़ दिए गए हैं.
BULLET_DIAMOND_CIRCLE_SQUARE बुलेट वाली सूची में, सूची के पहले तीन नेस्टिंग लेवल के लिए DIAMOND, CIRCLE, और SQUARE बुलेट ग्लिफ़ मौजूद हैं.
NUMBERED_DECIMAL_ALPHA_ROMAN नंबर वाली सूची में, पहले तीन नेस्टिंग लेवल के लिए DECIMAL, ALPHA, और ROMAN न्यूमेरिक ग्लिफ़ का इस्तेमाल किया गया है. इसके बाद, पीरियड का इस्तेमाल किया गया है.
NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS नंबर वाली सूची में, पहले तीन नेस्टिंग लेवल के लिए DECIMAL, ALPHA, और ROMAN न्यूमेरिक ग्लिफ़ हैं. इसके बाद, पैरंटheses का इस्तेमाल किया गया है.
NUMBERED_DECIMAL_NESTED नंबर वाली सूची, जिसमें DECIMAL शामिल हैं DECIMAL . इसमें अंकों वाले ग्लिफ़ को पीरियड से अलग किया जाता है. साथ ही, हर नेस्टिंग लेवल, पिछले नेस्टिंग लेवल के ग्लिफ़ को प्रीफ़िक्स के तौर पर इस्तेमाल करता है. उदाहरण के लिए: '1.', '1.1.', '2.', '2.2.'.
NUMBERED_UPPERALPHA_ALPHA_ROMAN नंबर वाली सूची में, पहले तीन नेस्टिंग लेवल के लिए UPPERALPHA, ALPHA, और ROMAN न्यूमेरिक ग्लिफ़ का इस्तेमाल किया गया है. इसके बाद, पीरियड का इस्तेमाल किया गया है.
NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL नंबर वाली सूची में, पहले तीन नेस्टिंग लेवल के लिए UPPERROMAN, UPPERALPHA, और DECIMAL न्यूमेरिक ग्लिफ़ का इस्तेमाल किया गया है. इसके बाद, पीरियड का इस्तेमाल किया गया है.
NUMBERED_ZERODECIMAL_ALPHA_ROMAN नंबर वाली सूची में, पहले तीन नेस्टिंग लेवल के लिए ZERODECIMAL, ALPHA, और ROMAN न्यूमेरिक ग्लिफ़ का इस्तेमाल किया गया है. इसके बाद, पीरियड का इस्तेमाल किया गया है.

DeleteParagraphBulletsRequest

यह फ़ंक्शन, दी गई रेंज में आने वाले सभी पैराग्राफ़ से बुलेट हटाता है.

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

JSON के काेड में दिखाना 
{
  "range": {
    object (Range)
  }
}
फ़ील्ड
range

object (Range)

वह रेंज जिससे बुलेट हटाने हैं.

CreateNamedRangeRequest

यह दी गई रेंज का रेफ़रंस NamedRange बनाता है.

JSON के काेड में दिखाना 
{
  "name": string,
  "range": {
    object (Range)
  }
}
फ़ील्ड
name

string

NamedRange का नाम. नाम अलग-अलग होने ज़रूरी नहीं हैं.

नाम में कम से कम एक वर्ण और ज़्यादा से ज़्यादा 256 वर्ण होने चाहिए. वर्णों की गिनती, UTF-16 कोड यूनिट में की जाती है.

range

object (Range)

वह रेंज जिस पर नाम लागू करना है.

DeleteNamedRangeRequest

यह NamedRange को मिटाता है.

JSON के काेड में दिखाना 
{
  "tabsCriteria": {
    object (TabsCriteria)
  },

  "namedRangeId": string,
  "name": string
}
फ़ील्ड
tabsCriteria

object (TabsCriteria)

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

एक टैब वाले दस्तावेज़ में:

  • अगर यह वैल्यू दी गई है, तो यह सिंगुलर टैब के आईडी से मेल खानी चाहिए.

  • अगर इसे शामिल नहीं किया जाता है, तो रेंज मिटाने की सुविधा सिर्फ़ एक टैब पर लागू होती है.

एक से ज़्यादा टैब वाले दस्तावेज़ में:

  • अगर यह विकल्प चुना जाता है, तो रेंज मिटाने की सुविधा, चुनी गई टैब पर लागू होती है.

  • अगर यह पैरामीटर उपलब्ध नहीं कराया गया है, तो रेंज मिटाने की सुविधा सभी टैब पर लागू होगी.

यूनियन फ़ील्ड named_range_reference. वह वैल्यू जिससे यह तय होता है कि कौनसी रेंज या रेंज मिटानी हैं. इनमें से किसी एक को सेट करना ज़रूरी है. named_range_reference इनमें से सिर्फ़ एक हो सकता है:
namedRangeId

string

मिटाई जाने वाली नाम वाली रेंज का आईडी.

name

string

मिटाई जाने वाली रेंज का नाम. दिए गए नाम वाली सभी नेम रेंज मिटा दी जाएंगी.

UpdateParagraphStyleRequest

दी गई रेंज में आने वाले सभी पैराग्राफ़ की स्टाइल अपडेट करता है.

JSON के काेड में दिखाना 
{
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "fields": string,

  "range": {
    object (Range)
  }
}
फ़ील्ड
paragraphStyle

object (ParagraphStyle)

पैराग्राफ़ पर सेट की जाने वाली स्टाइल.

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

fields

string (FieldMask format)

वे फ़ील्ड जिन्हें अपडेट किया जाना चाहिए.

कम से कम एक फ़ील्ड के बारे में बताना ज़रूरी है. रूट paragraphStyle अपने-आप जुड़ जाता है और इसकी वैल्यू सबमिट करने की ज़रूरत नहीं होती. हर फ़ील्ड को लिस्ट करने के लिए, एक "*" का इस्तेमाल शॉर्ट-हैंड के तौर पर किया जा सकता है.

उदाहरण के लिए, पैराग्राफ़ स्टाइल की अलाइनमेंट प्रॉपर्टी को अपडेट करने के लिए, इसे fields से "alignment" पर सेट करें.

किसी प्रॉपर्टी को उसकी डिफ़ॉल्ट वैल्यू पर रीसेट करने के लिए, फ़ील्ड मास्क में उसका फ़ील्ड नाम शामिल करें. हालांकि, फ़ील्ड को अनसेट छोड़ दें.

यूनियन फ़ील्ड insertion_location. इस्तेमाल की गई रेंज का टाइप, जहां पैराग्राफ़ स्टाइल अपडेट की जाएगी. insertion_location इनमें से सिर्फ़ एक हो सकता है:
range

object (Range)

स्टाइल करने के लिए, पैराग्राफ़ से ओवरलैप होने वाली रेंज.

DeleteContentRangeRequest

यह कुकी, दस्तावेज़ से कॉन्टेंट मिटाती है.

JSON के काेड में दिखाना 
{
  "range": {
    object (Range)
  }
}
फ़ील्ड
range

object (Range)

मिटाने के लिए कॉन्टेंट की रेंज.

पैराग्राफ़ की सीमा से बाहर मौजूद टेक्स्ट को मिटाने पर, पैराग्राफ़ के स्टाइल, सूचियों, पोज़िशन किए गए ऑब्जेक्ट, और बुकमार्क में बदलाव हो सकते हैं. ऐसा इसलिए होता है, क्योंकि दोनों पैराग्राफ़ मर्ज हो जाते हैं.

कुछ रेंज मिटाने की कोशिश करने पर, दस्तावेज़ का स्ट्रक्चर अमान्य हो सकता है. ऐसे में, गड़बड़ी का मैसेज 400 bad request दिखता है.

मिटाने के अमान्य अनुरोधों के कुछ उदाहरण:

  • सरोगेट पेयर की एक कोड यूनिट मिटाना.
  • Body, Header, Footer, Footnote, TableCell या TableOfContents के आखिरी न्यूलाइन वर्ण को मिटाना.
  • पूरे एलिमेंट को मिटाए बिना, Table, TableOfContents या Equation के शुरू या खत्म होने का समय मिटाना.
  • element को मिटाए बिना, Table, TableOfContents या SectionBreak से पहले मौजूद नई लाइन के वर्ण को मिटाना.
  • टेबल की अलग-अलग पंक्तियों या सेल को मिटाना. टेबल सेल में मौजूद कॉन्टेंट को मिटाने की अनुमति है.

InsertInlineImageRequest

इस फ़ंक्शन की मदद से, दी गई जगह पर मौजूद इमेज को शामिल किया जाता है.InlineObject

JSON के काेड में दिखाना 
{
  "uri": string,
  "objectSize": {
    object (Size)
  },

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
फ़ील्ड
uri

string

इमेज का यूआरआई.

इमेज को दस्तावेज़ में शामिल करते समय, उसे एक बार फ़ेच किया जाता है. साथ ही, दस्तावेज़ में दिखाने के लिए उसकी एक कॉपी सेव की जाती है. इमेज का साइज़ 50 एमबी से कम होना चाहिए. साथ ही, यह 25 मेगापिक्सल से ज़्यादा नहीं होनी चाहिए. इमेज, PNG, JPEG या GIF फ़ॉर्मैट में होनी चाहिए.

दिया गया यूआरआई, सार्वजनिक तौर पर ऐक्सेस किया जा सकने वाला होना चाहिए. साथ ही, इसकी लंबाई ज़्यादा से ज़्यादा 2 केबी होनी चाहिए. यूआरआई को इमेज के साथ सेव किया जाता है. साथ ही, इसे ImageProperties.content_uri फ़ील्ड के ज़रिए दिखाया जाता है.

objectSize

object (Size)

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

यूनियन फ़ील्ड insertion_location. वह जगह जहां इमेज डाली जाएगी. insertion_location इनमें से सिर्फ़ एक हो सकता है:
location

object (Location)

यह फ़ंक्शन, दस्तावेज़ में किसी खास इंडेक्स पर इमेज डालता है.

इमेज को किसी मौजूदा Paragraph की सीमाओं के अंदर ही डाला जाना चाहिए. उदाहरण के लिए, इसे टेबल के शुरुआती इंडेक्स पर नहीं डाला जा सकता. इसका मतलब है कि इसे टेबल और उसके पहले वाले पैराग्राफ़ के बीच नहीं डाला जा सकता.

फ़ुटनोट या समीकरण में इनलाइन इमेज नहीं डाली जा सकतीं.

endOfSegmentLocation

object (EndOfSegmentLocation)

यह हेडर, फ़ुटर या दस्तावेज़ के मुख्य भाग के आखिर में टेक्स्ट डालता है.

फ़ुटनोट में इनलाइन इमेज नहीं डाली जा सकतीं.

InsertTableRequest

इस फ़ंक्शन की मदद से, बताई गई जगह पर टेबल डाली जाती है.

टेबल डालने से पहले, नई लाइन का वर्ण डाला जाएगा.

JSON के काेड में दिखाना 
{
  "rows": integer,
  "columns": integer,

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
फ़ील्ड
rows

integer

टेबल में मौजूद पंक्तियों की संख्या.

columns

integer

टेबल में मौजूद कॉलम की संख्या.

यूनियन फ़ील्ड insertion_location. वह जगह जहां टेबल डाली जाएगी. insertion_location इनमें से सिर्फ़ एक हो सकता है:
location

object (Location)

इस फ़ंक्शन की मदद से, टेबल को मॉडल इंडेक्स की किसी खास जगह पर डाला जाता है.

जोड़ी गई टेबल से पहले एक नई लाइन का वर्ण डाला जाएगा. इसलिए, टेबल का शुरुआती इंडेक्स, तय किए गए इंडेक्स + 1 पर होगा.

टेबल को किसी मौजूदा Paragraph की सीमाओं के अंदर ही डाला जाना चाहिए. उदाहरण के लिए, इसे टेबल के शुरुआती इंडेक्स पर नहीं डाला जा सकता. इसका मतलब है कि इसे किसी मौजूदा टेबल और उसके पहले वाले पैराग्राफ़ के बीच नहीं डाला जा सकता.

फ़ुटनोट या समीकरण में टेबल शामिल नहीं की जा सकतीं.

endOfSegmentLocation

object (EndOfSegmentLocation)

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

फ़ुटनोट में टेबल नहीं डाली जा सकतीं.

InsertTableRowRequest

इस फ़ंक्शन की मदद से, टेबल में एक खाली लाइन जोड़ी जा सकती है.

JSON के काेड में दिखाना 
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertBelow": boolean
}
फ़ील्ड
tableCellLocation

object (TableCellLocation)

रेफ़रंस टेबल सेल की वह जगह जहां से पंक्तियां डाली जाएंगी.

नई लाइन, उस लाइन के ऊपर (या नीचे) जोड़ी जाएगी जिसमें रेफ़रंस सेल मौजूद है. अगर रेफ़रंस सेल, मर्ज की गई सेल है, तो नई लाइन, मर्ज की गई सेल के ऊपर (या नीचे) जोड़ी जाएगी.

insertBelow

boolean

रेफ़रंस सेल की जगह के नीचे नई लाइन जोड़नी है या नहीं.

  • True : सेल के नीचे जोड़ें.
  • False : सेल के ऊपर डालें.

TableCellLocation

टेबल में किसी सेल की जगह की जानकारी.

JSON के काेड में दिखाना 
{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndex": integer,
  "columnIndex": integer
}
फ़ील्ड
tableStartLocation

object (Location)

वह जगह जहां दस्तावेज़ में टेबल शुरू होती है.

rowIndex

integer

यह 0 से शुरू होने वाला लाइन इंडेक्स है. उदाहरण के लिए, टेबल की दूसरी लाइन का लाइन इंडेक्स 1 है.

columnIndex

integer

यह 0 से शुरू होने वाला कॉलम इंडेक्स है. उदाहरण के लिए, टेबल में मौजूद दूसरे कॉलम का कॉलम इंडेक्स 1 है.

InsertTableColumnRequest

इस फ़ंक्शन की मदद से, टेबल में एक खाली कॉलम जोड़ा जा सकता है.

JSON के काेड में दिखाना 
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertRight": boolean
}
फ़ील्ड
tableCellLocation

object (TableCellLocation)

रेफ़रंस टेबल सेल की वह जगह जहां से कॉलम डाले जाएंगे.

रेफ़रंस सेल वाले कॉलम की बाईं (या दाईं) ओर एक नया कॉलम जोड़ा जाएगा. अगर रेफ़रंस सेल, मर्ज की गई सेल है, तो मर्ज की गई सेल की बाईं (या दाईं) ओर एक नया कॉलम जोड़ा जाएगा.

insertRight

boolean

रेफ़रंस सेल की दाईं ओर नया कॉलम जोड़ना है या नहीं.

  • True : दाईं ओर डालें.
  • False : बाईं ओर डालें.

DeleteTableRowRequest

यह फ़ंक्शन, टेबल से किसी पंक्ति को मिटाता है.

JSON के काेड में दिखाना 
{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}
फ़ील्ड
tableCellLocation

object (TableCellLocation)

रेफ़रंस टेबल सेल की वह जगह जहां से लाइन मिटाई जाएगी.

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

DeleteTableColumnRequest

यह फ़ंक्शन, टेबल से किसी कॉलम को मिटाता है.

JSON के काेड में दिखाना 
{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}
फ़ील्ड
tableCellLocation

object (TableCellLocation)

रेफ़रंस टेबल सेल की वह जगह जहां से कॉलम मिटाया जाएगा.

जिस कॉलम में यह सेल मौजूद है उसे मिटा दिया जाएगा. अगर यह एक मर्ज की गई सेल है, जो कई कॉलम में फैली हुई है, तो सेल में शामिल सभी कॉलम मिटा दिए जाएंगे. अगर इस कॉलम को मिटाने के बाद टेबल में कोई कॉलम नहीं बचता है, तो पूरी टेबल मिटा दी जाती है.

InsertPageBreakRequest

यह फ़ंक्शन, तय की गई जगह पर पेज ब्रेक और उसके बाद नई लाइन डालता है.

JSON के काेड में दिखाना 
{

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
फ़ील्ड
यूनियन फ़ील्ड insertion_location. वह जगह जहां पेज ब्रेक डाला जाएगा. insertion_location इनमें से सिर्फ़ एक हो सकता है:
location

object (Location)

यह फ़ंक्शन, दस्तावेज़ में किसी खास इंडेक्स पर पेज ब्रेक डालता है.

पेज ब्रेक को मौजूदा Paragraph की सीमाओं के अंदर डाला जाना चाहिए. उदाहरण के लिए, इसे टेबल के शुरुआती इंडेक्स पर नहीं डाला जा सकता. इसका मतलब है कि इसे टेबल और उसके पहले वाले पैराग्राफ़ के बीच नहीं डाला जा सकता.

पेज ब्रेक को टेबल, समीकरण, फ़ुटनोट, हेडर या फ़ुटर में नहीं डाला जा सकता. पेज ब्रेक सिर्फ़ मुख्य हिस्से में डाले जा सकते हैं. इसलिए, segment ID फ़ील्ड खाली होना चाहिए.

endOfSegmentLocation

object (EndOfSegmentLocation)

यह कुकी, दस्तावेज़ के मुख्य हिस्से के आखिर में पेज ब्रेक डालती है.

फ़ुटनोट, हेडर या फ़ुटर में पेज ब्रेक नहीं डाले जा सकते. पेज ब्रेक सिर्फ़ मुख्य हिस्से में डाले जा सकते हैं. इसलिए, segment ID फ़ील्ड खाली होना चाहिए.

DeletePositionedObjectRequest

यह दस्तावेज़ से PositionedObject को मिटाता है.

JSON के काेड में दिखाना 
{
  "objectId": string,
  "tabId": string
}
फ़ील्ड
objectId

string

उस ऑब्जेक्ट का आईडी जिसे मिटाना है.

tabId

string

वह टैब जिसमें मौजूद ऑब्जेक्ट को मिटाना है. इस विकल्प को शामिल न करने पर, अनुरोध पहले टैब पर लागू होता है.

एक टैब वाले दस्तावेज़ में:

  • अगर यह वैल्यू दी गई है, तो यह सिंगुलर टैब के आईडी से मेल खानी चाहिए.

  • अगर इसे शामिल नहीं किया जाता है, तो अनुरोध सिर्फ़ एक टैब पर लागू होता है.

एक से ज़्यादा टैब वाले दस्तावेज़ में:

  • अगर यह विकल्प चुना जाता है, तो अनुरोध बताए गए टैब पर लागू होता है.

  • अगर इसे शामिल नहीं किया जाता है, तो अनुरोध दस्तावेज़ के पहले टैब पर लागू होता है.

UpdateTableColumnPropertiesRequest

यह फ़ंक्शन, किसी टेबल में मौजूद कॉलम के TableColumnProperties को अपडेट करता है.

JSON के काेड में दिखाना 
{
  "tableStartLocation": {
    object (Location)
  },
  "columnIndices": [
    integer
  ],
  "tableColumnProperties": {
    object (TableColumnProperties)
  },
  "fields": string
}
फ़ील्ड
tableStartLocation

object (Location)

वह जगह जहां दस्तावेज़ में टेबल शुरू होती है.

columnIndices[]

integer

ऐसे ज़ीरो-आधारित कॉलम इंडेक्स की सूची जिनकी प्रॉपर्टी अपडेट की जानी चाहिए. अगर कोई इंडेक्स नहीं दिया गया है, तो सभी कॉलम अपडेट किए जाएंगे.

tableColumnProperties

object (TableColumnProperties)

टेबल कॉलम की वे प्रॉपर्टी जिन्हें अपडेट करना है.

अगर tableColumnProperties#width की वैल्यू 5 पॉइंट (5/72 इंच) से कम है, तो 400 गड़बड़ी वाला अनुरोध दिखाया जाता है.

fields

string (FieldMask format)

वे फ़ील्ड जिन्हें अपडेट किया जाना चाहिए.

कम से कम एक फ़ील्ड के बारे में बताना ज़रूरी है. रूट tableColumnProperties अपने-आप जुड़ जाता है और इसकी वैल्यू सबमिट करने की ज़रूरत नहीं होती. हर फ़ील्ड को लिस्ट करने के लिए, एक "*" का इस्तेमाल शॉर्ट-हैंड के तौर पर किया जा सकता है.

उदाहरण के लिए, कॉलम की चौड़ाई को अपडेट करने के लिए, fields को "width" पर सेट करें.

UpdateTableCellStyleRequest

इससे टेबल सेल की किसी रेंज की स्टाइल अपडेट की जाती है.

JSON के काेड में दिखाना 
{
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "fields": string,

  "tableRange": {
    object (TableRange)
  },
  "tableStartLocation": {
    object (Location)
  }
}
फ़ील्ड
tableCellStyle

object (TableCellStyle)

टेबल सेल पर सेट की जाने वाली स्टाइल.

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

एक ही अनुरोध में, आस-पास की सेल के साथ शेयर की गई बॉर्डर को अपडेट करने से, बॉर्डर अपडेट में समस्याएं आ सकती हैं. इसलिए, बॉर्डर अपडेट इस क्रम में लागू किए जाते हैं:

  • borderRight
  • borderLeft
  • borderBottom
  • borderTop
fields

string (FieldMask format)

वे फ़ील्ड जिन्हें अपडेट किया जाना चाहिए.

कम से कम एक फ़ील्ड के बारे में बताना ज़रूरी है. रूट tableCellStyle अपने-आप जुड़ जाता है और इसकी वैल्यू सबमिट करने की ज़रूरत नहीं होती. हर फ़ील्ड को लिस्ट करने के लिए, एक "*" का इस्तेमाल शॉर्ट-हैंड के तौर पर किया जा सकता है.

उदाहरण के लिए, टेबल सेल के बैकग्राउंड का रंग अपडेट करने के लिए, fields को "backgroundColor" पर सेट करें.

किसी प्रॉपर्टी को उसकी डिफ़ॉल्ट वैल्यू पर रीसेट करने के लिए, फ़ील्ड मास्क में उसका फ़ील्ड नाम शामिल करें. हालांकि, फ़ील्ड को अनसेट छोड़ दें.

यूनियन फ़ील्ड cells. वे सेल जिन्हें अपडेट किया जाएगा. cells इनमें से सिर्फ़ एक हो सकता है:
tableRange

object (TableRange)

टेबल की वह रेंज जिसमें टेबल के उस सबसेट को दिखाया जाता है जिस पर अपडेट लागू किए जाते हैं.

tableStartLocation

object (Location)

वह जगह जहां दस्तावेज़ में टेबल शुरू होती है. अपडेट की जानकारी देने पर, उन्हें टेबल की सभी सेल पर लागू किया जाता है.

TableRange

टेबल की रेंज, टेबल के सबसेट का रेफ़रंस दिखाती है.

ध्यान दें कि टेबल की रेंज में शामिल की गई सेल, ज़रूरी नहीं कि आयताकार हों. उदाहरण के लिए, मान लें कि हमारे पास 3 x 3 टेबल है, जिसमें आखिरी लाइन की सभी सेल मर्ज की गई हैं. टेबल कुछ इस तरह दिखती है: 

 [   ][   ][   ]
 [   ][   ][   ]
 [             ]

टेबल की सेल की जगह = (tableStartLocation, row = 0, column = 0), लाइन स्पैन = 3, और कॉलम स्पैन = 2 वाली टेबल रेंज में ये सेल शामिल होती हैं: 

 [ x ][ x ][   ]
 [ x ][ x ][   ]
 [ x    x    x ]
JSON के काेड में दिखाना 
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "rowSpan": integer,
  "columnSpan": integer
}
फ़ील्ड
tableCellLocation

object (TableCellLocation)

सेल की वह जगह जहां से टेबल रेंज शुरू होती है.

rowSpan

integer

टेबल की रेंज में मौजूद लाइनों की संख्या.

columnSpan

integer

टेबल की रेंज का कॉलम स्पैन.

UpdateTableRowStyleRequest

यह टेबल में मौजूद पंक्तियों के TableRowStyle को अपडेट करता है.

JSON के काेड में दिखाना 
{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndices": [
    integer
  ],
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "fields": string
}
फ़ील्ड
tableStartLocation

object (Location)

वह जगह जहां दस्तावेज़ में टेबल शुरू होती है.

rowIndices[]

integer

शून्य पर आधारित पंक्ति इंडेक्स की सूची, जिनकी स्टाइल अपडेट की जानी चाहिए. अगर कोई इंडेक्स नहीं दिया गया है, तो सभी लाइनें अपडेट हो जाएंगी.

tableRowStyle

object (TableRowStyle)

पंक्तियों पर सेट की जाने वाली स्टाइल.

fields

string (FieldMask format)

वे फ़ील्ड जिन्हें अपडेट किया जाना चाहिए.

कम से कम एक फ़ील्ड के बारे में बताना ज़रूरी है. रूट tableRowStyle अपने-आप जुड़ जाता है और इसकी वैल्यू सबमिट करने की ज़रूरत नहीं होती. हर फ़ील्ड को लिस्ट करने के लिए, एक "*" का इस्तेमाल शॉर्ट-हैंड के तौर पर किया जा सकता है.

उदाहरण के लिए, लाइन की कम से कम ऊंचाई को अपडेट करने के लिए, fields को "minRowHeight" पर सेट करें.

ReplaceImageRequest

किसी मौजूदा इमेज को नई इमेज से बदलता है.

इमेज बदलने पर, Docs एडिटर के जैसा अनुभव देने के लिए, मौजूदा इमेज से कुछ image effects हटा दिए जाते हैं.

JSON के काेड में दिखाना 
{
  "imageObjectId": string,
  "uri": string,
  "imageReplaceMethod": enum (ImageReplaceMethod),
  "tabId": string
}
फ़ील्ड
imageObjectId

string

उस मौजूदा इमेज का आईडी जिसे बदला जाएगा. आईडी को, get अनुरोध के जवाब से वापस पाया जा सकता है.

uri

string

नई इमेज का यूआरआई.

इमेज को दस्तावेज़ में शामिल करते समय, उसे एक बार फ़ेच किया जाता है. साथ ही, दस्तावेज़ में दिखाने के लिए उसकी एक कॉपी सेव की जाती है. इमेज का साइज़ 50 एमबी से कम होना चाहिए. साथ ही, यह 25 मेगापिक्सल से ज़्यादा नहीं होनी चाहिए. इमेज का फ़ॉर्मैट PNG, JPEG या GIF होना चाहिए.

दिए गए यूआरआई की लंबाई 2 केबी से ज़्यादा नहीं होनी चाहिए. यूआरआई को इमेज के साथ सेव किया जाता है. साथ ही, इसे ImageProperties.source_uri फ़ील्ड के ज़रिए दिखाया जाता है.

imageReplaceMethod

enum (ImageReplaceMethod)

बदलाव करने का तरीका.

tabId

string

वह टैब जिसमें मौजूद इमेज को बदलना है. इस विकल्प को शामिल न करने पर, अनुरोध पहले टैब पर लागू होता है.

एक टैब वाले दस्तावेज़ में:

  • अगर यह वैल्यू दी गई है, तो यह सिंगुलर टैब के आईडी से मेल खानी चाहिए.

  • अगर इसे शामिल नहीं किया जाता है, तो अनुरोध सिर्फ़ एक टैब पर लागू होता है.

एक से ज़्यादा टैब वाले दस्तावेज़ में:

  • अगर यह विकल्प चुना जाता है, तो अनुरोध बताए गए टैब पर लागू होता है.

  • अगर इसे शामिल नहीं किया जाता है, तो अनुरोध दस्तावेज़ के पहले टैब पर लागू होता है.

ImageReplaceMethod

इमेज बदलने का तरीका.

Enums
IMAGE_REPLACE_METHOD_UNSPECIFIED इमेज बदलने का तरीका नहीं बताया गया है. इस वैल्यू का इस्तेमाल नहीं किया जाना चाहिए.
CENTER_CROP यह इमेज को स्केल करता है और उसे ओरिजनल इमेज की सीमाओं के हिसाब से सेंटर में रखता है. ओरिजनल इमेज के डाइमेंशन के हिसाब से इमेज को काटा जा सकता है. इमेज का रेंडर किया गया साइज़, ओरिजनल इमेज के साइज़ के बराबर होगा.

UpdateDocumentStyleRequest

DocumentStyle को अपडेट करता है.

JSON के काेड में दिखाना 
{
  "documentStyle": {
    object (DocumentStyle)
  },
  "fields": string,
  "tabId": string
}
फ़ील्ड
documentStyle

object (DocumentStyle)

दस्तावेज़ पर सेट की जाने वाली स्टाइल.

दस्तावेज़ की स्टाइल में कुछ बदलाव करने से, Docs के एडिटर के व्यवहार को दिखाने के लिए अन्य बदलाव हो सकते हैं. ज़्यादा जानकारी के लिए, DocumentStyle का दस्तावेज़ देखें.

fields

string (FieldMask format)

वे फ़ील्ड जिन्हें अपडेट किया जाना चाहिए.

कम से कम एक फ़ील्ड के बारे में बताना ज़रूरी है. रूट documentStyle अपने-आप जुड़ जाता है और इसकी वैल्यू सबमिट करने की ज़रूरत नहीं होती. हर फ़ील्ड को लिस्ट करने के लिए, एक "*" का इस्तेमाल शॉर्ट-हैंड के तौर पर किया जा सकता है.

उदाहरण के लिए, बैकग्राउंड को अपडेट करने के लिए, fields को "background" पर सेट करें.

tabId

string

वह टैब जिसमें अपडेट की जाने वाली स्टाइल मौजूद है. अगर इस पैरामीटर को शामिल नहीं किया जाता है, तो अनुरोध पहले टैब पर लागू होता है.

एक टैब वाले दस्तावेज़ में:

  • अगर यह वैल्यू दी गई है, तो यह सिंगुलर टैब के आईडी से मेल खानी चाहिए.

  • अगर इसे शामिल नहीं किया जाता है, तो अनुरोध सिर्फ़ एक टैब पर लागू होता है.

एक से ज़्यादा टैब वाले दस्तावेज़ में:

  • अगर यह विकल्प चुना जाता है, तो अनुरोध बताए गए टैब पर लागू होता है.

  • यह जानकारी न देने पर, अनुरोध दस्तावेज़ के पहले टैब पर लागू होता है.

MergeTableCellsRequest

यह Table में मौजूद सेल को मर्ज करता है.

JSON के काेड में दिखाना 
{
  "tableRange": {
    object (TableRange)
  }
}
फ़ील्ड
tableRange

object (TableRange)

टेबल की वह रेंज जिसमें यह बताया गया हो कि टेबल की किन सेल को मर्ज करना है.

मर्ज की जा रही सेल में मौजूद टेक्स्ट को एक साथ जोड़ दिया जाएगा. साथ ही, इसे रेंज की "हेड" सेल में सेव कर दिया जाएगा. अगर कॉन्टेंट की दिशा बाएं से दाएं है, तो यह रेंज की सबसे ऊपर बाईं ओर वाली सेल होती है. अगर कॉन्टेंट की दिशा बाएं से दाएं नहीं है, तो यह रेंज की सबसे ऊपर दाईं ओर वाली सेल होती है.

अगर रेंज आयताकार नहीं है, तो गड़बड़ी का मैसेज दिखता है. ऐसा तब हो सकता है, जब रेंज में पहले से मर्ज की गई सेल शामिल हों या टेबल आयताकार न हो.

UnmergeTableCellsRequest

इस फ़ंक्शन का इस्तेमाल, Table में मौजूद सेल को अनमर्ज करने के लिए किया जाता है.

JSON के काेड में दिखाना 
{
  "tableRange": {
    object (TableRange)
  }
}
फ़ील्ड
tableRange

object (TableRange)

टेबल की वह रेंज जिसमें यह तय किया जाता है कि टेबल की किन सेल को अनमर्ज करना है.

इस रेंज में मौजूद सभी मर्ज की गई सेल अलग हो जाएंगी. साथ ही, जो सेल पहले से अलग हैं उन पर कोई असर नहीं पड़ेगा. अगर रेंज में कोई भी सेल मर्ज नहीं की गई है, तो अनुरोध का कोई असर नहीं होगा.

अगर मर्ज किए गए किसी सेल में टेक्स्ट है, तो वह टेक्स्ट, मर्ज किए गए सेल के "हेड" सेल में रहेगा. अगर कॉन्टेंट बाएं से दाएं लिखा गया है, तो "हेड" सेल, सबसे ऊपर बाईं ओर मौजूद सेल होता है. वहीं, अगर कॉन्टेंट दाएं से बाएं लिखा गया है, तो "हेड" सेल, सबसे ऊपर दाईं ओर मौजूद सेल होता है.

CreateHeaderRequest

Header बनाता है. नया हेडर, SectionStyle पर लागू होता है. अगर SectionBreak की जानकारी दी गई है, तो यह SectionBreak की जगह पर लागू होता है. अगर SectionBreak की जानकारी नहीं दी गई है, तो यह DocumentStyle पर लागू होता है.

अगर तय किए गए टाइप का हेडर पहले से मौजूद है, तो गड़बड़ी का मैसेज 400 bad request दिखता है.

JSON के काेड में दिखाना 
{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}
फ़ील्ड
type

enum (HeaderFooterType)

बनाए जाने वाले हेडर का टाइप.

sectionBreakLocation

object (Location)

SectionBreak की जगह, जहां से वह सेक्शन शुरू होता है जिससे यह हेडर जुड़ा होना चाहिए. अगर `sectionBreakLocation' सेट नहीं है या यह दस्तावेज़ के मुख्य हिस्से में मौजूद पहले सेक्शन ब्रेक को रेफ़र करता है, तो हेडर DocumentStyle पर लागू होता है

HeaderFooterType

इस तरह के हेडर और फ़ुटर बनाए जा सकते हैं.

Enums
DEFAULT डिफ़ॉल्ट हेडर/फ़ुटर.

CreateFooterRequest

Footer बनाता है. नया फ़ुटर, SectionStyle पर लागू होता है. अगर SectionBreak की जानकारी दी गई है, तो यह SectionBreak की जगह पर लागू होता है. अगर इसकी जानकारी नहीं दी गई है, तो यह DocumentStyle पर लागू होता है.

अगर तय किए गए टाइप का फ़ुटर पहले से मौजूद है, तो गड़बड़ी का मैसेज '400 Bad Request' दिखता है.

JSON के काेड में दिखाना 
{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}
फ़ील्ड
type

enum (HeaderFooterType)

बनाए जाने वाले फ़ुटर का टाइप.

sectionBreakLocation

object (Location)

उस सेक्शन से ठीक पहले मौजूद SectionBreak की जगह की जानकारी जिसके SectionStyle में यह फ़ुटर शामिल होना चाहिए. अगर इसे सेट नहीं किया गया है या यह दस्तावेज़ में पहले सेक्शन ब्रेक को दिखाता है, तो फ़ुटर, दस्तावेज़ की स्टाइल पर लागू होता है.

CreateFootnoteRequest

यह एक Footnote सेगमेंट बनाता है और दी गई जगह पर एक नया FootnoteReference डालता है.

नए Footnote सेगमेंट में, स्पेस के बाद नई लाइन का वर्ण होगा.

JSON के काेड में दिखाना 
{

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
फ़ील्ड
यूनियन फ़ील्ड footnote_reference_location. फ़ुटनोट रेफ़रंस डालने की जगह. footnote_reference_location इनमें से सिर्फ़ एक हो सकता है:
location

object (Location)

यह फ़ंक्शन, दस्तावेज़ में किसी खास इंडेक्स पर फ़ुटनोट रेफ़रंस डालता है.

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

फ़ुटनोट के रेफ़रंस को किसी समीकरण, हेडर, फ़ुटर या फ़ुटनोट में नहीं डाला जा सकता. फ़ुटनोट के रेफ़रंस सिर्फ़ मुख्य हिस्से में डाले जा सकते हैं. इसलिए, segment ID फ़ील्ड खाली होना चाहिए.

endOfSegmentLocation

object (EndOfSegmentLocation)

यह विकल्प, दस्तावेज़ के मुख्य हिस्से के आखिर में फ़ुटनोट रेफ़रंस डालता है.

फ़ुटनोट के रेफ़रंस को हेडर, फ़ुटर या फ़ुटनोट में नहीं डाला जा सकता. फ़ुटनोट के रेफ़रंस सिर्फ़ मुख्य हिस्से में डाले जा सकते हैं. इसलिए, segment ID फ़ील्ड खाली होना चाहिए.

ReplaceNamedRangeContentRequest

इस फ़ंक्शन की मदद से, बताए गए NamedRange या NamedRanges के कॉन्टेंट को बदले गए कॉन्टेंट से बदला जा सकता है.

ध्यान दें कि किसी व्यक्ति NamedRange में एक से ज़्यादा अलग-अलग ranges हो सकते हैं. इस मामले में, सिर्फ़ पहली रेंज में मौजूद कॉन्टेंट को बदला जाएगा. अन्य रेंज और उनमें मौजूद कॉन्टेंट मिटा दिया जाएगा.

अगर किसी रेंज को बदलने या मिटाने से दस्तावेज़ का स्ट्रक्चर अमान्य हो जाता है, तो गड़बड़ी का मैसेज 400 Bad Request दिखता है.

JSON के काेड में दिखाना 
{
  "tabsCriteria": {
    object (TabsCriteria)
  },

  "text": string

  "namedRangeId": string,
  "namedRangeName": string
}
फ़ील्ड
tabsCriteria

object (TabsCriteria)

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

एक टैब वाले दस्तावेज़ में:

  • अगर यह वैल्यू दी गई है, तो यह सिंगुलर टैब के आईडी से मेल खानी चाहिए.

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

एक से ज़्यादा टैब वाले दस्तावेज़ में:

  • अगर बदलाव दिया गया है, तो यह बदलाव चुने गए टैब पर लागू होगा.

  • अगर इसे शामिल नहीं किया जाता है, तो बदलाव सभी टैब पर लागू होगा.

यूनियन फ़ील्ड replacement_content. यह वह कॉन्टेंट है जिससे नाम वाली रेंज के मौजूदा कॉन्टेंट को बदला जाएगा. replacement_content इनमें से सिर्फ़ एक हो सकता है:
text

string

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

यूनियन फ़ील्ड named_range_reference. उस नेम रेंज का रेफ़रंस जिसका कॉन्टेंट बदला जाएगा. named_range_reference इनमें से सिर्फ़ एक हो सकता है:
namedRangeId

string

उस नेम रेंज का आईडी जिसका कॉन्टेंट बदला जाएगा.

अगर दिए गए आईडी के साथ कोई नाम वाली रेंज नहीं है, तो 'अनुरोध पूरा नहीं किया जा सका' गड़बड़ी का 400 कोड दिखता है.

namedRangeName

string

उस NamedRanges का नाम जिसका कॉन्टेंट बदला जाएगा.

अगर दिए गए नाम के कई named ranges हैं, तो हर एक का कॉन्टेंट बदल दिया जाएगा. अगर दिए गए नाम की कोई नाम वाली रेंज नहीं है, तो अनुरोध पूरा नहीं किया जा सकेगा.

UpdateSectionStyleRequest

SectionStyle को अपडेट करता है.

JSON के काेड में दिखाना 
{
  "range": {
    object (Range)
  },
  "sectionStyle": {
    object (SectionStyle)
  },
  "fields": string
}
फ़ील्ड
range

object (Range)

स्टाइल करने के लिए, सेक्शन को ओवरलैप करने वाली रेंज.

सेक्शन ब्रेक सिर्फ़ मुख्य हिस्से में डाले जा सकते हैं. इसलिए, segment ID फ़ील्ड खाली होना चाहिए.

sectionStyle

object (SectionStyle)

सेक्शन पर सेट की जाने वाली स्टाइल.

सेक्शन की स्टाइल में कुछ बदलाव करने से, Docs Editor के व्यवहार को दिखाने के लिए अन्य बदलाव हो सकते हैं. ज़्यादा जानकारी के लिए, SectionStyle का दस्तावेज़ देखें.

fields

string (FieldMask format)

वे फ़ील्ड जिन्हें अपडेट किया जाना चाहिए.

कम से कम एक फ़ील्ड के बारे में बताना ज़रूरी है. रूट sectionStyle अपने-आप जुड़ जाता है और इसकी वैल्यू सबमिट करने की ज़रूरत नहीं होती. हर फ़ील्ड को लिस्ट करने के लिए, एक "*" का इस्तेमाल शॉर्ट-हैंड के तौर पर किया जा सकता है.

उदाहरण के लिए, बाएं मार्जिन को अपडेट करने के लिए, fields को "marginLeft" पर सेट करें.

InsertSectionBreakRequest

यह बताई गई जगह पर सेक्शन ब्रेक डालता है.

सेक्शन ब्रेक से पहले, नई लाइन वाला वर्ण डाला जाएगा.

JSON के काेड में दिखाना 
{
  "sectionType": enum (SectionType),

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
फ़ील्ड
sectionType

enum (SectionType)

यह सेक्शन का टाइप है जिसे डाला जाना है.

यूनियन फ़ील्ड insertion_location. वह जगह जहां ब्रेक डाला जाएगा. insertion_location इनमें से सिर्फ़ एक हो सकता है:
location

object (Location)

यह दस्तावेज़ में किसी खास इंडेक्स पर नई लाइन और सेक्शन ब्रेक डालता है.

सेक्शन ब्रेक को मौजूदा Paragraph की सीमाओं के अंदर डाला जाना चाहिए. उदाहरण के लिए, इसे टेबल के शुरुआती इंडेक्स पर नहीं डाला जा सकता. इसका मतलब है कि इसे टेबल और उसके पहले वाले पैराग्राफ़ के बीच नहीं डाला जा सकता.

सेक्शन ब्रेक को टेबल, समीकरण, फ़ुटनोट, हेडर या फ़ुटर में नहीं डाला जा सकता. सेक्शन ब्रेक सिर्फ़ मुख्य हिस्से में डाले जा सकते हैं. इसलिए, segment ID फ़ील्ड खाली होना चाहिए.

endOfSegmentLocation

object (EndOfSegmentLocation)

यह दस्तावेज़ के मुख्य हिस्से के आखिर में, नई लाइन और सेक्शन ब्रेक जोड़ता है.

सेक्शन ब्रेक को फ़ुटनोट, हेडर या फ़ुटर में नहीं डाला जा सकता. सेक्शन ब्रेक सिर्फ़ मुख्य हिस्से में डाले जा सकते हैं. इसलिए, segment ID फ़ील्ड खाली होना चाहिए.

DeleteHeaderRequest

यह दस्तावेज़ से Header को मिटाता है.

JSON के काेड में दिखाना 
{
  "headerId": string,
  "tabId": string
}
फ़ील्ड
headerId

string

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

tabId

string

वह टैब जिसमें मौजूद हेडर को मिटाना है. इस विकल्प को शामिल न करने पर, अनुरोध पहले टैब पर लागू होता है.

एक टैब वाले दस्तावेज़ में:

  • अगर यह वैल्यू दी गई है, तो यह सिंगुलर टैब के आईडी से मेल खानी चाहिए.

  • अगर इसे शामिल नहीं किया जाता है, तो अनुरोध सिर्फ़ एक टैब पर लागू होता है.

एक से ज़्यादा टैब वाले दस्तावेज़ में:

  • अगर यह विकल्प चुना जाता है, तो अनुरोध बताए गए टैब पर लागू होता है.

  • अगर इसे शामिल नहीं किया जाता है, तो अनुरोध दस्तावेज़ के पहले टैब पर लागू होता है.

DeleteFooterRequest

यह दस्तावेज़ से Footer को मिटाता है.

JSON के काेड में दिखाना 
{
  "footerId": string,
  "tabId": string
}
फ़ील्ड
footerId

string

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

tabId

string

वह टैब जिसमें मौजूद फ़ुटर को मिटाना है. इस विकल्प को शामिल न करने पर, अनुरोध पहले टैब पर लागू होता है.

एक टैब वाले दस्तावेज़ में:

  • अगर यह वैल्यू दी गई है, तो यह सिंगुलर टैब के आईडी से मेल खानी चाहिए.

  • अगर इसे शामिल नहीं किया जाता है, तो अनुरोध सिर्फ़ एक टैब पर लागू होता है.

एक से ज़्यादा टैब वाले दस्तावेज़ में:

  • अगर यह विकल्प चुना जाता है, तो अनुरोध बताए गए टैब पर लागू होता है.

  • अगर इसे शामिल नहीं किया जाता है, तो अनुरोध दस्तावेज़ के पहले टैब पर लागू होता है.

PinTableHeaderRowsRequest

यह विकल्प, टेबल में पिन की गई टेबल हेडर वाली लाइनों की संख्या को अपडेट करता है.

JSON के काेड में दिखाना 
{
  "tableStartLocation": {
    object (Location)
  },
  "pinnedHeaderRowsCount": integer
}
फ़ील्ड
tableStartLocation

object (Location)

वह जगह जहां दस्तावेज़ में टेबल शुरू होती है.

pinnedHeaderRowsCount

integer

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

AddDocumentTabRequest

यह कुकी, दस्तावेज़ टैब जोड़ती है. किसी इंडेक्स में टैब जोड़ने पर, उसके बाद के सभी टैब के इंडेक्स बढ़ जाते हैं.

JSON के काेड में दिखाना 
{
  "tabProperties": {
    object (TabProperties)
  }
}
फ़ील्ड
tabProperties

object (TabProperties)

जोड़ने के लिए टैब की प्रॉपर्टी. सभी प्रॉपर्टी वैकल्पिक हैं.

DeleteTabRequest

यह कुकी, टैब को मिटाती है. अगर टैब में चाइल्ड टैब हैं, तो उन्हें भी मिटा दिया जाता है.

JSON के काेड में दिखाना 
{
  "tabId": string
}
फ़ील्ड
tabId

string

मिटाने के लिए टैब का आईडी.

UpdateDocumentTabPropertiesRequest

किसी दस्तावेज़ टैब की प्रॉपर्टी अपडेट करें.

JSON के काेड में दिखाना 
{
  "tabProperties": {
    object (TabProperties)
  },
  "fields": string
}
फ़ील्ड
tabProperties

object (TabProperties)

अपडेट की जाने वाली टैब प्रॉपर्टी.

fields

string (FieldMask format)

वे फ़ील्ड जिन्हें अपडेट किया जाना चाहिए.

कम से कम एक फ़ील्ड के बारे में बताना ज़रूरी है. रूट tabProperties अपने-आप जुड़ जाता है और इसकी वैल्यू सबमिट करने की ज़रूरत नहीं होती. हर फ़ील्ड को लिस्ट करने के लिए, एक "*" का इस्तेमाल शॉर्ट-हैंड के तौर पर किया जा सकता है.

InsertPersonRequest

इससे किसी व्यक्ति का नाम टैग किया जाता है.

JSON के काेड में दिखाना 
{
  "personProperties": {
    object (PersonProperties)
  },

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
फ़ील्ड
personProperties

object (PersonProperties)

जिस व्यक्ति का नाम टैग करना है उसकी प्रॉपर्टी.

यूनियन फ़ील्ड insertion_location. वह जगह जहां व्यक्ति का नाम डाला जाएगा. insertion_location इनमें से सिर्फ़ एक हो सकता है:
location

object (Location)

यह फ़ंक्शन, दस्तावेज़ में किसी खास इंडेक्स पर व्यक्ति का नाम टैग करता है.

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

किसी समीकरण में, लोगों को टैग नहीं किया जा सकता.

endOfSegmentLocation

object (EndOfSegmentLocation)

यह हेडर, फ़ुटर, फ़ुटनोट या दस्तावेज़ के मुख्य हिस्से के आखिर में, व्यक्ति का नाम टैग करने की सुविधा जोड़ता है.

UpdateNamedStyleRequest

यह फ़ंक्शन, नाम वाली स्टाइल को अपडेट करता है.

JSON के काेड में दिखाना 
{
  "namedStyle": {
    object (NamedStyle)
  },
  "fields": string,
  "tabId": string
}
फ़ील्ड
namedStyle

object (NamedStyle)

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

fields

string (FieldMask format)

NamedStyle फ़ील्ड जिन्हें अपडेट किया जाना चाहिए.

कम से कम namedStyleType की जानकारी देना ज़रूरी है. रूट namedStyle अपने-आप जुड़ जाता है और इसकी वैल्यू सबमिट करने की ज़रूरत नहीं होती. हर फ़ील्ड को लिस्ट करने के लिए, एक "*" का इस्तेमाल शॉर्ट-हैंड के तौर पर किया जा सकता है.

उदाहरण के लिए, टेक्स्ट स्टाइल को बोल्ड में अपडेट करने के लिए, fields को सेट करें, ताकि "textStyle" और "textStyle.bold" शामिल किए जा सकें. पैराग्राफ़ की स्टाइल की अलाइनमेंट प्रॉपर्टी को अपडेट करने के लिए, fields को सेट करें. इसमें "paragraphStyle" और "paragraphStyle.alignment" को शामिल करें.

किसी प्रॉपर्टी को उसकी डिफ़ॉल्ट वैल्यू पर रीसेट करने के लिए, फ़ील्ड मास्क में उसका फ़ील्ड नाम शामिल करें. हालांकि, फ़ील्ड को अनसेट छोड़ दें. TextStyle या ParagraphStyle को खाली छोड़कर "textStyle" या "paragraphStyle" तय करने पर, उसके सभी नेस्ट किए गए फ़ील्ड रीसेट हो जाएंगे.

tabId

string

अपडेट करने के लिए दस्तावेज़ टैब. डिफ़ॉल्ट रूप से, अपडेट पहले टैब पर लागू होता है.

InsertRichLinkRequest

इससे बताई गई जगह पर RichLink डालता है.

JSON के काेड में दिखाना 
{
  "richLinkProperties": {
    object (RichLinkProperties)
  },

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
फ़ील्ड
यूनियन फ़ील्ड insertion_location. वह जगह जहां रिच लिंक डाला जाएगा. insertion_location इनमें से सिर्फ़ एक हो सकता है:
location

object (Location)

दस्तावेज़ में किसी खास इंडेक्स पर रिच लिंक डालता है.

रिच लिंक को मौजूदा Paragraph की सीमाओं के अंदर डाला जाना चाहिए. उदाहरण के लिए, इसे टेबल के शुरुआती इंडेक्स पर नहीं डाला जा सकता. इसका मतलब है कि इसे टेबल और उसके पहले वाले पैराग्राफ़ के बीच नहीं डाला जा सकता.

रिच लिंक को किसी समीकरण में नहीं डाला जा सकता.

endOfSegmentLocation

object (EndOfSegmentLocation)

यह हेडर, फ़ुटर, फ़ुटनोट या दस्तावेज़ के मुख्य हिस्से के आखिर में रिच लिंक डालता है.

InsertDateRequest

यह फ़ंक्शन, दी गई जगह पर तारीख डालता है.

JSON के काेड में दिखाना 
{
  "dateElementProperties": {
    object (DateElementProperties)
  },

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
फ़ील्ड
dateElementProperties

object (DateElementProperties)

तारीख की प्रॉपर्टी, जिसे शामिल करना है.

यूनियन फ़ील्ड insertion_location. वह जगह जहां तारीख डाली जाएगी. insertion_location इनमें से सिर्फ़ एक हो सकता है:
location

object (Location)

यह फ़ंक्शन, दस्तावेज़ में किसी खास इंडेक्स पर तारीख डालता है.

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

endOfSegmentLocation

object (EndOfSegmentLocation)

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

InsertCommentRequest

दस्तावेज़ में CommentThread शामिल करता है.

JSON के काेड में दिखाना 
{
  "content": string,
  "assigneeEmailAddress": string,

  "range": {
    object (Range)
  }
}
फ़ील्ड
content

string

टिप्पणी का टेक्स्ट, सादे टेक्स्ट के तौर पर.

इस टेक्स्ट कॉन्टेंट को, Docs Editor में बनाई गई टिप्पणियों की तरह ही मैनेज किया जाएगा. इसमें फ़ॉर्मैटिंग, सूचनाओं वगैरह के लिए एक जैसे तरीके इस्तेमाल किए जाएंगे.

इस फ़ील्ड को खाली नहीं छोड़ा जा सकता. साथ ही, इसमें 2048 से ज़्यादा UTF-8 कोड यूनिट नहीं होनी चाहिए.

assigneeEmailAddress

string

ज़रूरी नहीं. टिप्पणी असाइन करने वाले व्यक्ति का ईमेल पता.

अगर आपको किसी टिप्पणी को असाइन नहीं करना है, तो इस फ़ील्ड को खाली छोड़ दें.

इसमें 2048 से ज़्यादा UTF-8 कोड यूनिट नहीं होनी चाहिए.

यूनियन फ़ील्ड anchor. दस्तावेज़ में वह जगह जहां यह टिप्पणी की गई है. anchor इनमें से सिर्फ़ एक हो सकता है:
range

object (Range)

दस्तावेज़ में मौजूद Range, इस टिप्पणी से जुड़ा है.

AddCommentReplyRequest

यह CommentThread या SuggestionThread में Post जवाब शामिल करता है.

JSON के काेड में दिखाना 
{
  "post": {
    object (Post)
  },

  "commentId": string,
  "suggestionId": string
}
फ़ील्ड
post

object (Post)

जवाब को दिखाने वाला Post.

यूनियन फ़ील्ड thread_id. जिस थ्रेड में जवाब जोड़ना है उसका आईडी. thread_id इनमें से सिर्फ़ एक हो सकता है:
commentId

string

जिस CommentThread में जवाब जोड़ना है उसका आईडी.

suggestionId

string

जिस SuggestionThread में जवाब जोड़ना है उसका आईडी.

UpdateCommentPostRequest

यह CommentThread या SuggestionThread में मौजूद Post को अपडेट करता है.

इन मामलों में, गड़बड़ी 400: गलत अनुरोध का मैसेज दिखता है:

  • यह पोस्ट, SuggestionThread का headPost है.

  • अनुरोध करने वाला उपयोगकर्ता, पोस्ट का लेखक नहीं है.

  • एक ही BatchUpdateDocumentRequest में, एक ही postId के लिए कई UpdateCommentPostRequests मौजूद हैं.

JSON के काेड में दिखाना 
{
  "postId": string,
  "content": string,

  "commentId": string,
  "suggestionId": string
}
फ़ील्ड
postId

string

अपडेट की जा रही पोस्ट का आईडी.

content

string

टिप्पणी का नया टेक्स्ट, सादे टेक्स्ट के तौर पर.

इस टेक्स्ट कॉन्टेंट को, Docs Editor में बनाई गई टिप्पणियों की तरह ही मैनेज किया जाएगा. इसमें फ़ॉर्मैटिंग, सूचनाओं वगैरह के लिए एक जैसे तरीके इस्तेमाल किए जाएंगे.

इस फ़ील्ड को खाली नहीं छोड़ा जा सकता. साथ ही, इसमें 2048 से ज़्यादा UTF-8 कोड यूनिट नहीं होनी चाहिए.

यूनियन फ़ील्ड thread_id. उस थ्रेड का आईडी जिससे पोस्ट जुड़ी है. thread_id इनमें से सिर्फ़ एक हो सकता है:
commentId

string

उस CommentThread का आईडी जिससे पोस्ट जुड़ी है.

suggestionId

string

उस SuggestionThread का आईडी जिससे पोस्ट जुड़ी है.

DeleteCommentRequest

यह CommentThread को मिटाता है.

अगर अनुरोध करने वाला उपयोगकर्ता, headPost का लेखक नहीं है, तो यह 400 गड़बड़ी का मैसेज दिखाता है.

JSON के काेड में दिखाना 
{
  "commentId": string
}
फ़ील्ड
commentId

string

उस CommentThread का आईडी जिसे मिटाया जा रहा है.

DeleteCommentReplyRequest

यह CommentThread या SuggestionThread से मिले जवाब को मिटाता है.Post

इन मामलों में, गड़बड़ी 400: गलत अनुरोध का मैसेज दिखता है:

  • अनुरोध करने वाला उपयोगकर्ता, पोस्ट का लेखक नहीं है.

  • जवाब वाली पोस्ट में [action][google.apps.docs.v1.Post.action] मौजूद है.

  • जवाब वाली पोस्ट में assignee शामिल है.

JSON के काेड में दिखाना 
{
  "postId": string,

  "commentId": string,
  "suggestionId": string
}
फ़ील्ड
postId

string

जिस जवाब को मिटाया जा रहा है उसका आईडी Post.

यूनियन फ़ील्ड thread_id. उस थ्रेड का आईडी जिससे पोस्ट जुड़ी है. thread_id इनमें से सिर्फ़ एक हो सकता है:
commentId

string

उस CommentThread का आईडी जिससे पोस्ट जुड़ी है.

suggestionId

string

उस SuggestionThread का आईडी जिससे पोस्ट जुड़ी है.

AcceptSuggestionRequest

सुझाव स्वीकार करता है.

अगर अनुरोध करने वाले उपयोगकर्ता के पास दस्तावेज़ में बदलाव करने का ऐक्सेस नहीं है, तो यह फ़ंक्शन 403 गड़बड़ी का मैसेज दिखाता है.

JSON के काेड में दिखाना 
{
  "suggestionId": string
}
फ़ील्ड
suggestionId

string

सुझाव का आईडी.

RejectSuggestionRequest

सुझाव को अस्वीकार करता है.

अगर अनुरोध करने वाले उपयोगकर्ता के पास दस्तावेज़ में बदलाव करने का ऐक्सेस नहीं है और वह सुझाव देने वाला व्यक्ति नहीं है, तो यह फ़ंक्शन 403 गड़बड़ी का मैसेज दिखाता है.

JSON के काेड में दिखाना 
{
  "suggestionId": string
}
फ़ील्ड
suggestionId

string

सुझाव का आईडी.

DeleteSuggestionRequest

यह कुकी, सुझाव को मिटाती है.

अगर अनुरोध करने वाला उपयोगकर्ता, सुझाव देने वाला व्यक्ति नहीं है, तो यह फ़ंक्शन 403 गड़बड़ी का मैसेज दिखाता है.

JSON के काेड में दिखाना 
{
  "suggestionId": string
}
फ़ील्ड
suggestionId

string

सुझाव का आईडी.