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)

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

替换所有文本请求

将符合某个条件的所有文本实例替换为 replace text

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

string

会替换匹配的文本。

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

object (SubstringMatchCriteria)

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

子字符串匹配条件

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

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

string

要在文档中搜索的文本。

matchCase

boolean

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

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

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
}
字段
segmentId

string

营业地点所在的页眉、页脚或脚注的 ID。细分受众群 ID 为空表示文档正文。

index

integer

零索引,采用 UTF-16 代码单元。

索引是以 segmentId 指定的段开头为起点的。

EndOfSegmentLocation

正文、页眉、页脚或脚注末尾的位置。此位置紧接在文档段中的最后一个换行符之前。

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

string

营业地点所在的页眉、页脚或脚注的 ID。细分受众群 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)

要为文本设置的样式。

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

某些文本样式更改可能会导致其他更改,以便反映文档编辑器的行为。如需了解详情,请参阅 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 数字,以 0 为前缀的数字,例如“01”“02”或“03”。位数超过 1 个的数字的前缀不是 0。
  • ROMAN:小写的罗马数字,例如“i”、“ii”或“iii”。
  • UPPERROMAN:大写罗马数字,如“I”、“II”或“III”。
  • LEFTTRIANGLE:指向左边的三角形,对应于 Unicode U+25c4 代码点
枚举
BULLET_GLYPH_PRESET_UNSPECIFIED 项目符号预设未指定。
BULLET_DISC_CIRCLE_SQUARE 一个项目符号列表,其中包含前 3 个列表嵌套级别的 DISCCIRCLESQUARE 项目符号。
BULLET_DIAMONDX_ARROW3D_SQUARE 一个项目符号列表,其中包含前 3 个列表嵌套级别的 DIAMONDXARROW3DSQUARE 项目符号。
BULLET_CHECKBOX 一个项目符号列表,其中包含所有列表嵌套级别的 CHECKBOX 项目符号。
BULLET_ARROW_DIAMOND_DISC 一个项目符号列表,其中包含前 3 个列表嵌套级别的 ARROWDIAMONDDISC 项目符号。
BULLET_STAR_CIRCLE_SQUARE 一个项目符号列表,其中包含前 3 个列表嵌套级别的 STARCIRCLESQUARE 项目符号。
BULLET_ARROW3D_CIRCLE_SQUARE 一个项目符号列表,其中包含前 3 个列表嵌套级别的 ARROW3DCIRCLESQUARE 项目符号。
BULLET_LEFTTRIANGLE_DIAMOND_DISC 一个项目符号列表,其中包含前 3 个列表嵌套级别的 LEFTTRIANGLEDIAMONDDISC 项目符号。
BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE 一个项目符号列表,其中包含前 3 个列表嵌套级别的 DIAMONDXHOLLOWDIAMONDSQUARE 项目符号。
BULLET_DIAMOND_CIRCLE_SQUARE 一个项目符号列表,其中包含前 3 个列表嵌套级别的 DIAMONDCIRCLESQUARE 项目符号。
NUMBERED_DECIMAL_ALPHA_ROMAN 一个编号列表,包含前 3 个列表嵌套级别对应的 DECIMALALPHAROMAN 数字字形,后跟句点。
NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS 一个编号列表,包含前 3 个列表嵌套级别的 DECIMALALPHAROMAN 数字字形,后跟圆括号。
NUMBERED_DECIMAL_NESTED 一个编号列表,包含 DECIMAL 个数字字形(以英文句点分隔),其中每个嵌套级别均使用上一个嵌套级别的字形作为前缀。例如:“1”。“1.1.”、“2.”、“2.2.”
NUMBERED_UPPERALPHA_ALPHA_ROMAN 一个编号列表,包含前 3 个列表嵌套级别对应的 UPPERALPHAALPHAROMAN 数字字形,后跟句点。
NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL 一个编号列表,包含前 3 个列表嵌套级别对应的 UPPERROMANUPPERALPHADECIMAL 数字字形,后跟句点。
NUMBERED_ZERODECIMAL_ALPHA_ROMAN 一个编号列表,包含前 3 个列表嵌套级别对应的 ZERODECIMALALPHAROMAN 数字字形,后跟句点。

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 表示法
{

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

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)

