Requests

{

  // Union field request can be only one of the following:
  "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)
  }
  // End of list of possible types for union field request.
}

object (ReplaceAllTextRequest)

Replaces all instances of the specified text.

object (InsertTextRequest)

Inserts text at the specified location.

object (UpdateTextStyleRequest)

Updates the text style at the specified range.

object (CreateParagraphBulletsRequest)

Creates bullets for paragraphs.

object (DeleteParagraphBulletsRequest)

Deletes bullets from paragraphs.

object (CreateNamedRangeRequest)

Creates a named range.

object (DeleteNamedRangeRequest)

Deletes a named range.

object (UpdateParagraphStyleRequest)

Updates the paragraph style at the specified range.

object (DeleteContentRangeRequest)

Deletes content from the document.

object (InsertInlineImageRequest)

Inserts an inline image at the specified location.

object (InsertTableRequest)

Inserts a table at the specified location.

object (InsertTableRowRequest)

Inserts an empty row into a table.

object (InsertTableColumnRequest)

Inserts an empty column into a table.

object (DeleteTableRowRequest)

Deletes a row from a table.

object (DeleteTableColumnRequest)

Deletes a column from a table.

object (InsertPageBreakRequest)

Inserts a page break at the specified location.

object (DeletePositionedObjectRequest)

Deletes a positioned object from the document.

object (UpdateTableColumnPropertiesRequest)

Updates the properties of columns in a table.

object (UpdateTableCellStyleRequest)

Updates the style of table cells.

object (UpdateTableRowStyleRequest)

Updates the row style in a table.

object (ReplaceImageRequest)

Replaces an image in the document.

object (UpdateDocumentStyleRequest)

Updates the style of the document.

object (MergeTableCellsRequest)

Merges cells in a table.

object (UnmergeTableCellsRequest)

Unmerges cells in a table.

object (CreateHeaderRequest)

Creates a header.

object (CreateFooterRequest)

Creates a footer.

object (CreateFootnoteRequest)

Creates a footnote.

object (ReplaceNamedRangeContentRequest)

Replaces the content in a named range.

object (UpdateSectionStyleRequest)

Updates the section style of the specified range.

object (InsertSectionBreakRequest)

Inserts a section break at the specified location.

object (DeleteHeaderRequest)

Deletes a header from the document.

object (DeleteFooterRequest)

Deletes a footer from the document.

object (PinTableHeaderRowsRequest)

Updates the number of pinned header rows in a table.

{
  "replaceText": string,

  // Union field criteria can be only one of the following:
  "containsText": {
    object (SubstringMatchCriteria)
  }
  // End of list of possible types for union field criteria.
}

string

The text that will replace the matched text.

object (SubstringMatchCriteria)

Finds text in the document matching this substring.

{
  "text": string,
  "matchCase": boolean
}

string

The text to search for in the document.

boolean

Indicates whether the search should respect case:

• True : the search is case sensitive.
• False : the search is case insensitive.

{
  "text": string,

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}

string

The text to be inserted.

Inserting a newline character will implicitly create a new Paragraph at that index. The paragraph style of the new paragraph will be copied from the paragraph at the current insertion index, including lists and bullets.

Text styles for inserted text will be determined automatically, generally preserving the styling of neighboring text. In most cases, the text style for the inserted text will match the text immediately before the insertion index.

Some control characters (U+0000-U+0008, U+000C-U+001F) and characters from the Unicode Basic Multilingual Plane Private Use Area (U+E000-U+F8FF) will be stripped out of the inserted text.

object (Location)

Inserts the text at a specific index in the document.

Text must be inserted inside the bounds of an existing Paragraph. For instance, text cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). The text must be inserted in the preceding paragraph.

object (EndOfSegmentLocation)

Inserts the text at the end of a header, footer, footnote or the document body.

{
  "segmentId": string,
  "index": integer
}

string

The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body.

integer

The zero-based index, in UTF-16 code units.

The index is relative to the beginning of the segment specified by segmentId.

{
  "segmentId": string
}

string

The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body.

{
  "textStyle": {
    object (TextStyle)
  },
  "fields": string,

  // Union field insertion_location can be only one of the following:
  "range": {
    object (Range)
  }
  // End of list of possible types for union field insertion_location.
}

object (TextStyle)

The styles to set on the text.

If the value for a particular style matches that of the parent, that style will be set to inherit.

Certain text style changes may cause other changes in order to to mirror the behavior of the Docs editor. See the documentation of TextStyle for more information.

string (FieldMask format)

The fields that should be updated.

At least one field must be specified. The root textStyle is implied and should not be specified. A single "*" can be used as short-hand for listing every field.

For example, to update the text style to bold, set fields to "bold".

To reset a property to its default value, include its field name in the field mask but leave the field itself unset.

