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)

替换指定文本的所有实例。

object (InsertTextRequest)

在指定位置插入文本。

object (UpdateTextStyleRequest)

更新指定范围的文本样式。

object (CreateParagraphBulletsRequest)

为段落创建项目符号。

object (DeleteParagraphBulletsRequest)

从段落中删除项目符号。

object (CreateNamedRangeRequest)

创建一个命名范围。

object (DeleteNamedRangeRequest)

删除命名范围。

object (UpdateParagraphStyleRequest)

更新指定范围内的段落样式。

object (DeleteContentRangeRequest)

从文档中删除内容。

object (InsertInlineImageRequest)

在指定位置插入内嵌图片。

object (InsertTableRequest)

在指定位置插入表格。

object (InsertTableRowRequest)

在表中插入一个空行。

object (InsertTableColumnRequest)

向表格中插入空列。

object (DeleteTableRowRequest)

从表中删除行。

object (DeleteTableColumnRequest)

从表中删除列。

object (InsertPageBreakRequest)

在指定位置插入分页符。

object (DeletePositionedObjectRequest)

从文档中删除定位的对象。

object (UpdateTableColumnPropertiesRequest)

更新表中列的属性。

object (UpdateTableCellStyleRequest)

更新表格单元格的样式。

object (UpdateTableRowStyleRequest)

更新表格中的行样式。

object (ReplaceImageRequest)

替换文档中的图片。

object (UpdateDocumentStyleRequest)

更新文档的样式。

object (MergeTableCellsRequest)

合并表格中的单元格。

object (UnmergeTableCellsRequest)

取消合并表格中的单元格。

object (CreateHeaderRequest)

创建一个标头。

object (CreateFooterRequest)

创建页脚。

object (CreateFootnoteRequest)

创建脚注。

object (ReplaceNamedRangeContentRequest)

替换命名范围中的内容。

object (UpdateSectionStyleRequest)

更新指定范围的版块样式。

object (InsertSectionBreakRequest)

在指定位置插入分节符。

object (DeleteHeaderRequest)

从文档中删除标头。

object (DeleteFooterRequest)

从文档中删除页脚。

object (PinTableHeaderRowsRequest)

更新表中固定标题行的数量。