表格在文档中开始的位置。指定后,更新将应用于表中的所有单元格。

表范围

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

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

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

包含表格单元格位置 = (tableStartLocation, rows = 0,column = 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

表范围的列 span。

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"

替换图片请求

用新图片替换现有图片。

替换映像会移除现有映像中的某些 image effects,以便反映文档编辑器的行为。

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

string

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

uri

string

新图片的 URI。

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

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

imageReplaceMethod

enum (ImageReplaceMethod)

替换方法。

ImageReplaceMethod

图片替换方法。

枚举
IMAGE_REPLACE_METHOD_UNSPECIFIED 未指定图片替换方法。不得使用此值。
CENTER_CROP 缩放图片并使其居中,以填充原始图片的边界。图片可能会被剪裁,以填充原始图片的边界。图片的渲染尺寸将与原始图片相同。

UpdateDocumentStyleRequest

更新 DocumentStyle

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

object (DocumentStyle)

要为文档设置的样式。

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

fields

string (FieldMask format)

应更新的字段。

必须至少指定一个字段。根隐式意味着 documentStyle,不应指定。单个 "*" 可用作列出每个字段的简写形式。

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

MergeTableCellsRequest

合并 Table 中的单元格。

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

object (TableRange)

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

被合并的单元格中的任何文本都会串联起来,并存储在相应范围的“head”单元格中。这是内容方向从左到右时范围的左上角单元格,否则是范围的右上角单元格。

如果范围为非矩形(在某些情况下,如果范围涵盖已合并的单元格或表格为非矩形),则会返回 400 错误请求错误。

UnmergeTableCellsRequest

取消合并 Table 中的单元格。

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

object (TableRange)

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

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

如果任何合并的单元格中有文本,该文本会保留在未合并单元格的“头”单元格中。“方向”单元格是指内容方向为从左到右时的左上角单元格,否则为右上角单元格。

CreateHeaderRequest

创建 Header。新标头将应用于 SectionStyleSectionBreak 的位置(如果已指定),否则将应用于 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)

SectionBreak 的位置,紧接在此页脚对应的 SectionStyle 之前的部分。如果此政策未设置或引用文档中的第一个分节符,页脚会应用于文档样式。

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 字段必须为空。

替换名称范围请求

将指定的 NamedRangeNamedRanges 的内容替换为指定的替换内容。

请注意,一个 NamedRange 可能由多个不连续的 ranges 组成。在这种情况下,系统只会替换第一个范围中的内容。其他范围及其内容将被删除。

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

JSON 表示法
{

  // 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.
}
字段
联合字段 replacement_content。用于替换命名范围中现有内容的内容。 replacement_content 只能是下列其中一项:
text

string

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

联合字段 named_range_reference。对要替换其内容的指定范围的引用。 named_range_reference 只能是下列其中一项:
namedRangeId

string

内容被替换的命名范围 ID。

如果没有与指定 ID 对应的已命名范围,则会返回 400 bad 请求错误。

namedRangeName

string

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

如果有多个具有指定名称的 named ranges,则每个名称的内容都将被替换。如果没有具有指定名称的命名范围,则该请求将为空操作。

UpdateSectionStyleRequest

更新 SectionStyle

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

object (Range)

样式部分重叠范围。

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

sectionStyle

object (SectionStyle)

要为部分设置的样式。

某些部分样式更改可能会导致其他更改,以便反映文档编辑器的行为。如需了解详情,请参阅 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
}
字段
headerId

string

要删除的标头的 ID。如果在 DocumentStyle 上定义此标头,系统会移除对该标头的引用,导致文档的第一部分没有该类型的标头。如果此标头是在 SectionStyle 上定义的,则对此标头的引用将被移除,且该类型的标头现在会从上一部分中继续。

DeleteFooterRequest

从文档中删除 Footer

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

string

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

PinTableHeaderRowsRequest

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

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

object (Location)

表在文档中开始的位置。

pinnedHeaderRowsCount

integer

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