object (Range)

The range of text to style.

The range may be extended to include adjacent newlines.

If the range fully contains a paragraph belonging to a list, the paragraph's bullet is also updated with the matching text style.

Ranges cannot be inserted inside a relative UpdateTextStyleRequest.

{
  "range": {
    object (Range)
  },
  "bulletPreset": enum (BulletGlyphPreset)
}

object (Range)

The range to apply the bullet preset to.

enum (BulletGlyphPreset)

The kinds of bullet glyphs to be used.

{
  "range": {
    object (Range)
  }
}

object (Range)

The range to delete bullets from.

{
  "name": string,
  "range": {
    object (Range)
  }
}

string

The name of the NamedRange. Names do not need to be unique.

Names must be at least 1 character and no more than 256 characters, measured in UTF-16 code units.

object (Range)

The range to apply the name to.

{

  // Union field named_range_reference can be only one of the following:
  "namedRangeId": string,
  "name": string
  // End of list of possible types for union field named_range_reference.
}

string

The ID of the named range to delete.

string

The name of the range(s) to delete. All named ranges with the given name will be deleted.

{
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "fields": string,

  // Union field insertion_location can be only one of the following:
  "range": {
    object (Range)
  }
  // End of list of possible types for union field insertion_location.
}

object (ParagraphStyle)

The styles to set on the paragraphs.

Certain paragraph style changes may cause other changes in order to mirror the behavior of the Docs editor. See the documentation of ParagraphStyle for more information.

string (FieldMask format)

The fields that should be updated.

At least one field must be specified. The root paragraphStyle is implied and should not be specified. A single "*" can be used as short-hand for listing every field.

For example, to update the paragraph style's alignment property, set fields to "alignment".

To reset a property to its default value, include its field name in the field mask but leave the field itself unset.

object (Range)

The range overlapping the paragraphs to style.

{
  "range": {
    object (Range)
  }
}

object (Range)

The range of content to delete.

Deleting text that crosses a paragraph boundary may result in changes to paragraph styles, lists, positioned objects and bookmarks as the two paragraphs are merged.

Attempting to delete certain ranges can result in an invalid document structure in which case a 400 bad request error is returned.

Some examples of invalid delete requests include:

• Deleting one code unit of a surrogate pair.
• Deleting the last newline character of a Body, Header, Footer, Footnote, TableCell or TableOfContents.
• Deleting the start or end of a Table, TableOfContents or Equation without deleting the entire element.
• Deleting the newline character before a Table, TableOfContents or SectionBreak without deleting the element.
• Deleting individual rows or cells of a table. Deleting the content within a table cell is allowed.

{
  "uri": string,
  "objectSize": {
    object (Size)
  },

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}

string

The image URI.

The image is fetched once at insertion time and a copy is stored for display inside the document. Images must be less than 50MB in size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF format.

The provided URI must be publicly accessible and at most 2 kB in length. The URI itself is saved with the image, and exposed via the ImageProperties.content_uri field.

object (Size)

The size that the image should appear as in the document. This property is optional and the final size of the image in the document is determined by the following rules: * If neither width nor height is specified, then a default size of the image is calculated based on its resolution. * If one dimension is specified then the other dimension is calculated to preserve the aspect ratio of the image. * If both width and height are specified, the image is scaled to fit within the provided dimensions while maintaining its aspect ratio.

object (Location)

Inserts the image at a specific index in the document.

The image must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph).

Inline images cannot be inserted inside a footnote or equation.

object (EndOfSegmentLocation)

Inserts the text at the end of a header, footer or the document body.

Inline images cannot be inserted inside a footnote.

{
  "rows": integer,
  "columns": integer,

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}

integer

The number of rows in the table.

integer

The number of columns in the table.

object (Location)

Inserts the table at a specific model index.

A newline character will be inserted before the inserted table, therefore the table start index will be at the specified location index + 1.

The table must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between an existing table and its preceding paragraph).

Tables cannot be inserted inside a footnote or equation.

object (EndOfSegmentLocation)

Inserts the table at the end of the given header, footer or document body. A newline character will be inserted before the inserted table.

Tables cannot be inserted inside a footnote.

{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertBelow": boolean
}

object (TableCellLocation)

The reference table cell location from which rows will be inserted.

A new row will be inserted above (or below) the row where the reference cell is. If the reference cell is a merged cell, a new row will be inserted above (or below) the merged cell.

boolean

Whether to insert new row below the reference cell location.

• True : insert below the cell.
• False : insert above the cell.

{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndex": integer,
  "columnIndex": integer
}

object (Location)

The location where the table starts in the document.

integer

The zero-based row index. For example, the second row in the table has a row index of 1.

integer

