Requests

请求

要应用于文档的单个更新。

JSON 表示法 
{

  // 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.
}
字段
联合字段 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)

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

ReplaceAllTextRequest

将与条件匹配的所有文本实例替换为 replace text。

JSON 表示法 
{
  "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.
}
字段
replaceText

string

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

tabsCriteria

object (TabsCriteria)

可选。用于指定替换项在哪些标签页中发生的条件。

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

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

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

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

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

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

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

联合字段 criteria。用于匹配要替换的文本的条件。 criteria只能是以下其中一项：
containsText

object (SubstringMatchCriteria)

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

SubstringMatchCriteria

与文档中的特定文本字符串匹配的条件。

JSON 表示法 
{
  "text": string,
  "matchCase": boolean
}
字段
text

string

要在文档中搜索的文本。

matchCase

boolean

指示搜索时是否应区分大小写：

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

TabsCriteria

用于指定请求在哪些标签页中执行的条件。

JSON 表示法 
{
  "tabIds": [
    string
  ]
}
字段
tabIds[]

string

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

InsertTextRequest

在指定位置插入文本。

JSON 表示法 
{
  "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.
}
字段
text

string

要插入的文本。

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

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

系统会从插入的文字中剥离某些控制字符 (U+0000-U+0008、U+000C-U+001F) 和 Unicode 基本多语言平面专用区中的字符 (U+E000-U+F8FF)。

联合字段 insertion_location。文本的插入位置。 insertion_location 只能是下列其中一项：
location

object (Location)

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

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

endOfSegmentLocation

object (EndOfSegmentLocation)

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

位置

文档中的特定位置。

JSON 表示法 
{
  "segmentId": string,
  "index": integer,
  "tabId": string
}
字段
segmentId

string

相应位置所在的页眉、页脚或脚注的 ID。空细分 ID 表示文档正文。

index

integer

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

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

tabId

string

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

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

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

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

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

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

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

EndOfSegmentLocation

位于正文、页眉、页脚或脚注末尾的位置。该位置位于文档段中的最后一行换行符之前。

JSON 表示法 
{
  "segmentId": string,
  "tabId": string
}
字段
segmentId

string

相应位置所在的页眉、页脚或脚注的 ID。空段 ID 表示文档正文。

tabId

string

相应位置所在的标签页。如果省略，系统会将请求应用于第一个标签页。

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

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

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

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

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

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

UpdateTextStyleRequest

更新文本的样式。

JSON 表示法 
{
  "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.
}
字段
textStyle

object (TextStyle)

要为文本设置的样式。

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

为了反映 Google 文档编辑器的行为，某些文本样式更改可能会导致其他更改。如需了解详情，请参阅 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 ：箭头，对应于 Unicode U+2794 码位
  • ARROW3D ：带有 3D 阴影的箭头，对应于 Unicode U+27a2 代码点
  • CHECKBOX ：空心方形，对应于 Unicode U+274f 码位
  • CIRCLE ：空心圆圈，对应于 Unicode U+25cb 代码点
  • DIAMOND：实心菱形，与 Unicode U+25c6 代码点对应
  • DIAMONDX：带有“x”的菱形，对应于 Unicode U+2756 代码点
  • HOLLOWDIAMOND ：空心菱形，对应于 Unicode U+25c7 码位
  • DISC ：实心圆圈，对应于 Unicode U+25cf 代码点
  • SQUARE ：一个实心方形，对应于 Unicode U+25a0 码位
  • STAR ：星形，对应于 Unicode 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 ：向左指示的三角形，对应于 Unicode U+25c4 代码点
