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)
  },
  "insertPerson": {
    object (InsertPersonRequest)
  }
  // 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)

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

insertPerson

object (InsertPersonRequest)

插入人员提及。

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,
  "searchByRegex": boolean
}
字段
text

string

要在文档中搜索的文本。

matchCase

boolean

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

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

boolean

可选。如果应将查找值视为正则表达式，则为 true。模式中的所有反斜杠都应进行转义。

  • 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

NamedRange 的名称。名称不必具有唯一性。

名称长度至少为 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)

要设置在段落上的样式。

某些段落样式更改可能会导致其他更改，以反映 Google 文档编辑器的行为。如需了解详情，请参阅 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 错误请求错误。

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

表格范围表示对表格子集的引用。

请务必注意，表格范围指定的单元格不一定构成矩形。例如，假设我们有一个 3x3 的表格，其中最后一行的所有单元格都合并在一起。该表如下所示： 

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

表格单元格位置为 (tableStartLocation, row = 0, column = 0)、行跨度为 3 且列跨度为 2 的表格范围指定了以下单元格： 

 [ x ][ x ][   ]
 [ x ][ x ][   ]
 [ x    x    x ]
JSON 表示法 
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "rowSpan": integer,
  "columnSpan": integer
}
字段
tableCellLocation

object (TableCellLocation)

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

rowSpan

integer

表格范围的行跨度。

columnSpan

integer

表格范围的列跨度。

UpdateTableRowStyleRequest

更新表中行的 TableRowStyle。

JSON 表示法 
{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndices": [
    integer
  ],
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "fields": string
}
字段
tableStartLocation

object (Location)

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

rowIndices[]

integer

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

tableRowStyle

object (TableRowStyle)

要为行设置的样式。

fields

string (FieldMask format)

应更新的字段。

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

例如，如需更新最小行高，请将 fields 设置为 "minRowHeight"。

ReplaceImageRequest

用新图片替换现有图片。

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

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

string

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

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)

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

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

如果范围是非矩形（在某些情况下，范围可能涵盖已合并的单元格或表格是非矩形），则会返回 400 错误请求错误。

UnmergeTableCellsRequest

取消合并 Table 中的单元格。

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

object (TableRange)

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

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

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

CreateHeaderRequest

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

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

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

enum (HeaderFooterType)

要创建的标头类型。

sectionBreakLocation

object (Location)

应属于相应标题的区段的开头位置 SectionBreak。如果未设置 `sectionBreakLocation`，或者该属性是指文档正文中的第一个分节符，则相应页眉适用于 DocumentStyle

HeaderFooterType

可创建的页眉和页脚类型。

枚举
DEFAULT 默认页眉/页脚。

CreateFooterRequest

创建 Footer。新页脚会应用于 SectionStyle（如果指定了 SectionBreak，则位于 SectionBreak 的位置），否则会应用于 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 错误请求错误。

namedRangeName

string

要替换其内容的 NamedRanges 的名称。

如果存在多个具有指定名称的 named ranges，则每个 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 表示所有行均未固定。

InsertPersonRequest

插入人员提及。

JSON 表示法 
{
  "personProperties": {
    object (PersonProperties)
  },

  // 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.
}
字段
personProperties

object (PersonProperties)

要插入的人员提及的属性。

联合字段 insertion_location。插入人员提及内容的位置。 insertion_location 只能是下列其中一项：
location

object (Location)

在文档中的特定索引处插入人员提及。

提及的人员必须插入到现有 Paragraph 的边界内。例如，不能将其插入到表格的起始索引处（即表格与其前面的段落之间）。

无法在等式内插入人员提及内容。

endOfSegmentLocation

object (EndOfSegmentLocation)

在页眉、页脚、脚注或文档正文的末尾插入人员提及内容。