The zero-based column index. For example, the second column in the table has a column index of 1.

{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertRight": boolean
}

object (TableCellLocation)

The reference table cell location from which columns will be inserted.

A new column will be inserted to the left (or right) of the column where the reference cell is. If the reference cell is a merged cell, a new column will be inserted to the left (or right) of the merged cell.

boolean

Whether to insert new column to the right of the reference cell location.

• True : insert to the right.
• False : insert to the left.

{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}

object (TableCellLocation)

The reference table cell location from which the row will be deleted.

The row this cell spans will be deleted. If this is a merged cell that spans multiple rows, all rows that the cell spans will be deleted. If no rows remain in the table after this deletion, the whole table is deleted.

{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}

object (TableCellLocation)

The reference table cell location from which the column will be deleted.

The column this cell spans will be deleted. If this is a merged cell that spans multiple columns, all columns that the cell spans will be deleted. If no columns remain in the table after this deletion, the whole table is deleted.

{

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}

object (Location)

Inserts the page break at a specific index in the document.

The page break must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph).

Page breaks cannot be inserted inside a table, equation, footnote, header or footer. Since page breaks can only be inserted inside the body, the segment ID field must be empty.

object (EndOfSegmentLocation)

Inserts the page break at the end of the document body.

Page breaks cannot be inserted inside a footnote, header or footer. Since page breaks can only be inserted inside the body, the segment ID field must be empty.

{
  "objectId": string
}

string

The ID of the positioned object to delete.

{
  "tableStartLocation": {
    object (Location)
  },
  "columnIndices": [
    integer
  ],
  "tableColumnProperties": {
    object (TableColumnProperties)
  },
  "fields": string
}

object (Location)

The location where the table starts in the document.

integer

The list of zero-based column indices whose property should be updated. If no indices are specified, all columns will be updated.

object (TableColumnProperties)

The table column properties to update.

If the value of tableColumnProperties#width is less than 5 points (5/72 inch), a 400 bad request error is returned.

string (FieldMask format)

The fields that should be updated.

At least one field must be specified. The root tableColumnProperties is implied and should not be specified. A single "*" can be used as short-hand for listing every field.

For example to update the column width, set fields to "width".

{
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "fields": string,

  // Union field cells can be only one of the following:
  "tableRange": {
    object (TableRange)
  },
  "tableStartLocation": {
    object (Location)
  }
  // End of list of possible types for union field cells.
}

object (TableCellStyle)

The style to set on the table cells.

When updating borders, if a cell shares a border with an adjacent cell, the corresponding border property of the adjacent cell is updated as well. Borders that are merged and invisible are not updated.

Since updating a border shared by adjacent cells in the same request can cause conflicting border updates, border updates are applied in the following order:

• borderRight
• borderLeft
• borderBottom
• borderTop

string (FieldMask format)

The fields that should be updated.

At least one field must be specified. The root tableCellStyle is implied and should not be specified. A single "*" can be used as short-hand for listing every field.

For example to update the table cell background color, set fields to "backgroundColor".

To reset a property to its default value, include its field name in the field mask but leave the field itself unset.

object (TableRange)

The table range representing the subset of the table to which the updates are applied.

object (Location)

The location where the table starts in the document. When specified, the updates are applied to all the cells in the table.

{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "rowSpan": integer,
  "columnSpan": integer
}

object (TableCellLocation)

The cell location where the table range starts.

integer

The row span of the table range.

integer

The column span of the table range.

{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndices": [
    integer
  ],
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "fields": string
}

object (Location)

The location where the table starts in the document.

integer

The list of zero-based row indices whose style should be updated. If no indices are specified, all rows will be updated.

object (TableRowStyle)

The styles to be set on the rows.

string (FieldMask format)

The fields that should be updated.

At least one field must be specified. The root tableRowStyle is implied and should not be specified. A single "*" can be used as short-hand for listing every field.

For example to update the minimum row height, set fields to "minRowHeight".

{
  "imageObjectId": string,
  "uri": string,
  "imageReplaceMethod": enum (ImageReplaceMethod)
}

string

The ID of the existing image that will be replaced. The ID can be retrieved from the response of a get request.

string

The URI of the new image.

The image is fetched once at insertion time and a copy is stored for display inside the document. Images must be less than 50MB, cannot exceed 25 megapixels, and must be in PNG, JPEG, or GIF format.

The provided URI can't surpass 2 KB in length. The URI is saved with the image, and exposed through the ImageProperties.source_uri field.

enum (ImageReplaceMethod)

The replacement method.

{
  "documentStyle": {
    object (DocumentStyle)
  },
  "fields": string
}

object (DocumentStyle)

The styles to set on the document.

Certain document style changes may cause other changes in order to mirror the behavior of the Docs editor. See the documentation of DocumentStyle for more information.