枚举
BULLET_GLYPH_PRESET_UNSPECIFIED 未指定项目符号预设。
BULLET_DISC_CIRCLE_SQUARE 前 3 个列表嵌套级别的带 DISC、CIRCLE 和 SQUARE 项目符号符号的项目符号列表。
BULLET_DIAMONDX_ARROW3D_SQUARE 项目符号列表，其中前 3 个列表嵌套级别使用 DIAMONDX、ARROW3D 和 SQUARE 项目符号。
BULLET_CHECKBOX 项目符号列表，其中包含适用于所有列表嵌套级别的 CHECKBOX 项目符号。
BULLET_ARROW_DIAMOND_DISC 项目符号列表，其中前 3 个列表嵌套级别使用 ARROW、DIAMOND 和 DISC 项目符号。
BULLET_STAR_CIRCLE_SQUARE 项目符号列表，其中前 3 个列表嵌套级别使用 STAR、CIRCLE 和 SQUARE 项目符号。
BULLET_ARROW3D_CIRCLE_SQUARE 前 3 个列表嵌套级别的带 ARROW3D、CIRCLE 和 SQUARE 项目符号符号的项目符号列表。
BULLET_LEFTTRIANGLE_DIAMOND_DISC 项目符号列表，其中前 3 个列表嵌套级别使用 LEFTTRIANGLE、DIAMOND 和 DISC 项目符号。
BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE 项目符号列表，其中前 3 个列表嵌套级别使用 DIAMONDX、HOLLOWDIAMOND 和 SQUARE 项目符号。
BULLET_DIAMOND_CIRCLE_SQUARE 项目符号列表，其中前 3 个列表嵌套级别使用 DIAMOND、CIRCLE 和 SQUARE 项目符号。
NUMBERED_DECIMAL_ALPHA_ROMAN 编号列表，其中前 3 个列表嵌套级别使用 DECIMAL、ALPHA 和 ROMAN 数字字形，后跟英文句点。
NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS 一个编号列表，前 3 个列表嵌套级别带有 DECIMAL、ALPHA 和 ROMAN 数字字形，后跟圆括号。
NUMBERED_DECIMAL_NESTED 一个包含 DECIMAL 个数字字形（以英文句点分隔）的编号列表，其中每个嵌套级别都使用前一个嵌套级别的字形作为前缀。例如：“1.”，'1.1.', “2.”、'2.2.'。
NUMBERED_UPPERALPHA_ALPHA_ROMAN 编号列表，其中前 3 个列表嵌套级别使用 UPPERALPHA、ALPHA 和 ROMAN 数字字形，后跟英文句点。
NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL 编号列表，其中前 3 个列表嵌套级别使用 UPPERROMAN、UPPERALPHA 和 DECIMAL 数字字形，后跟英文句点。
NUMBERED_ZERODECIMAL_ALPHA_ROMAN 一个编号列表，前 3 个列表嵌套级别带有 ZERODECIMAL、ALPHA 和 ROMAN 数字字形，后跟英文句点。

DeleteParagraphBulletsRequest

从与给定范围重叠的所有段落中删除项目符号。

系统会在相应段落的开头添加缩进，从而直观地保留每个段落的嵌套级别。

JSON 表示法 
{
  "range": {
    object (Range)
  }
}
字段
range

object (Range)

要从中删除项目符号的范围。

CreateNamedRangeRequest

创建一个引用给定范围的 NamedRange。

JSON 表示法 
{
  "name": string,
  "range": {
    object (Range)
  }
}
字段
name

string

命名范围的名称。名称不必是唯一的。

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

range

object (Range)

要应用名称的范围。

DeleteNamedRangeRequest

删除 NamedRange。

JSON 表示法 
{
  "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.
}
字段
tabsCriteria

object (TabsCriteria)

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

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

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

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

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

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

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

联合字段 named_range_reference。用于确定要删除的范围的值。只能设置一个值。 named_range_reference只能是以下其中一项：
namedRangeId

string

要删除的命名范围的 ID。

name

string

要删除的范围的名称。系统会删除所有具有给定名称的命名范围。

UpdateParagraphStyleRequest

更新与给定范围重叠的所有段落的样式。

JSON 表示法 
{
  "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.
}
字段
paragraphStyle

object (ParagraphStyle)

要为段落设置的样式。

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

fields

string (FieldMask format)

