- 资源:Document
- 正文
- StructuralElement
- 段落
- ParagraphElement
- TextRun
- TextStyle
- OptionalColor
- 颜色
- RgbColor
- 维度
- 单位
- WeightedFontFamily
- BaselineOffset
- 链接
- SuggestedTextStyle
- TextStyleSuggestionState
- 自动文字
- 类型
- PageBreak
- ColumnBreak
- FootnoteReference
- HorizontalRule
- 等式
- InlineObjectElement
- Person
- PersonProperties
- RichLink
- RichLinkProperties
- ParagraphStyle
- NamedStyleType
- 对齐方式
- ContentDirection
- SpacingMode
- ParagraphBorder
- DashStyle
- TabStop
- TabStopAlignment
- 着色
- SuggestedParagraphStyle
- ParagraphStyleSuggestionState
- ShadingSuggestionState
- 要点
- SuggestedBullet
- BulletSuggestionState
- ObjectReferences
- SectionBreak
- SectionStyle
- SectionColumnProperties
- ColumnSeparatorStyle
- 区块类型
- 表
- TableRow
- TableCell
- TableCellStyle
- TableCellBorder
- ContentAlignment
- SuggestedTableCellStyle
- TableCellStyleSuggestionState
- TableRowStyle
- SuggestedTableRowStyle
- TableRowStyleSuggestionState
- TableStyle
- TableColumnProperties
- 宽度类型
- TableOfContents
- 标题
- 页脚
- 脚注
- DocumentStyle
- 后台
- 大小
- SuggestedDocumentStyle
- DocumentStyleSuggestionState
- BackgroundSuggestionState
- SizeSuggestionState
- NamedStyles
- NamedStyle
- SuggestedNamedStyles
- NamedStylesSuggestionState
- NamedStyleSuggestionState
- 列表
- ListProperties
- NestingLevel
- 项目符号对齐
- 字形类型
- SuggestedListProperties
- ListPropertiesSuggestionState
- NestingLevelSuggestionState
- NamedRanges
- NamedRange
- 范围
- SuggestionsViewMode
- InlineObject
- InlineObjectProperties
- EmbeddedObject
- EmbeddedDrawingProperties
- ImageProperties
- CropProperties
- EmbeddedObjectBorder
- PropertyState
- LinkedContentReference
- SheetsChartReference
- SuggestedInlineObjectProperties
- InlineObjectPropertiesSuggestionState
- EmbeddedObjectSuggestionState
- EmbeddedDrawingPropertiesSuggestionState
- ImagePropertiesSuggestionState
- CropPropertiesSuggestionState
- EmbeddedObjectBorderSuggestionState
- LinkedContentReferenceSuggestionState
- SheetsChartReferenceSuggestionState
- PositionedObject
- PositionedObjectProperties
- PositionedObjectPositioning
- PositionedObjectLayout
- SuggestedPositionedObjectProperties
- PositionedObjectPropertiesSuggestionState
- PositionedObjectPositioningSuggestionState
- 方法
资源:Document
Google 文档。
JSON 表示法 |
---|
{ "documentId": string, "title": string, "body": { object ( |
字段 | |
---|---|
documentId |
仅供输出。文档的 ID。 |
title |
文档的标题。 |
body |
仅供输出。文档的正文。 |
headers |
仅供输出。文档中的标头,由标头 ID 键控。 |
footers |
仅供输出。文档中的页脚,由页脚 ID 键控。 |
footnotes |
仅供输出。文档中的脚注,以脚注 ID 为键。 |
documentStyle |
仅供输出。文档的样式。 |
suggestedDocumentStyleChanges |
仅供输出。对文档样式建议的更改,由建议 ID 键控。 |
namedStyles |
仅供输出。文档的已命名样式。 |
suggestedNamedStylesChanges |
仅供输出。对文档的命名样式建议的更改,由建议 ID 键控。 |
lists |
仅供输出。文档中的列表,由列表 ID 键控。 |
namedRanges |
仅供输出。文档中的命名范围,按名称进行键控。 |
revisionId |
仅供输出。文档的修订版本 ID。可用于更新请求,以指定要将更新应用到文档的哪个修订版本,以及如果文档在对该修订版本进行编辑后,该请求应采取何种行为。仅当用户拥有文档的编辑权限时填充。 修订版本 ID 不是序列号,而是不透明的字符串。修订版本 ID 的格式可能会随时间而变化。我们只保证所返回的修订版本 ID 在返回后的 24 小时内有效,并且无法在用户之间共享。如果两次调用之间的修订版本 ID 保持不变,则文档不会更改。相反,如果 ID 发生更改(针对同一文档和用户),则通常表示文档已更新。但是,ID 发生更改也可能由内部因素(例如 ID 格式更改)导致。 |
suggestionsViewMode |
仅供输出。应用于文档的建议视图模式。 注意:编辑文档时,必须基于带有 |
inlineObjects |
仅供输出。文档中的内嵌对象,由对象 ID 键控。 |
positionedObjects |
仅供输出。文档中已定位的对象,由对象 ID 键控。 |
正文
文档正文。
JSON 表示法 |
---|
{
"content": [
{
object ( |
字段 | |
---|---|
content[] |
正文的内容。 正文内容的索引从零开始。 |
结构元素
StructuralElement 描述的是为文档提供结构的内容。
JSON 表示法 |
---|
{ "startIndex": integer, "endIndex": integer, // Union field |
字段 | |
---|---|
startIndex |
此结构元素的起始索引(从零开始),采用 UTF-16 代码单元。 |
endIndex |
此结构元素的结束索引(从零开始,不含该索引),采用 UTF-16 代码单元。 |
联合字段 content 。结构元素的内容。content 只能是下列其中一项: |
|
paragraph |
一种类型的结构元素。 |
sectionBreak |
结构元素的分节类型。 |
table |
结构元素的表格类型。 |
tableOfContents |
结构元素的目录类型。 |
段落
表示段落的 StructuralElement
。段落是以换行符结束的一系列内容。
JSON 表示法 |
---|
{ "elements": [ { object ( |
字段 | |
---|---|
elements[] |
段落内容,细分为各个组成部分。 |
paragraphStyle |
此段落的样式。 |
suggestedParagraphStyleChanges |
建议的段落样式会更改为此段落,由建议 ID 键控。 |
bullet |
此段落的项目符号。如果没有显示,则表示段落不属于列表。 |
suggestedBulletChanges |
对此段落的项目符号的更改建议。 |
positionedObjectIds[] |
绑定到此段落的已定位对象的 ID。 |
suggestedPositionedObjectIds |
建议附加到此段落的定位对象的 ID,由建议 ID 键控。 |
段落元素
ParagraphElement 描述 Paragraph
中的内容。
JSON 表示法 |
---|
{ "startIndex": integer, "endIndex": integer, // Union field |
字段 | |
---|---|
startIndex |
此段落元素的起始索引(从零开始),采用 UTF-16 代码单元。 |
endIndex |
此段落元素的结束索引(不含基本零值),采用 UTF-16 代码单元。 |
联合字段 content 。段落元素的内容。content 只能是下列其中一项: |
|
textRun |
文本运行段落元素。 |
autoText |
自动文本段落元素。 |
pageBreak |
分页符段落元素。 |
columnBreak |
分栏符段落元素。 |
footnoteReference |
脚注引用段落元素。 |
horizontalRule |
水平规则段落元素。 |
equation |
等式段落元素。 |
inlineObjectElement |
内联对象段落元素。 |
person |
链接到某人或电子邮件地址的段落元素。 |
richLink |
链接到 Google 资源(例如 Google 云端硬盘中的文件、YouTube 视频或日历活动)的段落元素。 |
TextRun
表示所有具有相同样式的一系列文本的 ParagraphElement
。
JSON 表示法 |
---|
{ "content": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
字段 | |
---|---|
content |
此运行的文本。 运行中的所有非文本元素都会替换为 Unicode 字符 U+E907。 |
suggestedInsertionIds[] |
建议的插入 ID。如果是嵌套建议的更改, |
suggestedDeletionIds[] |
建议的删除 ID。如果为空,则表示没有建议删除此内容。 |
textStyle |
此运行的文本样式。 |
suggestedTextStyleChanges |
建议的文本样式将更改为此运行,由建议 ID 键控。 |
TextStyle
表示可应用于文本的样式。
继承的文本样式在此消息中表示为未设置的字段。文本样式的父项取决于文本样式的定义位置:
Paragraph
中文本的 TextStyle 继承自段落的相应named style type
。named style
上的 TextStyle 继承自normal text
已命名的样式。normal text
已命名样式的 TextStyle 继承自文档编辑器中的默认文本样式。- 表中包含的
Paragraph
元素的 TextStyle 可能会从表样式继承其文本样式。
如果文本样式未从父项继承,则取消设置字段会将样式还原为与文档编辑器中的默认值相匹配的值。
JSON 表示法 |
---|
{ "bold": boolean, "italic": boolean, "underline": boolean, "strikethrough": boolean, "smallCaps": boolean, "backgroundColor": { object ( |
字段 | |
---|---|
bold |
文本是否以粗体呈现。 |
italic |
文本是否为斜体。 |
underline |
文本是否带有下划线。 |
strikethrough |
是否删除文本。 |
smallCaps |
文字是否采用小大写字母。 |
backgroundColor |
文本的背景颜色。如果设置了此项,颜色为 RGB 颜色或透明色,具体取决于 |
foregroundColor |
文本的前景颜色。如果设置了此项,颜色为 RGB 颜色或透明色,具体取决于 |
fontSize |
文本的字体大小。 |
weightedFontFamily |
文本的字体系列和渲染粗细。 如果更新请求同时指定 如果未设置 如果设置了 |
baselineOffset |
文本相对于正常位置的垂直偏移。 基线偏移为 |
link |
文本的超链接目的地。如果未设置,则没有链接。链接不会沿用父文本。 更改更新请求中的链接会导致该范围的文本样式发生一些其他更改:
|
可选颜色
一种颜色,可完全不透明或完全透明。
JSON 表示法 |
---|
{
"color": {
object ( |
字段 | |
---|---|
color |
如果设置,将用作不透明颜色。如果未设置,则此属性表示透明颜色。 |
颜色
纯色。
JSON 表示法 |
---|
{
"rgbColor": {
object ( |
字段 | |
---|---|
rgbColor |
RGB 颜色值。 |
颜色
RGB 颜色。
JSON 表示法 |
---|
{ "red": number, "green": number, "blue": number } |
字段 | |
---|---|
red |
颜色的红色分量,介于 0.0 到 1.0 之间。 |
green |
颜色的绿色分量,介于 0.0 到 1.0 之间。 |
blue |
颜色的蓝色分量,介于 0.0 到 1.0 之间。 |
维度
指定单位内单个方向的量级。
JSON 表示法 |
---|
{
"magnitude": number,
"unit": enum ( |
字段 | |
---|---|
magnitude |
震级。 |
unit |
量级的单位。 |
单位
度量单位。
枚举 | |
---|---|
UNIT_UNSPECIFIED |
单位未知。 |
PT |
点,1/72 英寸。 |
WeightedFontFamily
表示字体系列和文本粗细。
JSON 表示法 |
---|
{ "fontFamily": string, "weight": integer } |
字段 | |
---|---|
fontFamily |
文本的字体系列。 字体系列可以是文档中的“字体”菜单或 Google Fonts 中的任何字体。如果字体名称无法识别,文本将采用 |
weight |
字体粗细。此字段可具有 默认值为 字体粗细仅构成所呈现字体粗细的一个组成部分。在考虑继承之后,
|
基准偏移
文本相对于正常位置垂直偏移的方式。
枚举 | |
---|---|
BASELINE_OFFSET_UNSPECIFIED |
文本的基线偏移量继承自父项。 |
NONE |
文本没有垂直偏移。 |
SUPERSCRIPT |
文本向上垂直偏移(上标)。 |
SUBSCRIPT |
文本向下垂直偏移(下标)。 |
链接
对文档其他部分或外部网址资源的引用。
JSON 表示法 |
---|
{ // Union field |
字段 | |
---|---|
联合字段 destination 。链接目的地。destination 只能是下列其中一项: |
|
url |
外部网址。 |
bookmarkId |
此文档中的书签的 ID。 |
headingId |
此文档中标题的 ID。 |
SuggestedTextStyle
建议的对 TextStyle
的更改。
JSON 表示法 |
---|
{ "textStyle": { object ( |
字段 | |
---|---|
textStyle |
仅包含此建议中所做更改的 |
textStyleSuggestionState |
一个掩码,用于指示此建议中基础 |
TextStyleSuggestionState
一个掩码,用于指示此建议中基础 TextStyle
上的哪些字段已更改。对于任何设置为 true 的字段,系统都会提供一个新的建议值。
JSON 表示法 |
---|
{ "boldSuggested": boolean, "italicSuggested": boolean, "underlineSuggested": boolean, "strikethroughSuggested": boolean, "smallCapsSuggested": boolean, "backgroundColorSuggested": boolean, "foregroundColorSuggested": boolean, "fontSizeSuggested": boolean, "weightedFontFamilySuggested": boolean, "baselineOffsetSuggested": boolean, "linkSuggested": boolean } |
字段 | |
---|---|
boldSuggested |
指示是否有对 |
italicSuggested |
指示是否有对 |
underlineSuggested |
指示是否有对 |
strikethroughSuggested |
指示是否有对 |
smallCapsSuggested |
指示是否有对 |
backgroundColorSuggested |
指示是否有对 |
foregroundColorSuggested |
指示是否有对 |
fontSizeSuggested |
指示是否有对 |
weightedFontFamilySuggested |
指示是否有对 |
baselineOffsetSuggested |
指示是否有对 |
linkSuggested |
指示是否有对 |
自动文字
ParagraphElement
,表示文本中的某个位置,该位置会动态替换为可随时间变化的内容,例如页码。
JSON 表示法 |
---|
{ "type": enum ( |
字段 | |
---|---|
type |
此自动文本的类型。 |
suggestedInsertionIds[] |
建议的插入 ID。如果是嵌套建议的更改, |
suggestedDeletionIds[] |
建议的删除 ID。如果为空,则表示没有建议删除此内容。 |
textStyle |
此自动文本的文本样式。 |
suggestedTextStyleChanges |
建议的文本样式会更改为此自动文本,由建议 ID 键控。 |
类型
自动文本的类型。
枚举 | |
---|---|
TYPE_UNSPECIFIED |
未指定的自动文本类型。 |
PAGE_NUMBER |
表示当前页码的自动文本类型。 |
PAGE_COUNT |
表示文档中总页数的自动文本类型。 |
分页符
表示分页符的 ParagraphElement
。分页符会使后续文本从下一页顶部开始。
JSON 表示法 |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
字段 | |
---|---|
suggestedInsertionIds[] |
建议的插入 ID。如果是嵌套建议的更改, |
suggestedDeletionIds[] |
建议的删除 ID。如果为空,则表示没有建议删除此内容。 |
textStyle |
此 PageBreak 的文本样式。 与文本内容(如文本行和脚注引用)类似,分页符的文本样式可能会影响内容布局以及在其旁边插入的文本的样式。 |
suggestedTextStyleChanges |
建议的文本样式将更改此 PageBreak,由建议 ID 键控。 |
分栏符
表示分栏符的 ParagraphElement
。分栏符会将后续文本从下一列的顶部开始。
JSON 表示法 |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
字段 | |
---|---|
suggestedInsertionIds[] |
建议的插入 ID。如果是嵌套建议的更改, |
suggestedDeletionIds[] |
建议的删除 ID。如果为空,则表示没有建议删除此内容。 |
textStyle |
此 ColumnBreak 的文本样式。 与文本内容(如文本行和脚注引用)类似,分栏符的文本样式可能会影响内容布局以及在其旁边插入的文本的样式。 |
suggestedTextStyleChanges |
建议的文本样式将更改为此 ColumnBreak,由建议 ID 键控。 |
脚注引用
表示脚注引用的 ParagraphElement
。脚注引用是使用数字呈现的内嵌内容,用于标识脚注。
JSON 表示法 |
---|
{ "footnoteId": string, "footnoteNumber": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
字段 | |
---|---|
footnoteId |
包含此脚注引用内容的 |
footnoteNumber |
此脚注的呈现编号。 |
suggestedInsertionIds[] |
建议的插入 ID。如果是嵌套建议的更改, |
suggestedDeletionIds[] |
建议的删除 ID。如果为空,则表示没有建议删除此内容。 |
textStyle |
此 FootnoteReference 的文本样式。 |
suggestedTextStyleChanges |
建议的文本样式会更改为此 FootnoteReference,由建议 ID 键控。 |
HorizontalRule
表示水平线的 ParagraphElement
。
JSON 表示法 |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
字段 | |
---|---|
suggestedInsertionIds[] |
建议的插入 ID。如果是嵌套建议的更改, |
suggestedDeletionIds[] |
建议的删除 ID。如果为空,则表示没有建议删除此内容。 |
textStyle |
此 HorizontalRule 的文本样式。 与文本内容(如文本行和脚注引用)类似,水平线的文本样式可能会影响内容布局以及在其旁边插入的文本的样式。 |
suggestedTextStyleChanges |
建议的文本样式更改为此 HorizontalRule,由建议 ID 键控。 |
方程
表示等式的 ParagraphElement
。
JSON 表示法 |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ] } |
字段 | |
---|---|
suggestedInsertionIds[] |
建议的插入 ID。如果是嵌套建议的更改, |
suggestedDeletionIds[] |
建议的删除 ID。如果为空,则表示没有建议删除此内容。 |
InlineObjectElement
一个包含 InlineObject
的 ParagraphElement
。
JSON 表示法 |
---|
{ "inlineObjectId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
字段 | |
---|---|
inlineObjectId |
此元素包含的 |
suggestedInsertionIds[] |
建议的插入 ID。如果是嵌套建议的更改, |
suggestedDeletionIds[] |
建议的删除 ID。如果为空,则表示没有建议删除此内容。 |
textStyle |
此 InlineObjectElement 的文本样式。 与文本内容(如文本行和脚注引用)类似,内嵌对象元素的文本样式可能会影响内容布局以及在其旁边插入的文本的样式。 |
suggestedTextStyleChanges |
建议的文本样式对此 InlineObject 的更改,由建议 ID 键控。 |
人物
文档中提到的人员或电子邮件地址。提及的人将作为一个不可更改的元素,其中包含人的姓名或电子邮件地址。
JSON 表示法 |
---|
{ "personId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
字段 | |
---|---|
personId |
仅供输出。此关联的唯一 ID。 |
suggestedInsertionIds[] |
将此人链接插入到文档中的建议 ID。如果是嵌套建议的更改(例如,其他用户建议的更改), |
suggestedDeletionIds[] |
从文档中移除此人链接的建议 ID。一个 |
textStyle |
此 |
suggestedTextStyleChanges |
建议的文本样式会更改为此 |
personProperties |
仅供输出。此 |
PersonProperties
关联的 Person
的专用属性。
JSON 表示法 |
---|
{ "name": string, "email": string } |
字段 | |
---|---|
name |
仅供输出。在链接文本中显示人员的姓名,而不是个人的电子邮件地址。 |
email |
仅供输出。与此 |
富媒体链接
指向 Google 资源(例如云端硬盘中的文件、YouTube 视频或日历活动)的链接。
JSON 表示法 |
---|
{ "richLinkId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
字段 | |
---|---|
richLinkId |
仅供输出。此关联的 ID。 |
suggestedInsertionIds[] |
将此链接插入到文档中的建议 ID。如果是嵌套建议的更改(例如,其他用户建议的更改), |
suggestedDeletionIds[] |
从文档中移除此链接的建议 ID。一个 |
textStyle |
此 |
suggestedTextStyleChanges |
建议的文本样式会更改为此 |
richLinkProperties |
仅供输出。此 |
RichLinkProperties
RichLink
的专用属性。
JSON 表示法 |
---|
{ "title": string, "uri": string, "mimeType": string } |
字段 | |
---|---|
title |
仅供输出。链接中显示的 |
uri |
仅供输出。 |
mimeType |
|
ParagraphStyle
应用于整个段落的样式。
继承的段落样式在此消息中表示为未设置的字段。段落样式的父项取决于段落样式的定义位置:
Paragraph
上的 ParagraphStyle 继承自段落的相应named style type
。named style
上的 ParagraphStyle 继承自normal text
已命名的样式。- 已命名样式的
normal text
的 ParagraphStyle 继承自文档编辑器中的默认段落样式。 - 表格中包含的
Paragraph
元素的 ParagraphStyle 可能会从表格样式继承其段落样式。
如果段落样式未从父级继承,则取消设置字段会将样式还原为与文档编辑器中的默认值相匹配的值。
JSON 表示法 |
---|
{ "headingId": string, "namedStyleType": enum ( |
字段 | |
---|---|
headingId |
段落的标题 ID。如果为空,则表示此段落不是标题。 此属性为只读属性。 |
namedStyleType |
段落的已命名样式类型。 由于更新命名的样式类型会影响 ParagraphStyle 中的其他属性,因此,系统会在更新其他属性之前应用已命名的样式类型。 |
alignment |
此段落的文本对齐方式。 |
lineSpacing |
行与行之间的间距,以正常值百分比的形式表示,其中正常值以 100.0 表示。如果未设置,则值将继承自父级。 |
direction |
此段落的文本方向。如果未设置,则值默认为 |
spacingMode |
段落的间距模式。 |
spaceAbove |
段落上方的额外间距。如果未设置,则值将继承自父级。 |
spaceBelow |
段落下方的额外间距。如果未设置,则值将继承自父级。 |
borderBetween |
此段落与下一个和上一个段落之间的边框。如果未设置,则值将继承自父级。 当相邻段落具有相同的边框和缩进属性时,将呈现段落之间的边框。 无法部分更新段落边框。更改段落边框时,必须完整地指定新边框。 |
borderTop |
此段落顶部的边框。如果未设置,则值将继承自父级。 当以上段落具有不同的边框和缩进属性时,系统会呈现上边框。 无法部分更新段落边框。更改段落边框时,必须完整地指定新边框。 |
borderBottom |
此段落底部的边框。如果未设置,则值将继承自父级。 当以下段落具有不同的边框和缩进属性时,系统会渲染下边框。 无法部分更新段落边框。更改段落边框时,必须完整地指定新边框。 |
borderLeft |
此段落左侧的边框。如果未设置,则值将继承自父级。 无法部分更新段落边框。更改段落边框时,必须完整地指定新边框。 |
borderRight |
此段落右边的边框。如果未设置,则值将继承自父级。 无法部分更新段落边框。更改段落边框时,必须完整地指定新边框。 |
indentFirstLine |
段落第一行的缩进量。如果未设置,则值将继承自父级。 |
indentStart |
与文本开头相对应的段落一侧的缩进量(基于当前段落方向)。如果未设置,则值将继承自父级。 |
indentEnd |
与文本末尾对应的段落的缩进量(基于当前段落方向)。如果未设置,则值将继承自父级。 |
tabStops[] |
此段落的制表符列表。制表位列表不沿用。 此属性为只读属性。 |
keepLinesTogether |
段落的所有行应在同一页面或同一列中布局(如果可能)。如果未设置,则值将继承自父级。 |
keepWithNext |
应尽可能将这段段落的至少一部分内容放在与下一段相同的页面或列中,如果未设置,则值将继承自父级。 |
avoidWidowAndOrphan |
是否针对段落避免遗漏或孤立出现。如果未设置,则值将继承自父级。 |
shading |
段落的阴影。如果未设置,则值将继承自父级。 |
pageBreakBefore |
当前段落是否应始终从页面的开头开始。如果未设置,则值将继承自父级。 如果尝试为不受支持的区域(包括 |
NamedStyleType
已命名样式的类型。
枚举 | |
---|---|
NAMED_STYLE_TYPE_UNSPECIFIED |
未指定已命名样式的类型。 |
NORMAL_TEXT |
普通文本。 |
TITLE |
标题。 |
SUBTITLE |
副标题。 |
HEADING_1 |
标题 1. |
HEADING_2 |
标题 2. |
HEADING_3 |
标题 3. |
HEADING_4 |
4 级标题。 |
HEADING_5 |
5 级标题。 |
HEADING_6 |
标题 6. |
对齐
段落的文本对齐类型。
枚举 | |
---|---|
ALIGNMENT_UNSPECIFIED |
段落对齐方式继承自父级。 |
START |
段落会与行首对齐。对于 LTR 文本,为左对齐,否则为右对齐。 |
CENTER |
段落居中。 |
END |
段落会与行尾对齐。对于 LTR 文本,为右对齐,否则为左对齐。 |
JUSTIFIED |
该段落已两端对齐。 |
内容方向
路线内容可流入。
枚举 | |
---|---|
CONTENT_DIRECTION_UNSPECIFIED |
未指定内容方向。 |
LEFT_TO_RIGHT |
内容从左向右。 |
RIGHT_TO_LEFT |
内容从右向左。 |
间距模式
不同的段落间距模式。
枚举 | |
---|---|
SPACING_MODE_UNSPECIFIED |
间距模式继承自父级。 |
NEVER_COLLAPSE |
段落间距始终会呈现。 |
COLLAPSE_LISTS |
系统会在列表元素之间跳过段落间距。 |
ParagraphBorder
段落周围的边框。
JSON 表示法 |
---|
{ "color": { object ( |
字段 | |
---|---|
color |
边框的颜色。 |
width |
边框的宽度。 |
padding |
边框的内边距。 |
dashStyle |
边框的短划线样式。 |
短划线样式
可用于渲染线性几何图形的短划线的类型。这些值基于“ST_PresetLineDashVal”简单类型,如“Office Open XML 文件格式 - 基础知识和标记语言参考”第 20.1.10.48 节所述(ECMA-376 第 4 版第 1 部分)。
枚举 | |
---|---|
DASH_STYLE_UNSPECIFIED |
未指定短划线样式。 |
SOLID |
实线。对应于 ECMA-376 ST_PresetLineDashVal 值“visible”。这是默认的短划线样式。 |
DOT |
虚线。对应于 ECMA-376 ST_PresetLineDashVal 值“dot”。 |
DASH |
虚线。对应于 ECMA-376 ST_PresetLineDashVal 值“dash”。 |
TabStop
段落中的制表位。
JSON 表示法 |
---|
{ "offset": { object ( |
字段 | |
---|---|
offset |
此制表位与起始外边距之间的偏移量。 |
alignment |
此制表位的对齐方式。如果未设置,则值默认为 |
TabStopAlignment
制表位的对齐方式。
枚举 | |
---|---|
TAB_STOP_ALIGNMENT_UNSPECIFIED |
未指定制表位对齐。 |
START |
制表位与行首对齐。这是默认值。 |
CENTER |
制表位与线条中心对齐。 |
END |
制表位与行尾对齐。 |
阴影
段落阴影。
JSON 表示法 |
---|
{
"backgroundColor": {
object ( |
字段 | |
---|---|
backgroundColor |
此段落阴影的背景颜色。 |
SuggestedParagraphStyle(建议的段落样式)
建议的对 ParagraphStyle
的更改。
JSON 表示法 |
---|
{ "paragraphStyle": { object ( |
字段 | |
---|---|
paragraphStyle |
仅包含此建议中所做更改的 |
paragraphStyleSuggestionState |
一个掩码,用于指示此建议中基础 |
ParagraphStyleSuggestionState
一个掩码,用于指示此建议中基础 ParagraphStyle
上的哪些字段已更改。对于任何设置为 true 的字段,系统都会提供一个新的建议值。
JSON 表示法 |
---|
{
"headingIdSuggested": boolean,
"namedStyleTypeSuggested": boolean,
"alignmentSuggested": boolean,
"lineSpacingSuggested": boolean,
"directionSuggested": boolean,
"spacingModeSuggested": boolean,
"spaceAboveSuggested": boolean,
"spaceBelowSuggested": boolean,
"borderBetweenSuggested": boolean,
"borderTopSuggested": boolean,
"borderBottomSuggested": boolean,
"borderLeftSuggested": boolean,
"borderRightSuggested": boolean,
"indentFirstLineSuggested": boolean,
"indentStartSuggested": boolean,
"indentEndSuggested": boolean,
"keepLinesTogetherSuggested": boolean,
"keepWithNextSuggested": boolean,
"avoidWidowAndOrphanSuggested": boolean,
"shadingSuggestionState": {
object ( |
字段 | |
---|---|
headingIdSuggested |
指示是否有对 |
namedStyleTypeSuggested |
指示是否有对 |
alignmentSuggested |
指示是否有对 |
lineSpacingSuggested |
指示是否有对 |
directionSuggested |
指示是否有对 |
spacingModeSuggested |
指示是否有对 |
spaceAboveSuggested |
指示是否有对 |
spaceBelowSuggested |
指示是否有对 |
borderBetweenSuggested |
指示是否有对 |
borderTopSuggested |
指示是否有对 |
borderBottomSuggested |
指示是否有对 |
borderLeftSuggested |
指示是否有对 |
borderRightSuggested |
指示是否有对 |
indentFirstLineSuggested |
指示是否有对 |
indentStartSuggested |
指示是否有对 |
indentEndSuggested |
指示是否有对 |
keepLinesTogetherSuggested |
指示是否有对 |
keepWithNextSuggested |
指示是否有对 |
avoidWidowAndOrphanSuggested |
指示是否有对 |
shadingSuggestionState |
一个掩码,用于指示此建议中 |
pageBreakBeforeSuggested |
指示是否有对 |
ShadingSuggestionState
一个掩码,用于指示在此建议的更改中基本 Shading
中的哪些字段已更改。对于任何设置为 true 的字段,系统都会提供一个新的建议值。
JSON 表示法 |
---|
{ "backgroundColorSuggested": boolean } |
字段 | |
---|---|
backgroundColorSuggested |
指示是否有对 |
子弹图
描述段落的项目符号。
JSON 表示法 |
---|
{
"listId": string,
"nestingLevel": integer,
"textStyle": {
object ( |
字段 | |
---|---|
listId |
此段落所属列表的 ID。 |
nestingLevel |
此段落在列表中嵌套的级别。 |
textStyle |
应用于此项目符号的段落专用文本样式。 |
建议的项目符号
建议的对 Bullet
的更改。
JSON 表示法 |
---|
{ "bullet": { object ( |
字段 | |
---|---|
bullet |
仅包含此建议中所做更改的 |
bulletSuggestionState |
一个掩码,用于指示此建议中基础 |
BulletSuggestionState
一个掩码,用于指示此建议中基础 Bullet
上的哪些字段已更改。对于任何设置为 true 的字段,系统都会提供一个新的建议值。
JSON 表示法 |
---|
{
"listIdSuggested": boolean,
"nestingLevelSuggested": boolean,
"textStyleSuggestionState": {
object ( |
字段 | |
---|---|
listIdSuggested |
指示是否有对 |
nestingLevelSuggested |
指示是否有对 |
textStyleSuggestionState |
一个掩码,用于指示此建议中 |
对象引用
对象 ID 的集合。
JSON 表示法 |
---|
{ "objectIds": [ string ] } |
字段 | |
---|---|
objectIds[] |
对象 ID。 |
分节符
表示分节符的 StructuralElement
。版块是指具有相同 SectionStyle
的一系列内容。分节符表示新小节的开始,而小节样式会应用于分节符之后的小节。
文档正文始终以分节符开头。
JSON 表示法 |
---|
{
"suggestedInsertionIds": [
string
],
"suggestedDeletionIds": [
string
],
"sectionStyle": {
object ( |
字段 | |
---|---|
suggestedInsertionIds[] |
建议的插入 ID。如果是嵌套建议的更改, |
suggestedDeletionIds[] |
建议的删除 ID。如果为空,则表示没有建议删除此内容。 |
sectionStyle |
此分节符之后的小节样式。 |
版块样式
应用于区段的样式。
JSON 表示法 |
---|
{ "columnProperties": [ { object ( |
字段 | |
---|---|
columnProperties[] |
版块的列属性。 如果为空,则此部分包含一列具有文档编辑器中的默认属性。每个版块最多只能包含 3 列。 更新此属性时,需要设置具体的值。取消设置此属性将导致 400 bad request 错误。 |
columnSeparatorStyle |
列分隔符的样式。 即使相应部分中只有一列,您也可以设置此样式。 更新此属性时,需要设置具体的值。取消设置此属性会导致 400 错误请求错误。 |
contentDirection |
此版块的内容方向。如果未设置,则值默认为 更新此属性时,需要设置具体的值。取消设置此属性会导致 400 错误请求错误。 |
marginTop |
相应部分的上边距。如果未设置,则值默认为 DocumentStyle 的 更新此属性时,需要设置具体的值。取消设置此属性会导致 400 错误请求错误。 |
marginBottom |
此版块的下边距。如果未设置,则值默认为 DocumentStyle 的 更新此属性时,需要设置具体的值。取消设置此属性会导致 400 错误请求错误。 |
marginRight |
相应部分的右页外边距。如果未设置,则值默认为 DocumentStyle 的 更新此属性时,需要设置具体的值。取消设置此属性会导致 400 错误请求错误。 |
marginLeft |
该部分的左侧页边距。如果未设置,则值默认为 DocumentStyle 的 更新此属性时,需要设置具体的值。取消设置此属性会导致 400 错误请求错误。 |
marginHeader |
部分的标题外边距。如果未设置,则值默认为 DocumentStyle 的 更新此属性时,需要设置具体的值。取消设置此属性会导致 400 错误请求错误。 |
marginFooter |
部分的页脚外边距。如果未设置,则值默认为 DocumentStyle 的 更新此属性时,需要设置具体的值。取消设置此属性会导致 400 错误请求错误。 |
sectionType |
仅供输出。部分的类型。 |
defaultHeaderId |
默认标头的 ID。如果未设置,则该值将继承自上一个 此属性为只读属性。 |
defaultFooterId |
默认页脚的 ID。如果未设置,则该值将继承自上一个 此属性为只读属性。 |
firstPageHeaderId |
仅用于章节第一页的标题 ID。如果 此属性为只读属性。 |
firstPageFooterId |
仅用于章节第一页的页脚 ID。如果 此属性为只读属性。 |
evenPageHeaderId |
仅用于偶数页的标题 ID。如果 DocumentStyle 的 此属性为只读属性。 |
evenPageFooterId |
仅用于偶数页的页脚 ID。如果 DocumentStyle 的 此属性为只读属性。 |
useFirstPageHeaderFooter |
指明是否使用该版块第一页的首页页眉 / 页脚 ID。如果未设置,它将从 DocumentStyle 的 更新此属性时,需要设置具体的值。取消设置此属性会导致 400 错误请求错误。 |
pageNumberStart |
开始计算该版块页数的页码。如果未设置,页面编号会从上一部分继续。如果在第一个 更新此属性时,需要设置具体的值。取消设置此属性会导致 400 错误请求错误。 |
flipPageOrientation |
可选。指示是否在此部分翻转 DocumentStyle 的 更新此属性时,需要设置具体的值。取消设置此属性会导致 400 错误请求错误。 |
版块列属性
适用于部分列的属性。
JSON 表示法 |
---|
{ "width": { object ( |
字段 | |
---|---|
width |
仅供输出。列宽。 |
paddingEnd |
列末尾的内边距。 |
ColumnSeparatorStyle
列之间的列分隔符的样式。
枚举 | |
---|---|
COLUMN_SEPARATOR_STYLE_UNSPECIFIED |
未指定的列分隔符样式。 |
NONE |
各列之间没有列分隔符。 |
BETWEEN_EACH_COLUMN |
在每列之间渲染列分隔符。 |
SectionType
表示当前部分起始部分相对于上一部分的位置。
枚举 | |
---|---|
SECTION_TYPE_UNSPECIFIED |
未指定区段类型。 |
CONTINUOUS |
此部分的起始位置紧跟在上一段落的最后一个段落之后。 |
NEXT_PAGE |
此部分从下一页开始。 |
表
表示表的 StructuralElement
。
JSON 表示法 |
---|
{ "rows": integer, "columns": integer, "tableRows": [ { object ( |
字段 | |
---|---|
rows |
表中的行数。 |
columns |
表中的列数。 表格可能不是矩形,因此某些行可能有不同数量的单元格。 |
tableRows[] |
每行的内容和样式。 |
suggestedInsertionIds[] |
建议的插入 ID。如果是嵌套建议的更改, |
suggestedDeletionIds[] |
建议的删除 ID。如果为空,则表示没有建议删除此内容。 |
tableStyle |
表格的样式。 |
TableRow
Table
中行的内容和样式。
JSON 表示法 |
---|
{ "startIndex": integer, "endIndex": integer, "tableCells": [ { object ( |
字段 | |
---|---|
startIndex |
此行的起始索引(从零开始),采用 UTF-16 代码单元。 |
endIndex |
此行的结束索引(从零开始,不含边界值),采用 UTF-16 代码单元。 |
tableCells[] |
此行中每个单元格的内容和样式。 表格可能不是矩形,因此某些行的单元格数量可能与同一表格中其他行的数量不同。 |
suggestedInsertionIds[] |
建议的插入 ID。如果是嵌套建议的更改, |
suggestedDeletionIds[] |
建议的删除 ID。如果为空,则表示没有建议删除此内容。 |
tableRowStyle |
表格行的样式。 |
suggestedTableRowStyleChanges |
建议的样式更改此行,由建议 ID 键控。 |
TableCell
Table
中单元格的内容和样式。
JSON 表示法 |
---|
{ "startIndex": integer, "endIndex": integer, "content": [ { object ( |
字段 | |
---|---|
startIndex |
此单元格的起始索引(从零开始),采用 UTF-16 代码单元。 |
endIndex |
此单元格的结束索引(从零开始,不含该索引),采用 UTF-16 代码单元。 |
content[] |
单元格的内容。 |
tableCellStyle |
单元格的样式。 |
suggestedInsertionIds[] |
建议的插入 ID。如果是嵌套建议的更改, |
suggestedDeletionIds[] |
建议的删除 ID。如果为空,则表示没有建议删除此内容。 |
suggestedTableCellStyleChanges |
建议的表格单元格样式更改,由建议 ID 键控。 |
TableCellStyle
TableCell
的样式。
继承的表格单元格样式在此消息中表示为未设置的字段。表格单元格样式可以沿用表格的样式。
JSON 表示法 |
---|
{ "rowSpan": integer, "columnSpan": integer, "backgroundColor": { object ( |
字段 | |
---|---|
rowSpan |
单元格的行跨度。 此属性为只读属性。 |
columnSpan |
单元格的列跨度。 此属性为只读属性。 |
backgroundColor |
单元格的背景颜色。 |
borderLeft |
单元格的左边框。 |
borderRight |
单元格的右边框。 |
borderTop |
单元格的上边框。 |
borderBottom |
单元格的下边框。 |
paddingLeft |
单元格的左侧内边距。 |
paddingRight |
单元格的右侧内边距。 |
paddingTop |
单元格的上内边距。 |
paddingBottom |
单元格的底部内边距。 |
contentAlignment |
表格单元格中的内容对齐方式。默认对齐方式与文档编辑器中新建的表格单元格的对齐方式保持一致。 |
表格单元格边框
表格单元格周围的边框。
表格单元格的边框不能是透明的。若要隐藏表格单元格边框,请将宽度设为 0。
JSON 表示法 |
---|
{ "color": { object ( |
字段 | |
---|---|
color |
边框的颜色。 此颜色不能是透明的。 |
width |
边框的宽度。 |
dashStyle |
边框的短划线样式。 |
内容对齐
内容对齐的类型。
派生自“ST_TextAnchoringType”简单类型的一个子集,可在“Office Open XML 文件格式 - 基础知识和标记语言参考”第 20.1.10.59 节(ECMA-376 第 4 版第 1 部分)中找到。
枚举 | |
---|---|
CONTENT_ALIGNMENT_UNSPECIFIED |
未指定的内容对齐方式。内容对齐方式继承自父项(如果存在)。 |
CONTENT_ALIGNMENT_UNSUPPORTED |
内容对齐方式不受支持。 |
TOP |
一种对齐方式,用于将内容与内容容器的顶部对齐。对应于 ECMA-376 ST_TextAnchoringType 't'。 |
MIDDLE |
一种对齐方式,可将内容与内容容器的中间对齐。对应于 ECMA-376 ST_TextAnchoringType“ctr”。 |
BOTTOM |
一种对齐方式,用于将内容与内容容器的底部对齐。对应于 ECMA-376 ST_TextAnchoringType 'b'。 |
SuggestedTableCellStyle
建议的对 TableCellStyle
的更改。
JSON 表示法 |
---|
{ "tableCellStyle": { object ( |
字段 | |
---|---|
tableCellStyle |
仅包含此建议中所做更改的 |
tableCellStyleSuggestionState |
一个掩码,用于指示此建议中基础 |
TableCellStyleSuggestionState
一个掩码,用于指示此建议中基础 TableCellStyle
上的哪些字段已更改。对于任何设置为 true 的字段,系统都会提供一个新的建议值。
JSON 表示法 |
---|
{ "rowSpanSuggested": boolean, "columnSpanSuggested": boolean, "backgroundColorSuggested": boolean, "borderLeftSuggested": boolean, "borderRightSuggested": boolean, "borderTopSuggested": boolean, "borderBottomSuggested": boolean, "paddingLeftSuggested": boolean, "paddingRightSuggested": boolean, "paddingTopSuggested": boolean, "paddingBottomSuggested": boolean, "contentAlignmentSuggested": boolean } |
字段 | |
---|---|
rowSpanSuggested |
指示是否有对 |
columnSpanSuggested |
指示是否有对 |
backgroundColorSuggested |
指示是否有对 |
borderLeftSuggested |
指示是否有对 |
borderRightSuggested |
指示是否有对 |
borderTopSuggested |
指示是否有对 |
borderBottomSuggested |
指示是否有对 |
paddingLeftSuggested |
指示是否有对 |
paddingRightSuggested |
指示是否有对 |
paddingTopSuggested |
指示是否有对 |
paddingBottomSuggested |
指示是否有对 |
contentAlignmentSuggested |
指示是否有对 |
TableRowStyle
应用于表格行的样式。
JSON 表示法 |
---|
{
"minRowHeight": {
object ( |
字段 | |
---|---|
minRowHeight |
行的最小高度。该行在文档编辑器中将以等于或大于此值的高度呈现,以便显示该行单元格中的所有内容。 |
tableHeader |
行是否为表格标题。 |
preventOverflow |
确定行不能跨越页面边界或跨列边界。 |
SuggestedTableRowStyle
建议的对 TableRowStyle
的更改。
JSON 表示法 |
---|
{ "tableRowStyle": { object ( |
字段 | |
---|---|
tableRowStyle |
仅包含此建议中所做更改的 |
tableRowStyleSuggestionState |
一个掩码,用于指示此建议中基础 |
TableRowStyleSuggestionState
一个掩码,用于指示此建议中基础 TableRowStyle
上的哪些字段已更改。对于任何设置为 true 的字段,系统都会提供一个新的建议值。
JSON 表示法 |
---|
{ "minRowHeightSuggested": boolean } |
字段 | |
---|---|
minRowHeightSuggested |
指示是否有对 |
表格样式
应用于表格的样式。
JSON 表示法 |
---|
{
"tableColumnProperties": [
{
object ( |
字段 | |
---|---|
tableColumnProperties[] |
每列的属性。 请注意,在 Google 文档中,表格包含行,行包含单元格,类似于 HTML。因此,您可以在该行的 |
TableColumnProperties
表格中列的属性。
JSON 表示法 |
---|
{ "widthType": enum ( |
字段 | |
---|---|
widthType |
列的宽度类型。 |
width |
列宽。当列的 |
宽度类型
列宽的类型。
枚举 | |
---|---|
WIDTH_TYPE_UNSPECIFIED |
未指定列宽类型。 |
EVENLY_DISTRIBUTED |
列宽在其他均匀分布的列之间均匀分布。 列宽是自动确定的,在计算完具有指定宽度的所有列后,将与表格的剩余宽度相等。 |
FIXED_WIDTH |
固定的列宽。[width][google.apps.docs.v1.TableColumnProperties.width 属性包含列的宽度。 |
目录
表示目录的 StructuralElement
。
JSON 表示法 |
---|
{
"content": [
{
object ( |
字段 | |
---|---|
content[] |
目录的内容。 |
suggestedInsertionIds[] |
建议的插入 ID。如果是嵌套建议的更改, |
suggestedDeletionIds[] |
建议的删除 ID。如果为空,则表示没有建议删除此内容。 |
标题
文档标题。
JSON 表示法 |
---|
{
"headerId": string,
"content": [
{
object ( |
字段 | |
---|---|
headerId |
标头的 ID。 |
content[] |
标头的内容。 标头内容的索引从零开始。 |
Footnote
文档脚注。
JSON 表示法 |
---|
{
"footnoteId": string,
"content": [
{
object ( |
字段 | |
---|---|
footnoteId |
脚注的 ID。 |
content[] |
脚注的内容。 脚注内容的索引从零开始。 |
DocumentStyle
文档的样式。
JSON 表示法 |
---|
{ "background": { object ( |
字段 | |
---|---|
background |
文档的背景。文档不能有透明的背景颜色。 |
defaultHeaderId |
默认标头的 ID。如果未设置,则没有默认标头。 此属性为只读属性。 |
defaultFooterId |
默认页脚的 ID。如果未设置,则没有默认页脚。 此属性为只读属性。 |
evenPageHeaderId |
仅用于偶数页的标题 ID。 此属性为只读属性。 |
evenPageFooterId |
仅用于偶数页的页脚 ID。 此属性为只读属性。 |
firstPageHeaderId |
仅用于首页的标题 ID。如果未设置,则第一个页面的唯一页眉不存在。 此属性为只读属性。 |
firstPageFooterId |
仅用于首页的页脚的 ID。如果未设置,则第一个页面没有唯一页脚。 此属性为只读属性。 |
useFirstPageHeaderFooter |
指明是否使用首页的首页页眉 / 页脚 ID。 |
useEvenPageHeaderFooter |
指明是否对偶数页使用偶数页页眉 / 页脚 ID。 |
pageNumberStart |
开始计算页数的页码。 |
marginTop |
上边距。 更新文档样式的上页外边距会清除所有版块样式的上外边距。 |
marginBottom |
下边距。 更新文档样式的下页边距会清除所有版块样式的下边距。 |
marginRight |
右页外边距。 更新文档样式的右侧页面外边距会清除所有版块样式的右侧页面外边距。还可能会导致列在所有版块中调整大小。 |
marginLeft |
左侧页边距。 更新文档样式的左侧页面外边距会清除所有版块样式的左侧页面外边距。还可能会导致列在所有版块中调整大小。 |
pageSize |
文档中一页的大小。 |
marginHeader |
页面顶部和页眉内容之间的间距。 |
marginFooter |
页面底部与页脚内容之间的间距。 |
useCustomHeaderFooterMargins |
指示是否遵循 DocumentStyle 此属性为只读属性。 |
flipPageOrientation |
可选。指示是否翻转 |
背景
表示文档的背景。
JSON 表示法 |
---|
{
"color": {
object ( |
字段 | |
---|---|
color |
背景颜色。 |
大小
宽度和高度。
JSON 表示法 |
---|
{ "height": { object ( |
字段 | |
---|---|
height |
对象的高度。 |
width |
对象的宽度。 |
SuggestedDocumentStyle
建议的对 DocumentStyle
的更改。
JSON 表示法 |
---|
{ "documentStyle": { object ( |
字段 | |
---|---|
documentStyle |
仅包含此建议中所做更改的 |
documentStyleSuggestionState |
一个掩码,用于指示此建议中基础 |
DocumentStyleSuggestionState
一个掩码,用于指示此建议中基础 DocumentStyle
上的哪些字段已更改。对于任何设置为 true 的字段,系统都会提供一个新的建议值。
JSON 表示法 |
---|
{ "backgroundSuggestionState": { object ( |
字段 | |
---|---|
backgroundSuggestionState |
一个掩码,用于指示此建议中 |
defaultHeaderIdSuggested |
指示是否有对 |
defaultFooterIdSuggested |
指示是否有对 |
evenPageHeaderIdSuggested |
指示是否有对 |
evenPageFooterIdSuggested |
指示是否有对 |
firstPageHeaderIdSuggested |
指示是否有对 |
firstPageFooterIdSuggested |
指示是否有对 |
useFirstPageHeaderFooterSuggested |
指示是否有对 |
useEvenPageHeaderFooterSuggested |
指示是否有对 |
pageNumberStartSuggested |
指示是否有对 |
marginTopSuggested |
指示是否有对 |
marginBottomSuggested |
指示是否有对 |
marginRightSuggested |
指示是否有对 |
marginLeftSuggested |
指示是否有对 |
pageSizeSuggestionState |
一个掩码,用于指示此建议中 [size] [google.apps.docs.v1.DocumentStyle.size] 中的哪些字段已更改。 |
marginHeaderSuggested |
指示是否有对 |
marginFooterSuggested |
指示是否有对 |
useCustomHeaderFooterMarginsSuggested |
指示是否有对 |
flipPageOrientationSuggested |
可选。指示是否有对 |
BackgroundSuggestionState
一个掩码,用于指示此建议中基础 Background
上的哪些字段已更改。对于任何设置为 true 的字段,Backgound
都会使用一个新的建议值。
JSON 表示法 |
---|
{ "backgroundColorSuggested": boolean } |
字段 | |
---|---|
backgroundColorSuggested |
指示此建议中是否已修改当前背景颜色。 |
SizeSuggestionState
一个掩码,用于指示此建议中基础 Size
上的哪些字段已更改。对于任何设置为 true 的字段,Size
都会使用一个新的建议值。
JSON 表示法 |
---|
{ "heightSuggested": boolean, "widthSuggested": boolean } |
字段 | |
---|---|
heightSuggested |
指示是否有对 |
widthSuggested |
指示是否有对 |
NamedStyles
已命名的样式。文档中的段落可以从这些已命名的样式继承其 TextStyle
和 ParagraphStyle
。
JSON 表示法 |
---|
{
"styles": [
{
object ( |
字段 | |
---|---|
styles[] |
已命名的样式。 每个可能的 |
命名样式
已命名的样式。当文档中的段落具有相同的命名样式类型时,可以从这个已命名的样式继承它们的 TextStyle
和 ParagraphStyle
。
JSON 表示法 |
---|
{ "namedStyleType": enum ( |
字段 | |
---|---|
namedStyleType |
已命名的样式的类型。 |
textStyle |
此已命名样式的文本样式。 |
paragraphStyle |
此已命名样式的段落样式。 |
SuggestedNamedStyles
建议的对 NamedStyles
的更改。
JSON 表示法 |
---|
{ "namedStyles": { object ( |
字段 | |
---|---|
namedStyles |
仅包含此建议中所做更改的 |
namedStylesSuggestionState |
一个掩码,用于指示此建议中基础 |
NamedStylesSuggestionState
NamedStyles
消息的建议状态。
JSON 表示法 |
---|
{
"stylesSuggestionStates": [
{
object ( |
字段 | |
---|---|
stylesSuggestionStates[] |
一个掩码,用于指示此建议中 这些已命名样式建议状态的顺序与 |
NamedStyleSuggestionState
NamedStyle
消息的建议状态。
JSON 表示法 |
---|
{ "namedStyleType": enum ( |
字段 | |
---|---|
namedStyleType |
此建议状态对应的已命名样式类型。 提供此字段是为了便于将 NamedStyleSuggestionState 与其对应的 |
textStyleSuggestionState |
一个掩码,用于指示此建议中 |
paragraphStyleSuggestionState |
一个掩码,用于指示此建议中 |
列表
List 表示全属于同一列表的一组段落的列表属性。列表中的段落在其 bullet
中引用了列表 ID。
JSON 表示法 |
---|
{ "listProperties": { object ( |
字段 | |
---|---|
listProperties |
列表的属性。 |
suggestedListPropertiesChanges |
对列表属性建议的更改,由建议 ID 键控。 |
suggestedInsertionId |
建议的插入 ID。如果为空,则不建议插入。 |
suggestedDeletionIds[] |
建议的删除 ID。如果为空,则表示此列表没有建议删除。 |
ListProperties
list
的属性,用于描述与列表相关联的段落所含的项目符号的外观和风格。
JSON 表示法 |
---|
{
"nestingLevels": [
{
object ( |
字段 | |
---|---|
nestingLevels[] |
描述关联级别项目符号的属性。 一个列表最多包含 9 层嵌套,其中嵌套层 0 对应于最高层,嵌套层 8 对应于最高嵌套层。嵌套层按升序返回,最少的嵌套层最先返回。 |
嵌套级别
包含描述列表项目符号在指定嵌套级别的外观和风格的属性。
JSON 表示法 |
---|
{ "bulletAlignment": enum ( |
字段 | |
---|---|
bulletAlignment |
在分配给渲染项目符号的空间内,项目符号的对齐方式。 |
glyphFormat |
项目符号在此嵌套级别使用的格式字符串。 字形格式包含一个或多个占位符,系统会根据 例如,字形格式
字形格式可包含当前嵌套级别的占位符以及父级嵌套级别的占位符。例如,一个列表在嵌套级别为 0 时可以具有
对于有序的嵌套级别,在特定段落的字形格式中替换占位符的字符串取决于段落在列表中的顺序。 |
indentFirstLine |
此嵌套级别中段落首行的缩进量。 |
indentStart |
此嵌套级别的段落的缩进量。根据段落的内容方向,应用于与文本开头对应的一侧。 |
textStyle |
此嵌套级别的项目符号的文本样式。 |
startNumber |
此嵌套级别上第一个列表项的数量。 对于字母列表和罗马数字列表,值 0 会被视为值 1。如果值同时为 0 和 1,字母数字列表和罗马数字列表将从 对于字形无序的嵌套级别,系统会忽略此值。 |
联合字段 glyph_kind 。项目符号使用的字形。这定义了用于替换 glyph_format 中的占位符的项目符号。glyph_kind 只能是下列其中一项: |
|
glyphType |
在该嵌套级别对段落进行排序时,项目符号使用的字形类型。 字形类型决定了当此嵌套级别的段落按顺序排列时,用于替换 |
glyphSymbol |
当该嵌套级别的段落无序时,项目符号会使用的自定义字形符号。 字形符号会替换 |
项目符号对齐
项目符号的对齐类型。
枚举 | |
---|---|
BULLET_ALIGNMENT_UNSPECIFIED |
未指定项目符号对齐方式。 |
START |
项目符号会与用于呈现项目符号的空间的开头对齐。对于 LTR 文本,为左对齐,否则为右对齐。 |
CENTER |
项目符号会与用于呈现项目符号的空间的中心对齐。 |
END |
项目符号会与用于呈现项目符号的空间的末尾对齐。对于 LTR 文本,为右对齐,否则为左对齐。 |
字形类型
对处于此嵌套级别的段落进行排序时,项目符号使用的字形类型。
枚举 | |
---|---|
GLYPH_TYPE_UNSPECIFIED |
字形类型未指定或不受支持。 |
NONE |
一个空字符串。 |
DECIMAL |
数字,如 1 、2 或 3 。 |
ZERO_DECIMAL |
个数以零为前缀的数字,如 01 、02 或 03 。包含多个数字的数字不带零前缀。 |
UPPER_ALPHA |
大写字母,例如 A 、B 或 C 。 |
ALPHA |
小写字母,例如 a 、b 或 c 。 |
UPPER_ROMAN |
大写罗马数字,如 I 、II 或 III 。 |
ROMAN |
小写的罗马数字,如 i 、ii 或 iii 。 |
SuggestedListProperties
建议对 ListProperties
进行更改。
JSON 表示法 |
---|
{ "listProperties": { object ( |
字段 | |
---|---|
listProperties |
仅包含此建议中所做更改的 |
listPropertiesSuggestionState |
一个掩码,用于指示此建议中基础 |
ListPropertiesSuggestionState
一个掩码,用于指示此建议中基础 ListProperties
上的哪些字段已更改。对于任何设置为 true 的字段,系统都会提供一个新的建议值。
JSON 表示法 |
---|
{
"nestingLevelsSuggestionStates": [
{
object ( |
字段 | |
---|---|
nestingLevelsSuggestionStates[] |
一个掩码,用于指示此建议中 嵌套级别建议状态按嵌套级别升序返回,最少的嵌套首先返回。 |
NestingLevelSuggestionState
一个掩码,用于指示此建议中基础 NestingLevel
上的哪些字段已更改。对于任何设置为 true 的字段,系统都会提供一个新的建议值。
JSON 表示法 |
---|
{
"bulletAlignmentSuggested": boolean,
"glyphTypeSuggested": boolean,
"glyphFormatSuggested": boolean,
"glyphSymbolSuggested": boolean,
"indentFirstLineSuggested": boolean,
"indentStartSuggested": boolean,
"textStyleSuggestionState": {
object ( |
字段 | |
---|---|
bulletAlignmentSuggested |
指示是否有对 |
glyphTypeSuggested |
指示是否有对 |
glyphFormatSuggested |
指示是否有对 |
glyphSymbolSuggested |
指示是否有对 |
indentFirstLineSuggested |
指示是否有对 |
indentStartSuggested |
指示是否有对 |
textStyleSuggestionState |
一个掩码,用于指示此建议中 |
startNumberSuggested |
指示是否有对 |
命名的范围
文档中共用给定名称的所有 NamedRange
的集合。
JSON 表示法 |
---|
{
"name": string,
"namedRanges": [
{
object ( |
字段 | |
---|---|
name |
所有 |
namedRanges[] |
使用相同名称的 |
命名的范围
具有相同命名范围 ID 的 Range
集合。
借助命名的范围,开发者可以将文档的各个部分与用户定义的任意标签相关联,以便日后通过编程方式读取或修改其内容。文档可以包含多个同名的命名范围,但每个命名范围都具有唯一 ID。
命名范围是使用单个 Range
创建的,在命名范围内插入的内容通常会扩展该范围。不过,某些文档更改可能会导致相应范围被拆分为多个范围。
命名的范围不是私有范围。有权访问该文档的所有应用和协作者都可以看到其命名的范围。
JSON 表示法 |
---|
{
"namedRangeId": string,
"name": string,
"ranges": [
{
object ( |
字段 | |
---|---|
namedRangeId |
命名范围的 ID。 |
name |
命名的范围的名称。 |
ranges[] |
属于此命名范围的范围。 |
范围
指定连续的文本范围。
JSON 表示法 |
---|
{ "segmentId": string, "startIndex": integer, "endIndex": integer } |
字段 | |
---|---|
segmentId |
此范围包含的页眉、页脚或脚注的 ID。空的细分 ID 表示文档的正文。 |
startIndex |
此范围的起始索引(从零开始),采用 UTF-16 代码单元。 在目前的所有用途中,都必须提供起始索引。此字段是一个 Int32Value,旨在适应未来具有开放式范围的用例。 |
endIndex |
此范围的结束索引(从零开始),不含边界值,采用 UTF-16 代码单元。 在目前的所有用途中,都必须提供结束索引。此字段是一个 Int32Value,旨在适应未来具有开放式范围的用例。 |
建议视图模式
应用于文档的建议视图模式,用于指示如何表示建议的更改。它提供阅读文档的选项,其中包含内嵌、已接受或已拒绝的所有建议。
枚举 | |
---|---|
DEFAULT_FOR_CURRENT_ACCESS |
应用于返回的文档的建议查看模式取决于用户当前的访问权限级别。如果用户只有查看权限,系统会应用 PREVIEW_WITHOUT_SUGGESTIONS 。否则,应用 SUGGESTIONS_INLINE 。这是默认的建议视图模式。 |
SUGGESTIONS_INLINE |
返回的文档中含有内嵌建议。建议的更改会与文档中的基本内容区分开来。 如果用户无权查看建议的更改,那么使用此模式检索文档的请求将返回 403 错误。 |
PREVIEW_SUGGESTIONS_ACCEPTED |
返回的是预览文档,其中接受了所有建议的更改。 如果用户无权查看建议的更改,那么使用此模式检索文档的请求将返回 403 错误。 |
PREVIEW_WITHOUT_SUGGESTIONS |
返回的文档是预览,如果文档中有任何建议,所有建议的更改都会被拒绝。 |
InlineObject
内嵌文本的对象。InlineObject 包含图像等 EmbeddedObject
。
JSON 表示法 |
---|
{ "objectId": string, "inlineObjectProperties": { object ( |
字段 | |
---|---|
objectId |
此内嵌对象的 ID。可用于更新对象的属性。 |
inlineObjectProperties |
此内嵌对象的属性。 |
suggestedInlineObjectPropertiesChanges |
对内嵌对象属性建议的更改,由建议 ID 键控。 |
suggestedInsertionId |
建议的插入 ID。如果为空,则不建议插入。 |
suggestedDeletionIds[] |
建议的删除 ID。如果为空,则表示没有建议删除此内容。 |
InlineObjectProperties
InlineObject
的属性。
JSON 表示法 |
---|
{
"embeddedObject": {
object ( |
字段 | |
---|---|
embeddedObject |
此内嵌对象的嵌入对象。 |
EmbeddedObject
文档中的嵌入式对象。
JSON 表示法 |
---|
{ "title": string, "description": string, "embeddedObjectBorder": { object ( |
字段 | |
---|---|
title |
嵌入对象的标题。结合使用 |
description |
嵌入对象的说明。结合使用 |
embeddedObjectBorder |
嵌入对象的边框。 |
size |
剪裁后图片的可见大小。 |
marginTop |
嵌入对象的上外边距。 |
marginBottom |
嵌入对象的下外边距。 |
marginRight |
嵌入对象的右外边距。 |
marginLeft |
嵌入对象的左外边距。 |
linkedContentReference |
对外部链接的源内容的引用。例如,当嵌入的对象是链接的图表时,此引用会包含对 Google 表格源图表的引用。 如果未设置,则系统不会链接嵌入的对象。 |
联合字段 properties 。每个嵌入对象类型特有的属性。properties 只能是下列其中一项: |
|
embeddedDrawingProperties |
嵌入的绘图的属性。 |
imageProperties |
图像的属性。 |
EmbeddedDrawingProperties
此类型没有任何字段。
嵌入绘图的属性,用于区分对象类型。嵌入的绘图是在文档中创建的绘图。请注意,不支持宽泛的详细信息。
ImageProperties
图像的属性。
JSON 表示法 |
---|
{
"contentUri": string,
"sourceUri": string,
"brightness": number,
"contrast": number,
"transparency": number,
"cropProperties": {
object ( |
字段 | |
---|---|
contentUri |
默认生命周期为 30 分钟的图片的 URI。此 URI 使用请求者的帐号进行标记。拥有该 URI 的任何人都能以原始请求者的身份有效访问该图片。如果文档的共享设置发生变化,您可能会失去对图片的访问权限。 |
sourceUri |
源 URI 是用于插入图片的 URI。来源 URI 可以为空。 |
brightness |
图片的亮度效果。该值应在 [-1.0, 1.0] 的范围内,其中 0 表示无任何影响。 |
contrast |
图片的对比度效果。该值应在 [-1.0, 1.0] 的范围内,其中 0 表示无任何影响。 |
transparency |
图片的透明度效果。该值应在 [0.0, 1.0] 的范围内,其中 0 表示无效果,1 表示透明。 |
cropProperties |
图片的剪裁属性。 |
angle |
图片的顺时针旋转角度,以弧度表示。 |
CropProperties
图片的剪裁属性。
剪裁矩形使用相对于原始内容的 4 条边缘的小数偏移来表示。
- 如果偏移量在间隔 (0, 1) 内,则剪裁矩形的对应边缘将位于图片的原始边界矩形内部。
- 如果偏移量为负或大于 1,则剪裁矩形的相应边缘将位于图片的原始边界矩形之外。
- 如果所有偏移和旋转角度均为 0,则图片不会被剪裁。
JSON 表示法 |
---|
{ "offsetLeft": number, "offsetRight": number, "offsetTop": number, "offsetBottom": number, "angle": number } |
字段 | |
---|---|
offsetLeft |
偏移指定剪裁矩形左侧边缘与原始内容左边缘之间的距离,以原始内容宽度的比例的形式表示。 |
offsetRight |
偏移指定剪裁矩形右边缘与原始内容右边缘之间的距离,以原始内容宽度的比例的形式表示。 |
offsetTop |
偏移指定剪裁矩形上边缘与原始内容上边缘之间的距离,以原始内容高度的比例的形式表示。 |
offsetBottom |
偏移指定剪裁矩形底部边缘与原始内容下边缘之间的距离,以原始内容高度的比例表示。 |
angle |
剪裁矩形围绕其中心的顺时针旋转角度(以弧度表示)。旋转后应用偏移。 |
EmbeddedObjectBorder
EmbeddedObject
周围的边框。
JSON 表示法 |
---|
{ "color": { object ( |
字段 | |
---|---|
color |
边框的颜色。 |
width |
边框的宽度。 |
dashStyle |
边框的短划线样式。 |
propertyState |
边框属性的属性状态。 |
属性状态
房源可能所处的状态。
枚举 | |
---|---|
RENDERED |
如果某个属性的状态为 RENDERED,则该元素在文档中呈现时具有对应的属性。这是默认值。 |
NOT_RENDERED |
如果某个属性的状态为 NOT_RENDERED,则此元素在文档中呈现时不会有相应的属性。 |
LinkedContentReference
对外部链接的源内容的引用。
JSON 表示法 |
---|
{ // Union field |
字段 | |
---|---|
联合字段 reference 。特定于链接内容类型的参考文件。reference 只能是下列其中一项: |
|
sheetsChartReference |
对链接的图表的引用。 |
表格图表参考
对嵌入 Google 表格的链接图表的引用。
JSON 表示法 |
---|
{ "spreadsheetId": string, "chartId": integer } |
字段 | |
---|---|
spreadsheetId |
包含源图表的 Google 表格电子表格的 ID。 |
chartId |
嵌入的 Google 表格电子表格中特定图表的 ID。 |
SuggestedInlineObjectProperties
建议对 InlineObjectProperties
进行更改。
JSON 表示法 |
---|
{ "inlineObjectProperties": { object ( |
字段 | |
---|---|
inlineObjectProperties |
仅包含此建议中所做更改的 |
inlineObjectPropertiesSuggestionState |
一个掩码,用于指示此建议中基础 |
InlineObjectPropertiesSuggestionState
一个掩码,用于指示此建议中基础 InlineObjectProperties
上的哪些字段已更改。对于任何设置为 true 的字段,系统都会提供一个新的建议值。
JSON 表示法 |
---|
{
"embeddedObjectSuggestionState": {
object ( |
字段 | |
---|---|
embeddedObjectSuggestionState |
一个掩码,用于指示此建议中 |
EmbeddedObjectSuggestionState
一个掩码,用于指示此建议中基础 EmbeddedObject
上的哪些字段已更改。对于任何设置为 true 的字段,系统都会提供一个新的建议值。
JSON 表示法 |
---|
{ "embeddedDrawingPropertiesSuggestionState": { object ( |
字段 | |
---|---|
embeddedDrawingPropertiesSuggestionState |
一个掩码,用于指示此建议中 |
imagePropertiesSuggestionState |
一个掩码,用于指示此建议中 |
titleSuggested |
指示是否有对 |
descriptionSuggested |
指示是否有对 |
embeddedObjectBorderSuggestionState |
一个掩码,用于指示此建议中 |
sizeSuggestionState |
一个掩码,用于指示此建议中 |
marginLeftSuggested |
指示是否有对 |
marginRightSuggested |
指示是否有对 |
marginTopSuggested |
指示是否有对 |
marginBottomSuggested |
指示是否有对 |
linkedContentReferenceSuggestionState |
一个掩码,用于指示此建议中 |
EmbeddedDrawingPropertiesSuggestionState
此类型没有任何字段。
一个掩码,用于指示此建议中基础 EmbeddedDrawingProperties
上的哪些字段已更改。对于任何设置为 true 的字段,系统都会提供一个新的建议值。
ImagePropertiesSuggestionState
一个掩码,用于指示此建议中基础 ImageProperties
上的哪些字段已更改。对于任何设置为 true 的字段,系统都会提供一个新的建议值。
JSON 表示法 |
---|
{
"contentUriSuggested": boolean,
"sourceUriSuggested": boolean,
"brightnessSuggested": boolean,
"contrastSuggested": boolean,
"transparencySuggested": boolean,
"cropPropertiesSuggestionState": {
object ( |
字段 | |
---|---|
contentUriSuggested |
指示是否有对 |
sourceUriSuggested |
指示 [sourceUri] [google.apps.docs.v1.EmbeddedObject.source_uri] 是否有建议更改。 |
brightnessSuggested |
指示是否建议更改 [亮度] [google.apps.docs.v1.EmbeddedObject.brightness]。 |
contrastSuggested |
指示是否有建议对 [contrast] [google.apps.docs.v1.EmbeddedObject.contrast] 进行更改。 |
transparencySuggested |
指明是否有建议对 [transparency] [google.apps.docs.v1.EmbeddedObject.transparency] 进行更改。 |
cropPropertiesSuggestionState |
一个掩码,用于指示此建议中 |
angleSuggested |
指示 [angle] [google.apps.docs.v1.EmbeddedObject.angle] 是否有建议更改。 |
CropPropertiesSuggestionState
一个掩码,用于指示此建议中基础 CropProperties
上的哪些字段已更改。对于任何设置为 true 的字段,系统都会提供一个新的建议值。
JSON 表示法 |
---|
{ "offsetLeftSuggested": boolean, "offsetRightSuggested": boolean, "offsetTopSuggested": boolean, "offsetBottomSuggested": boolean, "angleSuggested": boolean } |
字段 | |
---|---|
offsetLeftSuggested |
指示是否有对 |
offsetRightSuggested |
指示是否有对 |
offsetTopSuggested |
指示是否有对 |
offsetBottomSuggested |
指示是否有对 |
angleSuggested |
指示是否有对 |
EmbeddedObjectBorderSuggestionState
一个掩码,用于指示此建议中基础 EmbeddedObjectBorder
上的哪些字段已更改。对于任何设置为 true 的字段,系统都会提供一个新的建议值。
JSON 表示法 |
---|
{ "colorSuggested": boolean, "widthSuggested": boolean, "dashStyleSuggested": boolean, "propertyStateSuggested": boolean } |
字段 | |
---|---|
colorSuggested |
指示是否建议对 [color] [google.apps.docs.v1.EmbeddedBorderObject.color] 进行更改。 |
widthSuggested |
指示是否建议对 [width] [google.apps.docs.v1.EmbeddedBorderObject.width] 进行更改。 |
dashStyleSuggested |
指示 [dashStyle] [google.apps.docs.v1.EmbeddedBorderObject.dash_style] 是否有建议的更改。 |
propertyStateSuggested |
指示 [propertyState] [google.apps.docs.v1.EmbeddedBorderObject.property_state] 是否有建议的更改。 |
LinkedContentReferenceSuggestionState
一个掩码,用于指示此建议中基础 LinkedContentReference
上的哪些字段已更改。对于任何设置为 true 的字段,系统都会提供一个新的建议值。
JSON 表示法 |
---|
{
"sheetsChartReferenceSuggestionState": {
object ( |
字段 | |
---|---|
sheetsChartReferenceSuggestionState |
一个掩码,用于指示此建议中 |
表格图表参考建议状态
一个掩码,用于指示此建议中基础 SheetsChartReference
上的哪些字段已更改。对于任何设置为 true 的字段,系统都会提供一个新的建议值。
JSON 表示法 |
---|
{ "spreadsheetIdSuggested": boolean, "chartIdSuggested": boolean } |
字段 | |
---|---|
spreadsheetIdSuggested |
指示是否有对 |
chartIdSuggested |
指示是否有对 |
PositionedObject
绑定到 Paragraph
且相对于段落开头的位置的对象。PositionedObject 包含图像等 EmbeddedObject
。
JSON 表示法 |
---|
{ "objectId": string, "positionedObjectProperties": { object ( |
字段 | |
---|---|
objectId |
已定位的对象的 ID。 |
positionedObjectProperties |
此已定位对象的属性。 |
suggestedPositionedObjectPropertiesChanges |
对已定位对象属性的建议更改,由建议 ID 键控。 |
suggestedInsertionId |
建议的插入 ID。如果为空,则不建议插入。 |
suggestedDeletionIds[] |
建议的删除 ID。如果为空,则表示没有建议删除此内容。 |
PositionedObjectProperties
PositionedObject
的属性。
JSON 表示法 |
---|
{ "positioning": { object ( |
字段 | |
---|---|
positioning |
此定位对象相对于引用此定位对象的 |
embeddedObject |
已定位的对象的嵌入对象。 |
PositionedObjectPositioning
PositionedObject
的定位。定位的对象会定位到与其绑定的 Paragraph
的开头。
JSON 表示法 |
---|
{ "layout": enum ( |
字段 | |
---|---|
layout |
此放置对象的布局。 |
leftOffset |
已定位对象的左边缘相对于与其共享到的 |
topOffset |
已定位对象的上边缘相对于与其绑定的 |
PositionedObjectLayout
[PositionedObject][google.aps.docs.v1.PositionedObject] 的可能布局。
枚举 | |
---|---|
POSITIONED_OBJECT_LAYOUT_UNSPECIFIED |
未指定布局。 |
WRAP_TEXT |
文本环绕放置的对象。 |
BREAK_LEFT |
拆分文本,使定位的对象位于左侧,文本位于右侧。 |
BREAK_RIGHT |
拆分文本,使定位的对象位于右侧,文本位于左侧。 |
BREAK_LEFT_RIGHT |
拆分文本,使定位对象的左侧或右侧没有文本。 |
IN_FRONT_OF_TEXT |
定位的对象位于文本前面。 |
BEHIND_TEXT |
定位的对象位于文本后面。 |
SuggestedPositionedObjectProperties
建议对 PositionedObjectProperties
进行更改。
JSON 表示法 |
---|
{ "positionedObjectProperties": { object ( |
字段 | |
---|---|
positionedObjectProperties |
仅包含此建议中所做更改的 |
positionedObjectPropertiesSuggestionState |
一个掩码,用于指示此建议中基础 |
PositionedObjectPropertiesSuggestionState
一个掩码,用于指示此建议中基础 PositionedObjectProperties
上的哪些字段已更改。对于任何设置为 true 的字段,系统都会提供一个新的建议值。
JSON 表示法 |
---|
{ "positioningSuggestionState": { object ( |
字段 | |
---|---|
positioningSuggestionState |
一个掩码,用于指示此建议中 |
embeddedObjectSuggestionState |
一个掩码,用于指示此建议中 |
PositionedObjectPositioningSuggestionState
一个掩码,用于指示此建议中基础 PositionedObjectPositioning
上的哪些字段已更改。对于任何设置为 true 的字段,系统都会提供一个新的建议值。
JSON 表示法 |
---|
{ "layoutSuggested": boolean, "leftOffsetSuggested": boolean, "topOffsetSuggested": boolean } |
字段 | |
---|---|
layoutSuggested |
指示是否有对 |
leftOffsetSuggested |
指示是否有对 |
topOffsetSuggested |
指示是否有对 |
方法 |
|
---|---|
|
对文档应用一个或多个更新。 |
|
使用请求中指定的标题创建空白文档。 |
|
获取指定文档的最新版本。 |