string (FieldMask format)

The fields that should be updated.

At least one field must be specified. The root documentStyle is implied and should not be specified. A single "*" can be used as short-hand for listing every field.

For example to update the background, set fields to "background".

{
  "tableRange": {
    object (TableRange)
  }
}

object (TableRange)

The table range specifying which cells of the table to merge.

Any text in the cells being merged will be concatenated and stored in the "head" cell of the range. This is the upper-left cell of the range when the content direction is left to right, and the upper-right cell of the range otherwise.

If the range is non-rectangular (which can occur in some cases where the range covers cells that are already merged or where the table is non-rectangular), a 400 bad request error is returned.

{
  "tableRange": {
    object (TableRange)
  }
}

object (TableRange)

The table range specifying which cells of the table to unmerge.

All merged cells in this range will be unmerged, and cells that are already unmerged will not be affected. If the range has no merged cells, the request will do nothing.

If there is text in any of the merged cells, the text will remain in the "head" cell of the resulting block of unmerged cells. The "head" cell is the upper-left cell when the content direction is from left to right, and the upper-right otherwise.

{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}

enum (HeaderFooterType)

The type of header to create.

object (Location)

The location of the SectionBreak which begins the section this header should belong to. If `sectionBreakLocation' is unset or if it refers to the first section break in the document body, the header applies to the DocumentStyle

{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}

enum (HeaderFooterType)

The type of footer to create.

object (Location)

The location of the SectionBreak immediately preceding the section whose SectionStyle this footer should belong to. If this is unset or refers to the first section break in the document, the footer applies to the document style.

{

  // Union field footnote_reference_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field footnote_reference_location.
}

object (Location)

Inserts the footnote reference at a specific index in the document.

The footnote reference must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph).

Footnote references cannot be inserted inside an equation, header, footer or footnote. Since footnote references can only be inserted in the body, the segment ID field must be empty.

object (EndOfSegmentLocation)

Inserts the footnote reference at the end of the document body.

Footnote references cannot be inserted inside a header, footer or footnote. Since footnote references can only be inserted in the body, the segment ID field must be empty.

{

  // Union field replacement_content can be only one of the following:
  "text": string
  // End of list of possible types for union field replacement_content.

  // Union field named_range_reference can be only one of the following:
  "namedRangeId": string,
  "namedRangeName": string
  // End of list of possible types for union field named_range_reference.
}

string

Replaces the content of the specified named range(s) with the given text.

string

The ID of the named range whose content will be replaced.

If there is no named range with the given ID a 400 bad request error is returned.

string

The name of the NamedRanges whose content will be replaced.

If there are multiple named ranges with the given name, then the content of each one will be replaced. If there are no named ranges with the given name, then the request will be a no-op.

{
  "range": {
    object (Range)
  },
  "sectionStyle": {
    object (SectionStyle)
  },
  "fields": string
}

object (Range)

The range overlapping the sections to style.

Because section breaks can only be inserted inside the body, the segment ID field must be empty.

object (SectionStyle)

The styles to be set on the section.

Certain section style changes may cause other changes in order to mirror the behavior of the Docs editor. See the documentation of SectionStyle for more information.

string (FieldMask format)

The fields that should be updated.

At least one field must be specified. The root sectionStyle is implied and must not be specified. A single "*" can be used as short-hand for listing every field.

For example to update the left margin, set fields to "marginLeft".

{
  "sectionType": enum (SectionType),

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}

enum (SectionType)

The type of section to insert.

object (Location)

Inserts a newline and a section break at a specific index in the document.

The section break must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph).

Section breaks cannot be inserted inside a table, equation, footnote, header, or footer. Since section breaks can only be inserted inside the body, the segment ID field must be empty.

object (EndOfSegmentLocation)

Inserts a newline and a section break at the end of the document body.

Section breaks cannot be inserted inside a footnote, header or footer. Because section breaks can only be inserted inside the body, the segment ID field must be empty.

{
  "headerId": string
}

string

The id of the header to delete. If this header is defined on DocumentStyle, the reference to this header is removed, resulting in no header of that type for the first section of the document. If this header is defined on a SectionStyle, the reference to this header is removed and the header of that type is now continued from the previous section.

{
  "footerId": string
}

string

The id of the footer to delete. If this footer is defined on DocumentStyle, the reference to this footer is removed, resulting in no footer of that type for the first section of the document. If this footer is defined on a SectionStyle, the reference to this footer is removed and the footer of that type is now continued from the previous section.

{
  "tableStartLocation": {
    object (Location)
  },
  "pinnedHeaderRowsCount": integer
}

object (Location)

The location where the table starts in the document.

integer

The number of table rows to pin, where 0 implies that all rows are unpinned.