应更新的字段。

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

例如，如需更新段落样式的对齐方式属性，请将 fields 设置为 "alignment"。

如需将某个属性重置为默认值，请在字段掩码中添加其字段名称，但将该字段本身保持未设置状态。

联合字段 insertion_location。用于更新段落样式的范围类型。 insertion_location 只能是下列其中一项：
range

object (Range)

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

DeleteContentRangeRequest

从文档中删除内容。

JSON 表示法 
{
  "range": {
    object (Range)
  }
}
字段
range

object (Range)

要删除的内容范围。

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

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

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

InsertInlineImageRequest

在给定位置插入包含图片的 InlineObject。

JSON 表示法 
{
  "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.
}
字段
uri

string

图片 URI。

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

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

objectSize

object (Size)

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

联合字段 insertion_location。图片的插入位置。 insertion_location 只能是下列其中一项：
location

object (Location)

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

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

无法在脚注或方程中插入内嵌图片。

endOfSegmentLocation

object (EndOfSegmentLocation)

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

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

InsertTableRequest

在指定位置插入表。

系统会在插入的表格之前插入换行符。

JSON 表示法 
{
  "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.
}
字段
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

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

columnIndex

integer

列索引（从零开始）。例如，表中的第二列的列编号为 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 表示法 
{

  // 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.
}
字段
联合字段 insertion_location。要插入分页符的位置。 insertion_location 只能是下列其中一项：
location

object (Location)

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

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

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

endOfSegmentLocation

object (EndOfSegmentLocation)

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

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

DeletePositionedObjectRequest

从文档中删除 PositionedObject。

JSON 表示法 
{
  "objectId": string,
  "tabId": string
}
字段
objectId

string

要删除的定位对象的 ID。

tabId

string

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

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

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

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

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

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

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

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 错误“Bad Request”。

fields

string (FieldMask format)

应更新的字段。

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

例如，如需更新列宽，请将 fields 设置为 "width"。

UpdateTableCellStyleRequest

更新表格单元格范围的样式。

JSON 表示法 
{
  "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.
}
字段
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, 行 = 0, 列 = 0)，行 span = 3，列 span = 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

用新图片替换现有图片。

替换图片会从现有图片中移除一些 image effects，以反映 Google 文档编辑器的行为。

JSON 表示法 
{
  "imageObjectId": string,
  "uri": string,
  "imageReplaceMethod": enum (ImageReplaceMethod),
  "tabId": string
}
字段
imageObjectId

string

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

uri

string

新图片的 URI。

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

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

imageReplaceMethod

enum (ImageReplaceMethod)

替换方法。

tabId

string

要替换的图片所在的标签页。如果省略此参数，则请求将应用于第一个标签页。

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

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

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

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

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

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

ImageReplaceMethod

图片替换方法。

枚举
IMAGE_REPLACE_METHOD_UNSPECIFIED 未指定的图片替换方法。请勿使用此值。
CENTER_CROP 缩放图片并将其居中，以填充原始图片的边界。系统可能会剪裁图片，以填充原始图片的边界。图片的呈现大小将与原始图片相同。

UpdateDocumentStyleRequest

更新 DocumentStyle。

JSON 表示法 
{
  "documentStyle": {
    object (DocumentStyle)
  },
  "fields": string,
  "tabId": string
}
字段
documentStyle

object (DocumentStyle)

要在文档中设置的样式。

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

fields

string (FieldMask format)

应更新的字段。

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

例如，如需更新背景，请将 fields 设置为 "background"。

tabId

string

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

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

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

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

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

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

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

MergeTableCellsRequest

合并 Table 中的单元格。

JSON 表示法 
{
  "tableRange": {
    object (TableRange)
  }
}
字段
tableRange

object (TableRange)

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

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

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

UnmergeTableCellsRequest

取消合并 Table 中的单元格。

JSON 表示法 
{
  "tableRange": {
    object (TableRange)
  }
}
字段
tableRange

object (TableRange)

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

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

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