{
  "replaceText": string,
  "tabsCriteria": {
    object (TabsCriteria)
  },

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

string

将用于替换匹配文本的文本。

object (TabsCriteria)

可选。用于指定在哪些标签页中执行替换操作的条件。

如果省略，替换项会应用于所有标签页。

在包含单个标签页的文档中：

• 如果提供，必须与单个制表符的 ID 一致。

• 如果省略，则替换项会应用于单数标签页。

在包含多个标签页的文档中：

• 如果提供，替换项会应用于指定的标签页。

• 如果省略，替换项会应用于所有标签页。

object (SubstringMatchCriteria)

在文档中查找与此子字符串匹配的文本。

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

string

要在文档中搜索的文本。

boolean

指示搜索是否应遵循大小写：

• True ：搜索区分大小写。
• False ：搜索不区分大小写。

{
  "tabIds": [
    string
  ]
}

string

在其中执行请求的标签页 ID 的列表。

{
  "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

要插入的文本。

插入换行符会在该索引处隐式创建一个新的 Paragraph。系统会从当前插入索引处的段落中复制新段落的段落样式，包括列表和项目符号。

系统会自动确定插入文本的文本样式，通常会保留相邻文本的样式。在大多数情况下，所插入文字的文字样式与插入索引前的文字一致。

插入的文本中将删除部分控制字符（U+0000-U+0008、U+000C-U+001F）和 Unicode 基本多语言平面专用区域 (U+E000-U+F8FF) 中的字符。

object (Location)

在文档的特定索引处插入文本。

文本必须插入现有文本的边界内 Paragraph。例如，不能在表格的起始索引处（即表格及其前段落之间）插入文本。该文本必须插入前一段中。

object (EndOfSegmentLocation)

在页眉、页脚、脚注或文档正文的末尾插入文本。

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

string

营业地点所在的页眉、页脚或脚注的 ID。空段 ID 表示文档正文。

integer

索引（从零开始），以 UTF-16 代码单元为单位。

索引相对于由 指定的片段的开头 segmentId。

string

营业地点所在的标签页。如果省略此参数，则请求将应用于第一个标签页。

在包含单个标签页的文档中：

• 如果提供，必须与单个制表符的 ID 一致。

• 如果省略，则请求会应用于单数标签页。

在包含多个标签页的文档中：

• 如果提供此字段，则请求会应用于指定的标签页。

• 如果省略，则请求将应用于文档中的第一个标签页。

{
  "segmentId": string,
  "tabId": string
}

string

营业地点所在的页眉、页脚或脚注的 ID。空段 ID 表示文档正文。

string

相应位置所在的标签页。如果省略此参数，则请求将应用于第一个标签页。

在包含单个标签页的文档中：

• 如果提供，必须与单个制表符的 ID 一致。

• 如果省略，则请求会应用于单数标签页。

在包含多个标签页的文档中：

• 如果提供此字段，则请求会应用于指定的标签页。

• 如果省略，则请求将应用于文档中的第一个标签页。

{
  "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)

要为文本设置的样式。

如果特定样式的值与父级样式的值匹配，则该样式将设置为继承。

为了反映文档编辑器的行为，某些文字样式更改可能会导致其他更改。请参阅 TextStyle 。

string (FieldMask format)

应更新的字段。

必须至少指定一个字段。根 textStyle 是隐含的，因此不应指定。列出每个字段时，您可以使用单个 "*" 作为快捷方式。

例如，如需将文本样式更新为粗体，请将 fields 设置为 "bold"。

要将属性重置为默认值，请在字段掩码中添加其字段名称，但不设置字段本身。

object (Range)

要设置样式的文本范围。

可以扩大范围以包括相邻的换行符。

如果范围完全包含属于列表的段落，则段落的项目符号也会更新为匹配的文本样式。

无法在相对 UpdateTextStyleRequest 内插入范围。

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

object (Range)

要应用项目符号预设的范围。

enum (BulletGlyphPreset)

要使用的项目符号类型。

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

object (Range)

要删除项目符号的范围。

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

string

NamedRange 的名称。名称不必是唯一的。

名称必须至少包含 1 个字符，且不超过 256 个字符（以 UTF-16 代码单元衡量）。

object (Range)

要应用名称的范围。

{
  "tabsCriteria": {
    object (TabsCriteria)
  },

  // 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.
}

object (TabsCriteria)

可选。用于指定应在哪些标签页中删除范围的条件。如果省略，则范围删除操作会应用于所有标签页。

在包含单个标签页的文档中：

• 如果提供，必须与单个标签页的 ID 一致。

• 如果省略，则范围删除操作会应用于单个标签页。

在包含多个标签页的文档中：

• 如果提供，则范围删除操作会应用于指定的标签页。

• 如果未提供此项，则范围删除操作会应用于所有标签页。

string

要删除的命名范围的 ID。

string

要删除的范围的名称。具有给定名称的所有命名范围都将被删除。

{
  "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)

要为段落设置的样式。

为了反映文档编辑器的行为，某些段落样式可能会造成其他更改。如需了解详情，请参阅 ParagraphStyle 文档。

string (FieldMask format)

应更新的字段。

必须至少指定一个字段。根 paragraphStyle 是隐含的，因此不应指定。列出每个字段时，您可以使用单个 "*" 作为快捷方式。

例如，要更新段落样式的对齐属性，请将 fields 更改为 "alignment"。

要将属性重置为默认值，请在字段掩码中添加其字段名称，但不设置字段本身。

object (Range)

与段落重叠的范围设置样式。

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

object (Range)

要删除的内容的范围。

删除跨越段落边界的文本可能会导致段落样式、列表、定位对象和书签发生变化，因为系统会合并这两个段落。

尝试删除特定范围可能会导致文档结构无效，在这种情况下，系统会返回 400 错误请求错误。

无效删除请求的一些示例包括：

• 删除代理对的一个代码单元。
• 删除 Body, Header， Footer, Footnote， TableCell 或 TableOfContents。
• 删除 Table、TableOfContents 或 Equation 的开头或结尾，而不删除整个元素。
• 删除 Table、TableOfContents 或 SectionBreak 前面的换行符，而不删除相应元素。
• 删除表格中的个别行或单元格。您可以删除表格单元格中的内容。

{
  "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

图片 URI。

在插入时，系统会提取一次图片，并存储副本以便在文档内展示。图片必须小于 50MB，不能超过 2500 万像素，并且必须是 PNG、JPEG 或 GIF 格式之一。

提供的 URI 必须可公开访问，并且长度不得超过 2 kB。URI 本身会随图片一起保存，并通过 ImageProperties.content_uri 字段公开。

object (Size)

图片应在文档中显示的大小。此属性是可选属性，文档中图片的最终尺寸由以下规则决定：* 如果未指定宽度和高度，系统会根据图片的分辨率计算默认尺寸。* 如果指定一个尺寸，系统会计算另一个尺寸，以保持图片的宽高比。* 如果同时指定了宽度和高度，则系统会对图片进行缩放，使其适合指定的尺寸，同时保持其宽高比。

object (Location)

在文档的特定索引处插入图片。

图片必须插入现有 Paragraph 的边界内。例如，它不能插入表格的起始索引（即表格与其前面的段落之间）。

内嵌图片无法插入到脚注或等式中。

object (EndOfSegmentLocation)

在页眉、页脚或文档正文的末尾插入文本。

内嵌图片无法插入到脚注中。

{
  "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

表中的行数。

integer

表中的列数。

object (Location)

在特定模型索引处插入表。

系统会在插入的表前插入换行符，因此表的起始索引将位于指定位置索引 + 1 处。

表格必须插入到现有表格的边界内。 Paragraph。例如，无法将其插入表格的起始索引处（即在现有表格与其前一段之间）。

表格无法插入到脚注或等式中。

object (EndOfSegmentLocation)

在指定的页眉、页脚或文档正文的末尾插入表格。系统会在插入的表格前插入一个换行符。

无法在脚注中插入表格。

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

object (TableCellLocation)

要从中插入行的数据表单元格引用位置。

系统会在引用单元格所在行的上方（或下方）插入一个新行。如果引用单元格是合并单元格，系统会在合并单元格的上方（或下方）插入新行。

boolean

是否在引用单元格位置下方插入新行。

• True ：在单元格下方插入。
• False ：在单元格上方插入。

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

object (Location)

表格在文档中开始的位置。

integer

行索引（从零开始）。例如，表中第二行的行索引为 1。

integer

从零开始的列索引。例如，表中第二列的列索引为 1。

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

object (TableCellLocation)

要插入列的参考表格单元格位置。

系统会在引用单元格所在列的左侧（或右侧）插入一个新列。如果引用单元格是合并单元格，系统会在合并单元格的左侧（或右侧）插入一个新列。

boolean

是否在引用单元格位置的右侧插入新列。

• True ：插入右侧。
• False ：向左插入。

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

object (TableCellLocation)

要删除行的参考表格单元格位置。

系统会删除此单元格跨越的行。如果这是跨多行合并的单元格，则系统会删除该单元格跨越的所有行。如果在执行此删除操作之后没有保留表中的行，则整个表都将被删除。

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

object (TableCellLocation)

要删除引用表单元格的位置。

系统会删除此单元格跨越的列。如果这是一个跨越多列的合并单元格，则该单元格跨越的所有列都将被删除。如果此删除操作后表中没有剩余列，则系统会删除整个表。

{

  // 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)

在文档中的特定索引处插入分页符。

分页符必须插入到现有 Paragraph。例如，它不能插入表格的起始索引（即表格与其前面的段落之间）。

无法在表格、等式、脚注、页眉或页脚中插入分页符。由于分页符只能插入到正文内部，因此 segment ID 字段必须为空。

object (EndOfSegmentLocation)

在文档正文末尾插入分页符。

无法在脚注、页眉或页脚中插入分页符。由于分页符只能插入到正文内部，因此 segment ID 字段必须为空。

{
  "objectId": string,
  "tabId": string
}

string

要删除的定位对象的 ID。

string

要删除的对象所在的标签页。如果省略此参数，则请求将应用于第一个标签页。

在包含单个标签页的文档中：

• 如果提供，必须与单个制表符的 ID 一致。

• 如果省略，则请求会应用于单数标签页。

在包含多个标签页的文档中：

• 如果提供此字段，则请求会应用于指定的标签页。

• 如果省略，则请求将应用于文档中的第一个标签页。

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

object (Location)

表格在文档中开始的位置。

integer

应更新其属性的从零开始的列索引列表。如果未指定索引，系统将更新所有列。

object (TableColumnProperties)

要更新的表格列属性。

如果 tableColumnProperties#width 的值小于 5 点（5/72 英寸），则会返回 400 错误请求错误。

string (FieldMask format)

应更新的字段。

必须至少指定一个字段。根 tableColumnProperties 是隐含的，因此不应指定。列出每个字段时，您可以使用单个 "*" 作为快捷方式。

例如，要更新列宽，请将 fields 更改为 "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)

要在表格单元格上设置的样式。

更新边框时，如果某个单元格与相邻单元格共用边框，则相邻单元格的相应边框属性也会随之更新。合并后不可见的边框不会更新。

由于更新同一请求中相邻单元格共享的边框可能会导致边框更新出现冲突，因此边框更新按以下顺序应用：

• borderRight
• borderLeft
• borderBottom
• borderTop

string (FieldMask format)

应更新的字段。

必须至少指定一个字段。根 tableCellStyle 是隐含的，因此不应指定。单个 "*" 可以用作列出每个字段的简写形式。

例如，要更新表格单元格的背景颜色，请将 fields 更改为 "backgroundColor"。

要将属性重置为默认值，请在字段掩码中添加其字段名称，但不设置字段本身。

object (TableRange)

表格范围，表示要应用更新的表格子集。

object (Location)

表格在文档中的起始位置。指定此参数后，系统会将更新应用于表中的所有单元格。

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

object (TableCellLocation)

表格范围的起始单元格位置。

integer

表范围的行跨度。

integer

表格范围的列跨度。

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

object (Location)

表格在文档中的起始位置。

integer

应更新其样式的行索引列表（从零开始）。如果未指定任何索引，则会更新所有行。

object (TableRowStyle)

要为行设置的样式。

string (FieldMask format)

应更新的字段。

必须至少指定一个字段。根 tableRowStyle 是隐含的，不应指定。单个 "*" 可以用作列出每个字段的简写形式。

例如，要更新最小行高，请将 fields 更改为 "minRowHeight"。

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

string

要替换的现有图片的 ID。您可以从 get 请求的响应中检索该 ID。

string

新图片的 URI。

在插入时，系统会提取一次图片，并存储副本以便在文档内展示。图片必须小于 50MB，不能超过 2500 万像素，并且必须采用 PNG、JPEG 或 GIF 格式。

提供的 URI 长度不得超过 2 KB。URI 会随图片一起保存，并通过 ImageProperties.source_uri 字段公开。

enum (ImageReplaceMethod)

替换方法。

string

要替换的图片所在的标签页。如果省略，系统会将请求应用于第一个标签页。

在包含单个标签页的文档中：

• 如果提供，必须与单个制表符的 ID 一致。

• 如果省略，则请求会应用于单数标签页。

在包含多个标签页的文档中：

• 如果提供此字段，则请求会应用于指定的标签页。

• 如果省略，则请求会应用于文档中的第一个标签页。

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

object (DocumentStyle)

要在文档上设置的样式。

某些文档样式更改可能会导致其他更改，以反映 Google 文档编辑器的行为。如需了解详情，请参阅 DocumentStyle 文档。

string (FieldMask format)

应更新的字段。

必须至少指定一个字段。根 documentStyle 是隐含的，因此不应指定。单个 "*" 可以用作列出每个字段的简写形式。

例如，要更新背景，请将 fields 更改为 "background"。

string

包含要更新的样式的标签页。如果省略，则请求会应用于第一个标签页。

在包含单个标签页的文档中：

• 如果提供，必须与单个制表符的 ID 一致。

• 如果省略，则请求会应用于单数标签页。

在包含多个标签页的文档中：

• 如果提供此字段，则请求会应用于指定的标签页。

• 如果未提供，则相应请求会应用于文档中的第一个标签页。

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

object (TableRange)

指定要合并表格的哪些单元格的表格范围。

要合并的单元格中的所有文本都将串联起来，并存储在该范围的“head”单元格中。如果内容方向为从左到右，则为范围的左上角单元格；否则，为范围的右上角单元格。

如果范围是非矩形（在某些情况下，范围包括已合并的单元格或表格为非矩形就会出现这种情况），系统会返回 400 错误请求错误。

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

object (TableRange)

表格范围，用于指定要取消合并的表格中的哪些单元格。

系统会取消合并此范围中的所有已合并单元格，而已取消合并的单元格不会受到影响。如果范围中没有合并的单元格，则请求将不执行任何操作。

如果任何合并的单元格中都包含文本，则文本将保留在生成的未合并单元格块的“标题”单元格中。如果内容方向为从左到右，则“标题”单元格为左上角单元格；否则，则为右上角单元格。

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

enum (HeaderFooterType)

要创建的标头类型。

object (Location)

该 SectionBreak 开头的相应部分如果“sectionBreakLocation”如果未设置，或者引用了文档正文中的第一个分节符，则标头会应用于 DocumentStyle

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

enum (HeaderFooterType)

要创建的页脚类型。

object (Location)

此页脚应属于的部分的 SectionStyle 紧前面的 SectionBreak 的位置。如果此政策未设置或指向文档中的第一个分节符，页脚会应用于文档样式。

{

  // 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)

在文档中的特定索引处插入脚注引用。

脚注引用必须插入现有 Paragraph。例如，无法将其插入表格的起始索引处（即表格及其前一段之间）。

脚注引用不能插入到等式、标题、页脚或脚注中。由于脚注引用只能插入正文中， segment ID 字段必须为空。

object (EndOfSegmentLocation)

在文档正文的末尾插入脚注引用。

脚注引用不能插入页眉、页脚或脚注中。由于脚注引用只能插入正文中， segment ID 字段必须为空。

{
  "tabsCriteria": {
    object (TabsCriteria)
  },

  // 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.
}

object (TabsCriteria)

可选。用于指定在哪些标签页中执行替换操作的条件。如果省略，替换项会应用于所有标签页。

在包含单个标签页的文档中：

• 如果提供，必须与单个制表符的 ID 一致。

• 如果省略，则替换项会应用于单数标签页。

在包含多个标签页的文档中：

• 如果提供，替换项会应用于指定的标签页。

• 如果省略，替换项将应用于所有标签页。

string

使用给定文本替换指定命名范围的内容。

string

要替换其内容的命名范围的 ID。

如果不存在具有指定 ID 的命名范围，系统会返回 400 错误请求错误。

string

该 NamedRanges 其内容将被替换。

如果有多个 named ranges ，则每个模板的内容将被替换掉。如果没有具有给定名称的命名范围，则请求将不执行任何操作。

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

object (Range)

与要设置样式的版块重叠的范围。

由于只能在正文中插入分节插入点，因此 segment ID 字段必须为空。

object (SectionStyle)

要在版块上设置的样式。

为了反映文档编辑器的行为，某些版块样式更改可能会导致其他更改。请参阅 SectionStyle 。

string (FieldMask format)

应更新的字段。

必须至少指定一个字段。根 sectionStyle 是隐含的，不得指定。单个 "*" 可以用作列出每个字段的简写形式。

例如，如需更新左边距，请将 fields 设置为 "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)

要插入的部分的类型。

object (Location)

在文档的特定索引处插入换行符和分节符。

必须在现有 Paragraph 的边界内插入分节插入点。例如，无法将其插入表格的起始索引处（即表格及其前一段之间）。

无法在表格、等式、脚注、页眉或页脚中插入分节符。由于只能在正文中插入分节插入点，因此 segment ID 字段必须为空。

object (EndOfSegmentLocation)

在文档正文的末尾插入换行符和分节符。

不能在脚注、页眉或页脚中插入分节符。由于分节符只能插入正文内部，因此 segment ID 字段必须为空。

{
  "headerId": string,
  "tabId": string
}

string

要删除的标头的 ID。如果该标头是在 DocumentStyle，系统会移除对此标头的引用，这会导致文档的第一部分没有该类型的标头。如果此标头是在 SectionStyle，系统会移除对此标头的引用，该类型的标头现在从上一节继续。

string

包含要删除的标题的标签页。如果省略，系统会将请求应用于第一个标签页。

在包含单个标签页的文档中：

• 如果提供，必须与单个制表符的 ID 一致。

• 如果省略，则请求会应用于单数标签页。

在包含多个标签页的文档中：

• 如果提供此字段，则请求会应用于指定的标签页。

• 如果省略，则请求将应用于文档中的第一个标签页。

{
  "footerId": string,
  "tabId": string
}

string

要删除的页脚的 ID。如果此页脚是在 DocumentStyle，系统会移除对此页脚的引用，导致文档的第一部分没有该类型的页脚。如果此页脚是在 SectionStyle 上定义的，系统会移除对此页脚的引用，并且该类型的页脚现在会从上一部分继续。

string

包含要删除的页脚的标签页。如果省略此参数，则请求将应用于第一个标签页。

在包含单个标签页的文档中：

• 如果提供，必须与单个制表符的 ID 一致。

• 如果省略，则请求会应用于单数标签页。

在包含多个标签页的文档中：

• 如果提供此字段，则请求会应用于指定的标签页。

• 如果省略，则请求会应用于文档中的第一个标签页。

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

object (Location)

表格在文档中开始的位置。

integer

要固定的表格行数，其中 0 表示取消固定所有行。