Google Docs
GoogleDocs_EditDocument
Read or edit a Google Docs document using structured batchUpdate requests. When called without requests, returns the document content in DocMD format (block IDs, character indices, and text styles). When called with requests, applies the edits and returns the updated DocMD. Use the DocMD indices from the response to construct requests for subsequent calls.
Remote googledocs
Remote (network-hosted)
Other tools also called GoogleDocs_EditDocument?
See providers with this name
Input Schema
{
"type": "object",
"properties": {
"requests": {
"type": "array",
"items": {
"type": "object",
"properties": {
"deleteTab": {
"type": "object",
"required": [
"tabId"
],
"properties": {
"tabId": {
"type": "string"
}
},
"additionalProperties": false
},
"insertDate": {
"type": "object",
"properties": {
"location": {
"type": "object",
"properties": {
"index": {
"type": "integer"
},
"tabId": {
"type": "string"
},
"segmentId": {
"type": "string"
}
},
"additionalProperties": false
},
"endOfSegmentLocation": {
"type": "object",
"properties": {
"tabId": {
"type": "string"
},
"segmentId": {
"type": "string"
}
},
"additionalProperties": false
},
"dateElementProperties": {
"type": "object",
"properties": {
"locale": {
"type": "string"
},
"timestamp": {
"type": "string"
},
"dateFormat": {
"type": "string"
},
"timeFormat": {
"type": "string"
},
"timeZoneId": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"insertText": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"location": {
"type": "object",
"properties": {
"index": {
"type": "integer"
},
"tabId": {
"type": "string"
},
"segmentId": {
"type": "string"
}
},
"additionalProperties": false
},
"endOfSegmentLocation": {
"type": "object",
"properties": {
"tabId": {
"type": "string"
},
"segmentId": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"insertTable": {
"type": "object",
"properties": {
"rows": {
"type": "integer"
},
"columns": {
"type": "integer"
},
"location": {
"type": "object",
"properties": {
"index": {
"type": "integer"
},
"tabId": {
"type": "string"
},
"segmentId": {
"type": "string"
}
},
"additionalProperties": false
},
"endOfSegmentLocation": {
"type": "object",
"properties": {
"tabId": {
"type": "string"
},
"segmentId": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"createFooter": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"sectionBreakLocation": {
"type": "object",
"properties": {
"index": {
"type": "integer"
},
"tabId": {
"type": "string"
},
"segmentId": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"createHeader": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"sectionBreakLocation": {
"type": "object",
"properties": {
"index": {
"type": "integer"
},
"tabId": {
"type": "string"
},
"segmentId": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"deleteFooter": {
"type": "object",
"properties": {
"tabId": {
"type": "string"
},
"footerId": {
"type": "string"
}
},
"additionalProperties": false
},
"deleteHeader": {
"type": "object",
"properties": {
"tabId": {
"type": "string"
},
"headerId": {
"type": "string"
}
},
"additionalProperties": false
},
"insertPerson": {
"type": "object",
"properties": {
"location": {
"type": "object",
"properties": {
"index": {
"type": "integer"
},
"tabId": {
"type": "string"
},
"segmentId": {
"type": "string"
}
},
"additionalProperties": false
},
"personProperties": {
"type": "object",
"properties": {
"email": {
"type": "string"
}
},
"additionalProperties": false
},
"endOfSegmentLocation": {
"type": "object",
"properties": {
"tabId": {
"type": "string"
},
"segmentId": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"replaceImage": {
"type": "object",
"properties": {
"uri": {
"type": "string"
},
"tabId": {
"type": "string"
},
"imageObjectId": {
"type": "string"
},
"imageReplaceMethod": {
"type": "string"
}
},
"additionalProperties": false
},
"addDocumentTab": {
"type": "object",
"properties": {
"tabProperties": {
"type": "object",
"properties": {
"index": {
"type": "integer"
},
"title": {
"type": "string"
},
"iconEmoji": {
"type": "string"
},
"parentTabId": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"createFootnote": {
"type": "object",
"properties": {
"location": {
"type": "object",
"properties": {
"index": {
"type": "integer"
},
"tabId": {
"type": "string"
},
"segmentId": {
"type": "string"
}
},
"additionalProperties": false
},
"endOfSegmentLocation": {
"type": "object",
"properties": {
"tabId": {
"type": "string"
},
"segmentId": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"deleteTableRow": {
"type": "object",
"required": [
"tableCellLocation"
],
"properties": {
"tableCellLocation": {
"type": "object",
"required": [
"columnIndex",
"rowIndex",
"tableStartLocation"
],
"properties": {
"rowIndex": {
"type": "integer"
},
"columnIndex": {
"type": "integer"
},
"tableStartLocation": {
"type": "object",
"properties": {
"index": {
"type": "integer"
},
"tabId": {
"type": "string"
},
"segmentId": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"insertTableRow": {
"type": "object",
"required": [
"insertBelow",
"tableCellLocation"
],
"properties": {
"insertBelow": {
"type": "boolean"
},
"tableCellLocation": {
"type": "object",
"required": [
"columnIndex",
"rowIndex",
"tableStartLocation"
],
"properties": {
"rowIndex": {
"type": "integer"
},
"columnIndex": {
"type": "integer"
},
"tableStartLocation": {
"type": "object",
"properties": {
"index": {
"type": "integer"
},
"tabId": {
"type": "string"
},
"segmentId": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"replaceAllText": {
"type": "object",
"properties": {
"replaceText": {
"type": "string"
},
"containsText": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"matchCase": {
"type": "boolean"
},
"searchByRegex": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"insertPageBreak": {
"type": "object",
"properties": {
"location": {
"type": "object",
"properties": {
"index": {
"type": "integer"
},
"tabId": {
"type": "string"
},
"segmentId": {
"type": "string"
}
},
"additionalProperties": false
},
"endOfSegmentLocation": {
"type": "object",
"properties": {
"tabId": {
"type": "string"
},
"segmentId": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"mergeTableCells": {
"type": "object",
"required": [
"tableRange"
],
"properties": {
"tableRange": {
"type": "object",
"required": [
"columnSpan",
"rowSpan",
"tableCellLocation"
],
"properties": {
"rowSpan": {
"type": "integer"
},
"columnSpan": {
"type": "integer"
},
"tableCellLocation": {
"type": "object",
"required": [
"columnIndex",
"rowIndex",
"tableStartLocation"
],
"properties": {
"rowIndex": {
"type": "integer"
},
"columnIndex": {
"type": "integer"
},
"tableStartLocation": {
"type": "object",
"properties": {
"index": {
"type": "integer"
},
"tabId": {
"type": "string"
},
"segmentId": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"updateTextStyle": {
"type": "object",
"required": [
"fields",
"range",
"textStyle"
],
"properties": {
"range": {
"type": "object",
"properties": {
"tabId": {
"type": "string"
},
"endIndex": {
"type": "integer"
},
"segmentId": {
"type": "string"
},
"startIndex": {
"type": "integer"
}
},
"additionalProperties": false
},
"fields": {
"type": "string"
},
"textStyle": {
"type": "object",
"properties": {
"bold": {
"type": "boolean"
},
"link": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"tabId": {
"type": "string"
},
"headingId": {
"type": "string"
},
"bookmarkId": {
"type": "string"
}
},
"additionalProperties": false
},
"italic": {
"type": "boolean"
},
"fontSize": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"smallCaps": {
"type": "boolean"
},
"underline": {
"type": "boolean"
},
"strikethrough": {
"type": "boolean"
},
"baselineOffset": {
"type": "string"
},
"backgroundColor": {
"type": "object",
"required": [
"color"
],
"properties": {
"color": {
"type": "object",
"required": [
"rgbColor"
],
"properties": {
"rgbColor": {
"type": "object",
"properties": {
"red": {
"type": "number"
},
"blue": {
"type": "number"
},
"green": {
"type": "number"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"foregroundColor": {
"type": "object",
"required": [
"color"
],
"properties": {
"color": {
"type": "object",
"required": [
"rgbColor"
],
"properties": {
"rgbColor": {
"type": "object",
"properties": {
"red": {
"type": "number"
},
"blue": {
"type": "number"
},
"green": {
"type": "number"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"weightedFontFamily": {
"type": "object",
"properties": {
"weight": {
"type": "integer"
},
"fontFamily": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"createNamedRange": {
"type": "object",
"required": [
"name",
"range"
],
"properties": {
"name": {
"type": "string"
},
"range": {
"type": "object",
"properties": {
"tabId": {
"type": "string"
},
"endIndex": {
"type": "integer"
},
"segmentId": {
"type": "string"
},
"startIndex": {
"type": "integer"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"deleteNamedRange": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"namedRangeId": {
"type": "string"
},
"tabsCriteria": {
"type": "object",
"properties": {
"tabIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"deleteTableColumn": {
"type": "object",
"required": [
"tableCellLocation"
],
"properties": {
"tableCellLocation": {
"type": "object",
"required": [
"columnIndex",
"rowIndex",
"tableStartLocation"
],
"properties": {
"rowIndex": {
"type": "integer"
},
"columnIndex": {
"type": "integer"
},
"tableStartLocation": {
"type": "object",
"properties": {
"index": {
"type": "integer"
},
"tabId": {
"type": "string"
},
"segmentId": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"insertInlineImage": {
"type": "object",
"properties": {
"uri": {
"type": "string"
},
"location": {
"type": "object",
"properties": {
"index": {
"type": "integer"
},
"tabId": {
"type": "string"
},
"segmentId": {
"type": "string"
}
},
"additionalProperties": false
},
"objectSize": {
"type": "object",
"properties": {
"width": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"height": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"endOfSegmentLocation": {
"type": "object",
"properties": {
"tabId": {
"type": "string"
},
"segmentId": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"insertTableColumn": {
"type": "object",
"required": [
"insertRight",
"tableCellLocation"
],
"properties": {
"insertRight": {
"type": "boolean"
},
"tableCellLocation": {
"type": "object",
"required": [
"columnIndex",
"rowIndex",
"tableStartLocation"
],
"properties": {
"rowIndex": {
"type": "integer"
},
"columnIndex": {
"type": "integer"
},
"tableStartLocation": {
"type": "object",
"properties": {
"index": {
"type": "integer"
},
"tabId": {
"type": "string"
},
"segmentId": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"unmergeTableCells": {
"type": "object",
"required": [
"tableRange"
],
"properties": {
"tableRange": {
"type": "object",
"required": [
"columnSpan",
"rowSpan",
"tableCellLocation"
],
"properties": {
"rowSpan": {
"type": "integer"
},
"columnSpan": {
"type": "integer"
},
"tableCellLocation": {
"type": "object",
"required": [
"columnIndex",
"rowIndex",
"tableStartLocation"
],
"properties": {
"rowIndex": {
"type": "integer"
},
"columnIndex": {
"type": "integer"
},
"tableStartLocation": {
"type": "object",
"properties": {
"index": {
"type": "integer"
},
"tabId": {
"type": "string"
},
"segmentId": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"deleteContentRange": {
"type": "object",
"required": [
"range"
],
"properties": {
"range": {
"type": "object",
"properties": {
"tabId": {
"type": "string"
},
"endIndex": {
"type": "integer"
},
"segmentId": {
"type": "string"
},
"startIndex": {
"type": "integer"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"insertSectionBreak": {
"type": "object",
"properties": {
"location": {
"type": "object",
"properties": {
"index": {
"type": "integer"
},
"tabId": {
"type": "string"
},
"segmentId": {
"type": "string"
}
},
"additionalProperties": false
},
"sectionType": {
"type": "string"
},
"endOfSegmentLocation": {
"type": "object",
"properties": {
"tabId": {
"type": "string"
},
"segmentId": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"pinTableHeaderRows": {
"type": "object",
"required": [
"pinnedHeaderRowsCount",
"tableStartLocation"
],
"properties": {
"tableStartLocation": {
"type": "object",
"properties": {
"index": {
"type": "integer"
},
"tabId": {
"type": "string"
},
"segmentId": {
"type": "string"
}
},
"additionalProperties": false
},
"pinnedHeaderRowsCount": {
"type": "integer"
}
},
"additionalProperties": false
},
"updateSectionStyle": {
"type": "object",
"required": [
"fields",
"range",
"sectionStyle"
],
"properties": {
"range": {
"type": "object",
"properties": {
"tabId": {
"type": "string"
},
"endIndex": {
"type": "integer"
},
"segmentId": {
"type": "string"
},
"startIndex": {
"type": "integer"
}
},
"additionalProperties": false
},
"fields": {
"type": "string"
},
"sectionStyle": {
"type": "object",
"properties": {
"marginTop": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"marginLeft": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"marginRight": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"marginBottom": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"marginFooter": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"marginHeader": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"defaultFooterId": {
"type": "string"
},
"defaultHeaderId": {
"type": "string"
},
"pageNumberStart": {
"type": "integer"
},
"columnProperties": {
"type": "array",
"items": {
"type": "object",
"properties": {
"width": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"paddingEnd": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"contentDirection": {
"type": "string"
},
"evenPageFooterId": {
"type": "string"
},
"evenPageHeaderId": {
"type": "string"
},
"firstPageFooterId": {
"type": "string"
},
"firstPageHeaderId": {
"type": "string"
},
"flipPageOrientation": {
"type": "boolean"
},
"columnSeparatorStyle": {
"type": "string"
},
"useFirstPageHeaderFooter": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"updateDocumentStyle": {
"type": "object",
"properties": {
"tabId": {
"type": "string"
},
"fields": {
"type": "string"
},
"documentStyle": {
"type": "object",
"properties": {
"pageSize": {
"type": "object",
"properties": {
"width": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"height": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"marginTop": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"background": {
"type": "object",
"properties": {
"color": {
"type": "object",
"required": [
"color"
],
"properties": {
"color": {
"type": "object",
"required": [
"rgbColor"
],
"properties": {
"rgbColor": {
"type": "object",
"properties": {
"red": {
"type": "number"
},
"blue": {
"type": "number"
},
"green": {
"type": "number"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"marginLeft": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"marginRight": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"marginBottom": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"marginFooter": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"marginHeader": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"defaultFooterId": {
"type": "string"
},
"defaultHeaderId": {
"type": "string"
},
"pageNumberStart": {
"type": "integer"
},
"evenPageFooterId": {
"type": "string"
},
"evenPageHeaderId": {
"type": "string"
},
"firstPageFooterId": {
"type": "string"
},
"firstPageHeaderId": {
"type": "string"
},
"flipPageOrientation": {
"type": "boolean"
},
"useEvenPageHeaderFooter": {
"type": "boolean"
},
"useFirstPageHeaderFooter": {
"type": "boolean"
},
"useCustomHeaderFooterMargins": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"updateTableRowStyle": {
"type": "object",
"properties": {
"fields": {
"type": "string"
},
"rowIndices": {
"type": "array",
"items": {
"type": "integer"
}
},
"tableRowStyle": {
"type": "object",
"properties": {
"tableHeader": {
"type": "boolean"
},
"minRowHeight": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"preventOverflow": {
"type": "boolean"
}
},
"additionalProperties": false
},
"tableStartLocation": {
"type": "object",
"properties": {
"index": {
"type": "integer"
},
"tabId": {
"type": "string"
},
"segmentId": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"updateParagraphStyle": {
"type": "object",
"required": [
"fields",
"paragraphStyle",
"range"
],
"properties": {
"range": {
"type": "object",
"properties": {
"tabId": {
"type": "string"
},
"endIndex": {
"type": "integer"
},
"segmentId": {
"type": "string"
},
"startIndex": {
"type": "integer"
}
},
"additionalProperties": false
},
"fields": {
"type": "string"
},
"paragraphStyle": {
"type": "object",
"properties": {
"shading": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "object",
"required": [
"color"
],
"properties": {
"color": {
"type": "object",
"required": [
"rgbColor"
],
"properties": {
"rgbColor": {
"type": "object",
"properties": {
"red": {
"type": "number"
},
"blue": {
"type": "number"
},
"green": {
"type": "number"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"tabStops": {
"type": "array",
"items": {
"type": "object",
"properties": {
"offset": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"alignment": {
"type": "string"
}
},
"additionalProperties": false
}
},
"alignment": {
"type": "string"
},
"borderTop": {
"type": "object",
"properties": {
"color": {
"type": "object",
"required": [
"color"
],
"properties": {
"color": {
"type": "object",
"required": [
"rgbColor"
],
"properties": {
"rgbColor": {
"type": "object",
"properties": {
"red": {
"type": "number"
},
"blue": {
"type": "number"
},
"green": {
"type": "number"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"width": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"padding": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"dashStyle": {
"type": "string"
}
},
"additionalProperties": false
},
"direction": {
"type": "string"
},
"indentEnd": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"borderLeft": {
"type": "object",
"properties": {
"color": {
"type": "object",
"required": [
"color"
],
"properties": {
"color": {
"type": "object",
"required": [
"rgbColor"
],
"properties": {
"rgbColor": {
"type": "object",
"properties": {
"red": {
"type": "number"
},
"blue": {
"type": "number"
},
"green": {
"type": "number"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"width": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"padding": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"dashStyle": {
"type": "string"
}
},
"additionalProperties": false
},
"spaceAbove": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"spaceBelow": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"borderRight": {
"type": "object",
"properties": {
"color": {
"type": "object",
"required": [
"color"
],
"properties": {
"color": {
"type": "object",
"required": [
"rgbColor"
],
"properties": {
"rgbColor": {
"type": "object",
"properties": {
"red": {
"type": "number"
},
"blue": {
"type": "number"
},
"green": {
"type": "number"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"width": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"padding": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"dashStyle": {
"type": "string"
}
},
"additionalProperties": false
},
"indentStart": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"lineSpacing": {
"type": "number"
},
"spacingMode": {
"type": "string"
},
"borderBottom": {
"type": "object",
"properties": {
"color": {
"type": "object",
"required": [
"color"
],
"properties": {
"color": {
"type": "object",
"required": [
"rgbColor"
],
"properties": {
"rgbColor": {
"type": "object",
"properties": {
"red": {
"type": "number"
},
"blue": {
"type": "number"
},
"green": {
"type": "number"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"width": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"padding": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"dashStyle": {
"type": "string"
}
},
"additionalProperties": false
},
"keepWithNext": {
"type": "boolean"
},
"borderBetween": {
"type": "object",
"properties": {
"color": {
"type": "object",
"required": [
"color"
],
"properties": {
"color": {
"type": "object",
"required": [
"rgbColor"
],
"properties": {
"rgbColor": {
"type": "object",
"properties": {
"red": {
"type": "number"
},
"blue": {
"type": "number"
},
"green": {
"type": "number"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"width": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"padding": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"dashStyle": {
"type": "string"
}
},
"additionalProperties": false
},
"namedStyleType": {
"type": "string"
},
"indentFirstLine": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"pageBreakBefore": {
"type": "boolean"
},
"keepLinesTogether": {
"type": "boolean"
},
"avoidWidowAndOrphan": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"updateTableCellStyle": {
"type": "object",
"properties": {
"fields": {
"type": "string"
},
"tableRange": {
"type": "object",
"required": [
"columnSpan",
"rowSpan",
"tableCellLocation"
],
"properties": {
"rowSpan": {
"type": "integer"
},
"columnSpan": {
"type": "integer"
},
"tableCellLocation": {
"type": "object",
"required": [
"columnIndex",
"rowIndex",
"tableStartLocation"
],
"properties": {
"rowIndex": {
"type": "integer"
},
"columnIndex": {
"type": "integer"
},
"tableStartLocation": {
"type": "object",
"properties": {
"index": {
"type": "integer"
},
"tabId": {
"type": "string"
},
"segmentId": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"tableCellStyle": {
"type": "object",
"properties": {
"borderTop": {
"type": "object",
"properties": {
"color": {
"type": "object",
"required": [
"color"
],
"properties": {
"color": {
"type": "object",
"required": [
"rgbColor"
],
"properties": {
"rgbColor": {
"type": "object",
"properties": {
"red": {
"type": "number"
},
"blue": {
"type": "number"
},
"green": {
"type": "number"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"width": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"dashStyle": {
"type": "string"
}
},
"additionalProperties": false
},
"borderLeft": {
"type": "object",
"properties": {
"color": {
"type": "object",
"required": [
"color"
],
"properties": {
"color": {
"type": "object",
"required": [
"rgbColor"
],
"properties": {
"rgbColor": {
"type": "object",
"properties": {
"red": {
"type": "number"
},
"blue": {
"type": "number"
},
"green": {
"type": "number"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"width": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"dashStyle": {
"type": "string"
}
},
"additionalProperties": false
},
"paddingTop": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"borderRight": {
"type": "object",
"properties": {
"color": {
"type": "object",
"required": [
"color"
],
"properties": {
"color": {
"type": "object",
"required": [
"rgbColor"
],
"properties": {
"rgbColor": {
"type": "object",
"properties": {
"red": {
"type": "number"
},
"blue": {
"type": "number"
},
"green": {
"type": "number"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"width": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"dashStyle": {
"type": "string"
}
},
"additionalProperties": false
},
"paddingLeft": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"borderBottom": {
"type": "object",
"properties": {
"color": {
"type": "object",
"required": [
"color"
],
"properties": {
"color": {
"type": "object",
"required": [
"rgbColor"
],
"properties": {
"rgbColor": {
"type": "object",
"properties": {
"red": {
"type": "number"
},
"blue": {
"type": "number"
},
"green": {
"type": "number"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"width": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"dashStyle": {
"type": "string"
}
},
"additionalProperties": false
},
"paddingRight": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"paddingBottom": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"backgroundColor": {
"type": "object",
"required": [
"color"
],
"properties": {
"color": {
"type": "object",
"required": [
"rgbColor"
],
"properties": {
"rgbColor": {
"type": "object",
"properties": {
"red": {
"type": "number"
},
"blue": {
"type": "number"
},
"green": {
"type": "number"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"contentAlignment": {
"type": "string"
}
},
"additionalProperties": false
},
"tableStartLocation": {
"type": "object",
"properties": {
"index": {
"type": "integer"
},
"tabId": {
"type": "string"
},
"segmentId": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"createParagraphBullets": {
"type": "object",
"required": [
"bulletPreset",
"range"
],
"properties": {
"range": {
"type": "object",
"properties": {
"tabId": {
"type": "string"
},
"endIndex": {
"type": "integer"
},
"segmentId": {
"type": "string"
},
"startIndex": {
"type": "integer"
}
},
"additionalProperties": false
},
"bulletPreset": {
"type": "string"
}
},
"additionalProperties": false
},
"deleteParagraphBullets": {
"type": "object",
"required": [
"range"
],
"properties": {
"range": {
"type": "object",
"properties": {
"tabId": {
"type": "string"
},
"endIndex": {
"type": "integer"
},
"segmentId": {
"type": "string"
},
"startIndex": {
"type": "integer"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"deletePositionedObject": {
"type": "object",
"properties": {
"tabId": {
"type": "string"
},
"objectId": {
"type": "string"
}
},
"additionalProperties": false
},
"replaceNamedRangeContent": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"namedRangeId": {
"type": "string"
},
"tabsCriteria": {
"type": "object",
"properties": {
"tabIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"namedRangeName": {
"type": "string"
}
},
"additionalProperties": false
},
"updateDocumentTabProperties": {
"type": "object",
"properties": {
"fields": {
"type": "string"
},
"tabProperties": {
"type": "object",
"properties": {
"index": {
"type": "integer"
},
"tabId": {
"type": "string"
},
"title": {
"type": "string"
},
"iconEmoji": {
"type": "string"
},
"parentTabId": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"updateTableColumnProperties": {
"type": "object",
"properties": {
"fields": {
"type": "string"
},
"columnIndices": {
"type": "array",
"items": {
"type": "integer"
}
},
"tableStartLocation": {
"type": "object",
"properties": {
"index": {
"type": "integer"
},
"tabId": {
"type": "string"
},
"segmentId": {
"type": "string"
}
},
"additionalProperties": false
},
"tableColumnProperties": {
"type": "object",
"properties": {
"width": {
"type": "object",
"required": [
"magnitude",
"unit"
],
"properties": {
"unit": {
"type": "string"
},
"magnitude": {
"type": "number"
}
},
"additionalProperties": false
},
"widthType": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"description": "A list of Google Docs batchUpdate request objects. Each object must have exactly one key (the request type) whose value is the request body. Omit to read the document without applying any edits.\n\nIMPORTANT: When making multiple index-based edits, order requests from highest index to lowest so earlier edits do not shift the indices of later ones. Alternatively, use replaceAllText which does not depend on indices.\n\nThe response always includes the document in DocMD format, which shows each block with its character index range, e.g. [P3 74-104 PARAGRAPH styles=bold:74-86] means paragraph P3 spans indices 74 to 104 with bold from 74 to 86. Use these indices for ranges in subsequent calls.\n\n## Common request examples\n\nreplaceAllText — find and replace all occurrences:\n{\"replaceAllText\": {\"containsText\": {\"text\": \"old\", \"matchCase\": true}, \"replaceText\": \"new\"}}\n\ninsertText — insert at an index (inherits adjacent styling):\n{\"insertText\": {\"location\": {\"index\": 50}, \"text\": \"hello\"}}\n\ndeleteContentRange — delete between two indices:\n{\"deleteContentRange\": {\"range\": {\"startIndex\": 10, \"endIndex\": 25}}}\n\nupdateTextStyle — change formatting with a comma-separated \"fields\" mask:\n{\"updateTextStyle\": {\"range\": {\"startIndex\": 10, \"endIndex\": 20}, \"textStyle\": {\"bold\": true}, \"fields\": \"bold\"}}\n\nupdateParagraphStyle — change paragraph alignment, spacing, etc.:\n{\"updateParagraphStyle\": {\"range\": {\"startIndex\": 10, \"endIndex\": 50}, \"paragraphStyle\": {\"alignment\": \"CENTER\"}, \"fields\": \"alignment\"}}\n\ncreateParagraphBullets — apply bullets (presets: BULLET_DISC_CIRCLE_SQUARE, NUMBERED_DECIMAL_ALPHA_ROMAN, BULLET_CHECKBOX, etc.):\n{\"createParagraphBullets\": {\"range\": {\"startIndex\": 100, \"endIndex\": 200}, \"bulletPreset\": \"BULLET_DISC_CIRCLE_SQUARE\"}}\n\ninsertTable:\n{\"insertTable\": {\"location\": {\"index\": 50}, \"rows\": 3, \"columns\": 4}}\n\nTable operations use tableCellLocation with tableStartLocation (the TABLE start index from DocMD), rowIndex, and columnIndex:\n{\"insertTableRow\": {\"tableCellLocation\": {\"tableStartLocation\": {\"index\": 1749}, \"rowIndex\": 1, \"columnIndex\": 0}, \"insertBelow\": true}}\n\ncreateNamedRange — anchor a named range to a span of text:\n{\"createNamedRange\": {\"name\": \"my-range\", \"range\": {\"startIndex\": 10, \"endIndex\": 50}}}\n\ndeleteNamedRange — delete by name or ID:\n{\"deleteNamedRange\": {\"name\": \"my-range\"}}\n\nreplaceNamedRangeContent — replace the text inside a named range:\n{\"replaceNamedRangeContent\": {\"namedRangeName\": \"my-range\", \"text\": \"new content\"}}\n\ninsertInlineImage — insert an image at an index:\n{\"insertInlineImage\": {\"uri\": \"https://example.com/img.png\", \"location\": {\"index\": 50}}}\n\nreplaceImage — swap an existing image for a new one:\n{\"replaceImage\": {\"imageObjectId\": \"kix.abc123\", \"uri\": \"https://example.com/new.png\", \"imageReplaceMethod\": \"CENTER_CROP\"}}\n\ndeletePositionedObject — remove a floating image or drawing:\n{\"deletePositionedObject\": {\"objectId\": \"kix.abc123\"}}\n\ncreateHeader — add a header to the document:\n{\"createHeader\": {\"type\": \"DEFAULT\"}}\n\ncreateFooter — add a footer to the document:\n{\"createFooter\": {\"type\": \"DEFAULT\"}}\n\ndeleteHeader / deleteFooter — remove by ID:\n{\"deleteHeader\": {\"headerId\": \"kix.abc123\"}}\n{\"deleteFooter\": {\"footerId\": \"kix.abc123\"}}\n\ncreateFootnote — insert a footnote reference:\n{\"createFootnote\": {\"location\": {\"index\": 50}}}\n\naddDocumentTab — add a new tab:\n{\"addDocumentTab\": {\"tabProperties\": {\"title\": \"Notes\"}}}\n\ndeleteTab — remove a tab:\n{\"deleteTab\": {\"tabId\": \"t.123\"}}\n\nupdateDocumentTabProperties — rename or reorder a tab:\n{\"updateDocumentTabProperties\": {\"tabProperties\": {\"tabId\": \"t.123\", \"title\": \"Renamed\"}, \"fields\": \"title\"}}\n\ninsertPerson — insert a person smart chip:\n{\"insertPerson\": {\"personProperties\": {\"email\": \"[email protected]\"}, \"location\": {\"index\": 50}}}\n\ninsertDate — insert a date smart chip:\n{\"insertDate\": {\"dateElementProperties\": {\"timestamp\": \"2025-08-23T00:00:00Z\"}, \"location\": {\"index\": 50}}}\n\nStyle \"fields\" mask: comma-separated list of properties to update (e.g. \"bold,italic\"). Properties listed in fields but absent from the style object are cleared/reset. Use \"*\" to update all fields.\n"
},
"document_id": {
"type": "string",
"description": "The ID of the Google Docs document to edit."
}
}
}