CreateHeaderRequest

创建 Header。新标头会应用于 SectionBreak 位置（如果已指定）的 SectionStyle，否则会应用于 DocumentStyle。

如果指定类型的标头已存在，则会返回 400 错误请求错误。

JSON 表示法 
{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}
字段
type

enum (HeaderFooterType)

要创建的标头类型。

sectionBreakLocation

object (Location)

此标题应属于的部分的开头 SectionBreak 的位置。如果未设置“sectionBreakLocation”，或者它引用文档正文中的第一个分节插入点，则标题会应用于该插入点。DocumentStyle

HeaderFooterType

可以创建的标题和页脚类型。

枚举
DEFAULT 默认页眉/页脚。

CreateFooterRequest

创建 Footer。如果指定了 SectionBreak 的位置，则新页脚会应用于 SectionStyle；否则，它会应用于 DocumentStyle。

如果指定类型的页脚已存在，则返回 400 错误请求错误。

JSON 表示法 
{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}
字段
type

enum (HeaderFooterType)

要创建的页脚类型。

sectionBreakLocation

object (Location)

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

CreateFootnoteRequest

创建 Footnote 片段，并在给定位置将新的 FootnoteReference 插入其中。

新的 Footnote 段将包含一个空格，后跟一个换行符。

JSON 表示法 
{

  // 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.
}
字段
联合字段 footnote_reference_location。要插入脚注引用的位置。footnote_reference_location只能是以下其中一项：
location

object (Location)

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

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

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

endOfSegmentLocation

object (EndOfSegmentLocation)

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

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

ReplaceNamedRangeContentRequest

将指定的 NamedRange 或 NamedRanges 的内容替换为给定的替换内容。

请注意，单个 NamedRange 可能包含多个不连续的 ranges。在这种情况下，系统只会替换第一个范围中的内容。系统会删除其他范围及其内容。

如果替换或删除任何范围会导致文档结构无效，系统会返回 400 错误请求错误。

JSON 表示法 
{
  "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.
}
字段
tabsCriteria

object (TabsCriteria)

可选。用于指定替换项在哪些标签页中发生的条件。如果省略，替换项将应用于所有标签页。

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

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

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

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

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

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

联合字段 replacement_content。要替换命名范围的现有内容的内容。 replacement_content 只能是下列其中一项：
text

string

将指定命名范围的内容替换为给定文本。

联合字段 named_range_reference。对要替换内容的命名范围的引用。 named_range_reference只能是以下其中一项：
namedRangeId

string

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

如果没有具有给定 ID 的命名范围，则会返回 400 错误“Bad Request”。

namedRangeName

string

内容将被替换的 NamedRanges 的名称。

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

UpdateSectionStyleRequest

更新 SectionStyle。

JSON 表示法 
{
  "range": {
    object (Range)
  },
  "sectionStyle": {
    object (SectionStyle)
  },
  "fields": string
}
字段
range

object (Range)

与要设置样式的部分重叠的范围。

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

sectionStyle

object (SectionStyle)

要在该版块上设置的样式。

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

fields

string (FieldMask format)

应更新的字段。

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

例如，如需更新左外边距，请将 fields 设置为 "marginLeft"。

InsertSectionBreakRequest

在指定位置插入分节符。

系统会在分节符前插入一个换行符。

JSON 表示法 
{
  "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.
}
字段
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

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

tabId

string

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

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

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

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

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

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

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

DeleteFooterRequest

从文档中删除 Footer。

JSON 表示法 
{
  "footerId": string,
  "tabId": string
}
字段
footerId

string

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

tabId

string

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

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

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

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

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

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

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

PinTableHeaderRowsRequest

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

JSON 表示法 
{
  "tableStartLocation": {
    object (Location)
  },
  "pinnedHeaderRowsCount": integer
}
字段
tableStartLocation

object (Location)

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

pinnedHeaderRowsCount

integer

要固定的表行数，其中 0 表示所有行均处于未固定状态。