REST Resource: documents

资源：Document

Google 文档。

JSON 表示法 
{
  "documentId": string,
  "title": string,
  "tabs": [
    {
      object (Tab)
    }
  ],
  "revisionId": string,
  "suggestionsViewMode": enum (SuggestionsViewMode),
  "body": {
    object (Body)
  },
  "headers": {
    string: {
      object (Header)
    },
    ...
  },
  "footers": {
    string: {
      object (Footer)
    },
    ...
  },
  "footnotes": {
    string: {
      object (Footnote)
    },
    ...
  },
  "documentStyle": {
    object (DocumentStyle)
  },
  "suggestedDocumentStyleChanges": {
    string: {
      object (SuggestedDocumentStyle)
    },
    ...
  },
  "namedStyles": {
    object (NamedStyles)
  },
  "suggestedNamedStylesChanges": {
    string: {
      object (SuggestedNamedStyles)
    },
    ...
  },
  "lists": {
    string: {
      object (List)
    },
    ...
  },
  "namedRanges": {
    string: {
      object (NamedRanges)
    },
    ...
  },
  "inlineObjects": {
    string: {
      object (InlineObject)
    },
    ...
  },
  "positionedObjects": {
    string: {
      object (PositionedObject)
    },
    ...
  }
}
字段
documentId

string

仅限输出。文档的 ID。
title

string

文档的标题。
tabs[]

object (Tab)

文档中的标签页。

标签页可以包含子标签页，即嵌套在其他标签页中的标签页。子标签页由 Tab.childTabs 字段表示。
revisionId

string

仅限输出。文档的修订 ID。可在更新请求中使用，用于指定要将更新应用到文档的哪个修订版本，以及如果文档在该修订版本之后被修改，请求应如何处理。仅当用户拥有文档的编辑权限时才会填充。

修订版本 ID 不是顺序编号，而是一个不透明字符串。修订 ID 的格式可能会随时间而变化。返回的修订版本 ID 只能保证在返回后的 24 小时内有效，并且不能跨用户共享。如果在两次调用之间修订 ID 保持不变，则表示文档未发生更改。反之，如果 ID 发生了更改（对于同一文档和用户），通常表示文档已更新。不过，ID 更改也可能是由内部因素（例如 ID 格式更改）导致的。
suggestionsViewMode

enum (SuggestionsViewMode)

仅限输出。应用于文档的建议视图模式。

注意：修改文档时，必须基于包含 SUGGESTIONS_INLINE 的文档进行更改。
body

object (Body)

仅限输出。文档的正文。

旧版字段：请改用 Document.tabs.documentTab.body，当 includeTabsContent 参数设置为 true 时，它会显示所有标签页中的实际文档内容。如果为 false 或未设置，此字段包含文档中第一个标签页的相关信息。
headers

map (key: string, value: object (Header))

仅限输出。文档中的标题，由标头 ID 键控。

旧版字段：请改用 Document.tabs.documentTab.headers，当 includeTabsContent 参数设置为 true 时，它会显示所有标签页中的实际文档内容。如果为 false 或未设置，此字段包含文档中第一个标签页的相关信息。
footers

map (key: string, value: object (Footer))

仅限输出。文档中的页脚，以页脚 ID 为键。

旧版字段：请改用 Document.tabs.documentTab.footers，当 includeTabsContent 参数设置为 true 时，它会显示所有标签页中的实际文档内容。如果为 false 或未设置，此字段包含文档中第一个标签页的相关信息。
footnotes

map (key: string, value: object (Footnote))

仅限输出。文档中的脚注，按脚注 ID 键值对排列。

旧版字段：改用 Document.tabs.documentTab.footnotes，当 includeTabsContent 参数设置为 true 时，它会公开所有标签页中的实际文档内容。如果为 false 或未设置，此字段包含文档中第一个标签页的相关信息。
documentStyle

object (DocumentStyle)

仅限输出。文档的样式。

旧版字段：请改用 Document.tabs.documentTab.documentStyle，当 includeTabsContent 参数设置为 true 时，它会显示所有标签页中的实际文档内容。如果为 false 或未设置，此字段包含文档中第一个标签页的相关信息。
suggestedDocumentStyleChanges

map (key: string, value: object (SuggestedDocumentStyle))

仅限输出。对文档样式的建议更改，按建议 ID 编入键值对。

旧版字段：请改用 Document.tabs.documentTab.suggestedDocumentStyleChanges，当 includeTabsContent 参数设置为 true 时，它会显示所有标签页中的实际文档内容。如果为 false 或未设置，此字段包含文档中第一个标签页的相关信息。
namedStyles

object (NamedStyles)

仅限输出。文档的命名样式。

旧版字段：请改用 Document.tabs.documentTab.namedStyles，当 includeTabsContent 参数设置为 true 时，它会显示所有标签页中的实际文档内容。如果为 false 或未设置，此字段包含文档中第一个标签页的相关信息。
suggestedNamedStylesChanges

map (key: string, value: object (SuggestedNamedStyles))

仅限输出。对文档命名样式的建议更改，按建议 ID 编入键值对。

旧版字段：改用 Document.tabs.documentTab.suggestedNamedStylesChanges，当 includeTabsContent 参数设置为 true 时，它会公开所有标签页中的实际文档内容。如果为 false 或未设置，此字段包含文档中第一个标签页的相关信息。
lists

map (key: string, value: object (List))

仅限输出。文档中的列表，按列表 ID 键控。

旧版字段：改用 Document.tabs.documentTab.lists，当 includeTabsContent 参数设置为 true 时，它会公开所有标签页中的实际文档内容。如果为 false 或未设置，此字段包含文档中第一个标签页的相关信息。
namedRanges

map (key: string, value: object (NamedRanges))

仅限输出。文档中的命名范围，按名称键值对排列。

旧版字段：改用 Document.tabs.documentTab.namedRanges，当 includeTabsContent 参数设置为 true 时，它会公开所有标签页中的实际文档内容。如果为 false 或未设置，此字段包含文档中第一个标签页的相关信息。
inlineObjects

map (key: string, value: object (InlineObject))

仅限输出。文档中的内嵌对象，按对象 ID 键控。

旧版字段：请改用 Document.tabs.documentTab.inlineObjects，当 includeTabsContent 参数设置为 true 时，它会显示所有标签页中的实际文档内容。如果为 false 或未设置，此字段包含文档中第一个标签页的相关信息。
positionedObjects

map (key: string, value: object (PositionedObject))

仅限输出。文档中已定位的对象，按对象 ID 键控。

旧版字段：请改用 Document.tabs.documentTab.positionedObjects，当 includeTabsContent 参数设置为 true 时，它会显示所有标签页中的实际文档内容。如果为 false 或未设置，此字段包含文档中第一个标签页的相关信息。

Tab

文档中的标签页。

JSON 表示法 
{
  "tabProperties": {
    object (TabProperties)
  },
  "childTabs": [
    {
      object (Tab)
    }
  ],

  // Union field content can be only one of the following:
  "documentTab": {
    object (DocumentTab)
  }
  // End of list of possible types for union field content.
}
字段
tabProperties

object (TabProperties)

标签页的属性，例如 ID 和标题。
childTabs[]

object (Tab)

此标签页中嵌套的子标签页。
联合字段 content。标签页的内容。content 只能是下列其中一项：
documentTab

object (DocumentTab)

包含文档内容（例如文本和图片）的标签页。

TabProperties

标签页的属性。

JSON 表示法 
{
  "tabId": string,
  "title": string,
  "parentTabId": string,
  "index": integer,
  "nestingLevel": integer
}
字段
tabId

string

仅限输出。标签页的 ID。此字段无法更改。
title

string

标签页的用户可见名称。
parentTabId

string

可选。父标签页的 ID。如果当前标签页是根级标签页（即没有任何父级），则为空。
index

integer

标签页在父级中的索引（从零开始）。
nestingLevel

integer

仅限输出。文档中标签页的深度。根级标签页从 0 开始编号。

DocumentTab

包含文档内容的标签页。

JSON 表示法 
{
  "body": {
    object (Body)
  },
  "headers": {
    string: {
      object (Header)
    },
    ...
  },
  "footers": {
    string: {
      object (Footer)
    },
    ...
  },
  "footnotes": {
    string: {
      object (Footnote)
    },
    ...
  },
  "documentStyle": {
    object (DocumentStyle)
  },
  "suggestedDocumentStyleChanges": {
    string: {
      object (SuggestedDocumentStyle)
    },
    ...
  },
  "namedStyles": {
    object (NamedStyles)
  },
  "suggestedNamedStylesChanges": {
    string: {
      object (SuggestedNamedStyles)
    },
    ...
  },
  "lists": {
    string: {
      object (List)
    },
    ...
  },
  "namedRanges": {
    string: {
      object (NamedRanges)
    },
    ...
  },
  "inlineObjects": {
    string: {
      object (InlineObject)
    },
    ...
  },
  "positionedObjects": {
    string: {
      object (PositionedObject)
    },
    ...
  }
}
字段
body

object (Body)

“文档”标签页的主要正文。
headers

map (key: string, value: object (Header))

文档标签页中的标题，按标题 ID 键控。
footers

map (key: string, value: object (Footer))

“文档”标签页中的页脚，按页脚 ID 键值对排列。
footnotes

map (key: string, value: object (Footnote))

“文档”标签页中的脚注，按脚注 ID 键值对排列。
documentStyle

object (DocumentStyle)

文档标签页的样式。
suggestedDocumentStyleChanges

map (key: string, value: object (SuggestedDocumentStyle))

建议的更改会更改为文档标签页的样式（由建议 ID 键控）。
namedStyles

object (NamedStyles)

文档标签页的命名样式。
suggestedNamedStylesChanges

map (key: string, value: object (SuggestedNamedStyles))

对文档标签页命名样式的建议更改，按建议 ID 编入键值对。
lists

map (key: string, value: object (List))

“文档”标签页中的列表，按列表 ID 键值对排列。
namedRanges

map (key: string, value: object (NamedRanges))

“文档”标签页中的命名范围，按名称键值对排列。
inlineObjects

map (key: string, value: object (InlineObject))

文档标签页中的内嵌对象，按对象 ID 键控。
positionedObjects

map (key: string, value: object (PositionedObject))

文档标签页中已定位的对象，按对象 ID 键控。

正文

文档正文。

正文通常包含除 headers、footers 和 footnotes 以外的完整文档内容。

JSON 表示法 
{
  "content": [
    {
      object (StructuralElement)
    }
  ]
}
字段
content[]

object (StructuralElement)

正文内容。

正文内容的索引从零开始。

StructuralElement

StructuralElement 用于描述为文档提供结构的内容。

JSON 表示法 
{
  "startIndex": integer,
  "endIndex": integer,

  // Union field content can be only one of the following:
  "paragraph": {
    object (Paragraph)
  },
  "sectionBreak": {
    object (SectionBreak)
  },
  "table": {
    object (Table)
  },
  "tableOfContents": {
    object (TableOfContents)
  }
  // End of list of possible types for union field content.
}
字段
startIndex

integer

此结构元素的起始索引（从零开始），采用 UTF-16 代码单元。
endIndex

integer

此结构元素的结束编号（从 0 开始，不包括该编号），以 UTF-16 代码单元为单位。
联合字段 content。结构元素的内容。content 只能是下列其中一项：
paragraph

object (Paragraph)

段落类型的结构元素。
sectionBreak

object (SectionBreak)

结构元素的章节插入点类型。
table

object (Table)

表格类型的结构元素。
tableOfContents

object (TableOfContents)

目录类型的结构元素。

段落

表示段落的 StructuralElement。段落是指以换行符结尾的内容范围。

JSON 表示法 
{
  "elements": [
    {
      object (ParagraphElement)
    }
  ],
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "suggestedParagraphStyleChanges": {
    string: {
      object (SuggestedParagraphStyle)
    },
    ...
  },
  "bullet": {
    object (Bullet)
  },
  "suggestedBulletChanges": {
    string: {
      object (SuggestedBullet)
    },
    ...
  },
  "positionedObjectIds": [
    string
  ],
  "suggestedPositionedObjectIds": {
    string: {
      object (ObjectReferences)
    },
    ...
  }
}
字段
elements[]

object (ParagraphElement)

段落的内容，分解为其组成部分。
paragraphStyle

object (ParagraphStyle)

此段落的样式。
suggestedParagraphStyleChanges

map (key: string, value: object (SuggestedParagraphStyle))

建议的段落样式会更改为此段落，按建议 ID 键控。
bullet

object (Bullet)

此段落的项目符号。如果不存在，则段落不属于列表。
suggestedBulletChanges

map (key: string, value: object (SuggestedBullet))

建议修改此段落的项目符号。
positionedObjectIds[]

string

与此段落绑定的定位对象的 ID。
suggestedPositionedObjectIds

map (key: string, value: object (ObjectReferences))

建议附加到此段落的定位对象的 ID，按建议 ID 键值对排列。

ParagraphElement

ParagraphElement 用于描述 Paragraph 中的内容。

JSON 表示法 
{
  "startIndex": integer,
  "endIndex": integer,

  // Union field content can be only one of the following:
  "textRun": {
    object (TextRun)
  },
  "autoText": {
    object (AutoText)
  },
  "pageBreak": {
    object (PageBreak)
  },
  "columnBreak": {
    object (ColumnBreak)
  },
  "footnoteReference": {
    object (FootnoteReference)
  },
  "horizontalRule": {
    object (HorizontalRule)
  },
  "equation": {
    object (Equation)
  },
  "inlineObjectElement": {
    object (InlineObjectElement)
  },
  "person": {
    object (Person)
  },
  "richLink": {
    object (RichLink)
  }
  // End of list of possible types for union field content.
}
字段
startIndex

integer

此段落元素的起始索引（以 0 为基数），以 UTF-16 代码单元为单位。
endIndex

integer

此段落元素的结束索引（不含基数），以 UTF-16 代码单元为单位。
联合字段 content。段落元素的内容。content 只能是下列其中一项：
textRun

object (TextRun)

文本行段落元素。
autoText

object (AutoText)

自动文本段落元素。
pageBreak

object (PageBreak)

分页段落元素。
columnBreak

object (ColumnBreak)

列分隔段落元素。
footnoteReference

object (FootnoteReference)

脚注引用段落元素。
horizontalRule

object (HorizontalRule)

水平规则段落元素。
equation

object (Equation)

等式段落元素。
inlineObjectElement

object (InlineObjectElement)

内嵌对象段落元素。
person

object (Person)

指向某个人或电子邮件地址的段落元素。

TextRun

ParagraphElement，表示全都具有相同样式的文本段。

JSON 表示法 
{
  "content": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
字段
content

string

此次运行的文本。

运行作业中的所有非文本元素都会替换为 Unicode 字符 U+E907。
suggestedInsertionIds[]

string

建议的插入 ID。如果 TextRun 是嵌套的建议更改，则可能具有多个广告插入 ID。如果为空，则表示这不是建议的插入内容。
suggestedDeletionIds[]

string

建议删除的 ID。如果为空，则表示系统没有建议删除此内容。
textStyle

object (TextStyle)

此运行的文字样式。
suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

建议的文本样式将更改为此次运行，由建议 ID 键控。

TextStyle

表示可应用于文本的样式。

继承的文本样式在此消息中表示为未设置的字段。文本样式的父级取决于文本样式的定义位置：

  • Paragraph 中文本的 TextStyle 会继承段落的相应 named style type。
  • named style 上的 TextStyle 会继承 normal text 命名样式。
  • normal text 命名样式的 TextStyle 会继承 Google 文档编辑器中的默认文本样式。
  • 表格中包含的 Paragraph 元素上的 TextStyle 可能会从表格样式继承其文本样式。

如果文本样式未继承自父级，则取消设置字段会将样式还原为与文档编辑器中的默认值相匹配的值。

JSON 表示法 
{
  "bold": boolean,
  "italic": boolean,
  "underline": boolean,
  "strikethrough": boolean,
  "smallCaps": boolean,
  "backgroundColor": {
    object (OptionalColor)
  },
  "foregroundColor": {
    object (OptionalColor)
  },
  "fontSize": {
    object (Dimension)
  },
  "weightedFontFamily": {
    object (WeightedFontFamily)
  },
  "baselineOffset": enum (BaselineOffset),
  "link": {
    object (Link)
  }
}
字段
bold

boolean

文本是否呈现为粗体。
italic

boolean

文本是否为斜体。
underline

boolean

文本是否带下划线。
strikethrough

boolean

文本是否删除线。
smallCaps

boolean

文本是否采用较小的大写字母。
backgroundColor

object (OptionalColor)

文本的背景颜色。如果已设置，颜色为 RGB 颜色或透明，具体取决于 color 字段。
foregroundColor

object (OptionalColor)

文本的前景颜色。如果已设置，该颜色将为 RGB 颜色或透明，具体取决于 color 字段。
fontSize

object (Dimension)

文本字体的大小。
weightedFontFamily

object (WeightedFontFamily)

文本的字体系列和呈现的粗细。

如果更新请求同时为 weightedFontFamily 和 bold 指定了值，则系统会先应用 weightedFontFamily，然后再应用 bold。

如果未设置 weightedFontFamily#weight，则默认为 400。

如果设置了 weightedFontFamily，则还必须设置 weightedFontFamily#fontFamily 并为其设置非空值。否则，系统会返回 400 错误请求错误。
baselineOffset

enum (BaselineOffset)

文本相对于其正常位置的垂直偏移量。

具有 SUPERSCRIPT 或 SUBSCRIPT 基准线偏移的文本会自动以较小的字号呈现，该字号基于 fontSize 字段计算得出。此字段中的更改不会影响 fontSize。

OptionalColor

颜色可以是完全不透明或完全透明。

JSON 表示法 
{
  "color": {
    object (Color)
  }
}
字段
color

object (Color)

如果设置，则将用作不透明颜色。如果未设置，则表示透明颜色。

颜色

纯色。

JSON 表示法 
{
  "rgbColor": {
    object (RgbColor)
  }
}
字段
rgbColor

object (RgbColor)

RGB 颜色值。

RgbColor

RGB 颜色。

JSON 表示法 
{
  "red": number,
  "green": number,
  "blue": number
}
字段
red

number

颜色的红色分量，介于 0.0 到 1.0 之间。
green

number

颜色的绿色分量，在 0.0 到 1.0 之间。
blue

number

颜色的蓝色分量，介于 0.0 到 1.0 之间。

维度

单个方向上的大小，采用指定的单位。

JSON 表示法 
{
  "magnitude": number,
  "unit": enum (Unit)
}
字段
magnitude

number

震级。
unit

enum (Unit)

振幅的单位。

单位

度量单位。

枚举
UNIT_UNSPECIFIED 单位未知。
PT 1 个点等于 1/72 英寸。

WeightedFontFamily

表示文本的字体系列和粗细。

JSON 表示法 
{
  "fontFamily": string,
  "weight": integer
}
字段
fontFamily

string

文本的字体系列。

字体系列可以是 Google 文档或 Google Fonts 的“字体”菜单中的任意字体。如果无法识别字体名称，系统会使用 Arial 渲染文本。
weight

integer

字体粗细。此字段可以具有介于 100 到 900 之间（包括这两个数值）的 100 的倍数的任何值。此范围对应于 CSS 2.1 规范第 15.6 节中所述的数值，不允许使用非数值。

默认值为 400（“normal”）。

字体粗细只是渲染的字体粗细的一个组成部分。在考虑继承的情况下，weight 和文本样式的已解析 bold 值的组合决定了渲染的粗细：

  • 如果文本为粗体且粗细小于 400，则渲染的粗细为 400。
  • 如果文本为粗体，且粗体粗细大于或等于 400 但小于 700，则渲染的粗细为 700。
  • 如果权重大于或等于 700，则渲染的权重等于权重。
  • 如果文本不是粗体，则渲染的粗体与粗体值相同。

BaselineOffset

文本可以从其正常位置垂直偏移的方式。

枚举
BASELINE_OFFSET_UNSPECIFIED 文本的基线偏移量继承自父项。
NONE 文本未垂直偏移。
SUPERSCRIPT 文本垂直偏移向上（上标）。
SUBSCRIPT 文本垂直向下偏移（下标）。

SuggestedTextStyle

针对 TextStyle 的建议更改。

JSON 表示法 
{
  "textStyle": {
    object (TextStyle)
  },
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  }
}
字段
textStyle

object (TextStyle)

一个 TextStyle，仅包含在此建议中所做的更改。它可以与 textStyleSuggestionState 结合使用，以查看哪些字段发生了变化及其新值。
textStyleSuggestionState

object (TextStyleSuggestionState)

一个掩码，用于指示此建议中基础 TextStyle 的哪些字段已更改。

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

boolean

指示是否有针对 bold 的建议更改。
italicSuggested

boolean

指示是否有针对 italic 的建议更改。
underlineSuggested

boolean

指示是否有针对 underline 的建议更改。
strikethroughSuggested

boolean

指示是否有针对 strikethrough 的建议更改。
smallCapsSuggested

boolean

指示是否有针对 smallCaps 的建议更改。
backgroundColorSuggested

boolean

指示是否有针对 backgroundColor 的建议更改。
foregroundColorSuggested

boolean

指示是否有针对 foregroundColor 的建议更改。
fontSizeSuggested

boolean

指示是否有针对 fontSize 的建议更改。
weightedFontFamilySuggested

boolean

指示是否有针对 weightedFontFamily 的建议更改。
baselineOffsetSuggested

boolean

指示是否有针对 baselineOffset 的建议更改。

AutoText

一个 ParagraphElement，表示文本中的位置，该位置被动态替换为可随时间变化的内容（如页码）。

JSON 表示法 
{
  "type": enum (Type),
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
字段
type

enum (Type)

此自动文字的类型。
suggestedInsertionIds[]

string

建议的广告订单 ID。如果 AutoText 是嵌套的建议更改，则可能具有多个广告插入 ID。如果为空，则表示这不是建议的插入内容。
suggestedDeletionIds[]

string

建议删除的 ID。如果为空，则表示没有建议删除此内容。
textStyle

object (TextStyle)

此 AutoText 的文本样式。
suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

建议的文本样式将更改为此 AutoText，由建议 ID 键控。

类型

自动文本的类型。

枚举
TYPE_UNSPECIFIED 未指定的自动输入文字类型。
PAGE_NUMBER 输入表示当前页码的自动文本。
PAGE_COUNT 输入用于表示文档总页数的自动文本。

PageBreak

表示分页符的 ParagraphElement。分页符可使后续文本从下一页顶部开始。

JSON 表示法 
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
字段
suggestedInsertionIds[]

string

建议的广告订单 ID。如果 PageBreak 是嵌套的建议更改，则可能具有多个广告插入 ID。如果为空，则不建议插入。
suggestedDeletionIds[]

string

建议的删除 ID。如果为空，则表示没有建议删除此内容。
textStyle

object (TextStyle)

此分页符的文本样式。

与文本内容（例如文本段落和脚注引用）类似，分页符的文本样式可能会影响内容布局以及插入其旁边的文本的样式。
suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

建议的文本样式会更改为此分页符，按建议 ID 键控。

ColumnBreak

表示列断点的 ParagraphElement。列分隔符会使后续文本从下一列顶部开始。

JSON 表示法 
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
字段
suggestedInsertionIds[]

string

建议的广告订单 ID。如果 ColumnBreak 是嵌套的建议更改，则可能具有多个广告插入 ID。如果为空，则表示这不是建议的插入内容。
suggestedDeletionIds[]

string

建议的删除 ID。如果为空，则表示系统没有建议删除此内容。
textStyle

object (TextStyle)

此列断点的文本样式。

与文本内容（例如文本段落和脚注引用）类似，列分隔符的文本样式可能会影响内容布局以及插入其旁边的文本的样式。
suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

建议的文本样式将更改为此 ColumnBreak，由建议 ID 键控。

FootnoteReference

表示脚注引用的 ParagraphElement。脚注引用是通过数字呈现的内嵌内容，用于标识脚注。

JSON 表示法 
{
  "footnoteId": string,
  "footnoteNumber": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
字段
footnoteId

string

包含此脚注引用内容的 footnote 的 ID。
footnoteNumber

string

此脚注的呈现编号。
suggestedInsertionIds[]

string

建议的广告订单 ID。如果 FootnoteReference 是嵌套的建议更改，则可能具有多个广告插入 ID。如果为空，则表示这不是建议的插入内容。
suggestedDeletionIds[]

string

建议删除的 ID。如果为空，则表示系统没有建议删除此内容。
textStyle

object (TextStyle)

此 FootnoteReference 的文本样式。
suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

建议的文本样式会更改为此 FootnoteReference，按建议 ID 键控。

HorizontalRule

表示水平线的 ParagraphElement。

JSON 表示法 
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
字段
suggestedInsertionIds[]

string

建议的广告订单 ID。如果是嵌套的建议更改，则 HorizontalRule 可能会有多个插入 ID。如果为空，则表示这不是建议的插入内容。
suggestedDeletionIds[]

string

建议的删除 ID。如果为空，则表示系统没有建议删除此内容。
textStyle

object (TextStyle)

此 HorizontalRule 的文本样式。

与文本内容（如文本连段和脚注引用）类似，水平规则的文本样式会影响内容布局以及旁边插入的文本的样式。
suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

建议的文本样式会更改为此 HorizontalRule，按建议 ID 键控。

公式

表示等式的 ParagraphElement。

JSON 表示法 
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ]
}
字段
suggestedInsertionIds[]

string

建议的广告订单 ID。如果 Equation 是嵌套的建议更改，则可能具有多个广告插入 ID。如果为空，则表示这不是建议的插入内容。
suggestedDeletionIds[]

string

建议删除的 ID。如果为空，则表示系统没有建议删除此内容。

InlineObjectElement

包含 InlineObject 的 ParagraphElement。

JSON 表示法 
{
  "inlineObjectId": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
字段
inlineObjectId

string

此元素包含的 InlineObject 的 ID。
suggestedInsertionIds[]

string

建议的广告订单 ID。如果是嵌套的建议更改，InlineObjectElement 可能会有多个插入 ID。如果为空，则表示这不是建议的插入内容。
suggestedDeletionIds[]

string

建议删除的 ID。如果为空，则表示系统没有建议删除此内容。
textStyle

object (TextStyle)

此 InlineObjectElement 的文本样式。

与文本内容（例如文本段落和脚注引用）类似，内嵌对象元素的文本样式可能会影响内容布局以及插入其旁边的文本的样式。
suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

建议的文本样式会更改为此 InlineObject，按建议 ID 键控。

人物

文档中提及的人员或电子邮件地址。这些提及会作为包含相应人员姓名或电子邮件地址的单个不可变元素进行处理。

JSON 表示法 
{
  "personId": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  },
  "personProperties": {
    object (PersonProperties)
  }
}
字段
personId

string

仅限输出。此关联的唯一 ID。
suggestedInsertionIds[]

string

用于将此人员链接插入文档中的建议的 ID。如果是嵌套的建议更改（例如，其他用户提出的建议中的建议），则 Person 可能会有多个插入 ID。如果为空，则表示系统不会建议插入此人链接。
suggestedDeletionIds[]

string

用于从文档中移除此人链接的建议的 ID。例如，如果有多个用户建议删除某个 Person，则该 Person 可能会有多个删除 ID。如果为空，则系统不会建议删除此人关联。
textStyle

object (TextStyle)

此 Person 的文本样式。
suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

建议的文本样式将更改为此 Person，由建议 ID 键控。
personProperties

object (PersonProperties)

仅限输出。此 Person 的属性。此字段始终存在。

PersonProperties

特定于关联的 Person 的属性。

JSON 表示法 
{
  "name": string,
  "email": string
}
字段
name

string

仅限输出。如果显示在链接文字中，则显示联系人的姓名，而不是此人的电子邮件地址。
email

string

仅限输出。与此Person关联的电子邮件地址。此字段始终存在。

RichLinkProperties

特定于 RichLink 的属性。

JSON 表示法 
{
  "title": string,
  "uri": string,
  "mimeType": string
}
字段
title

string

仅限输出。链接中显示的 RichLink 的标题。此标题与链接插入或上次更新时关联资源的标题一致。此字段始终存在。
uri

string

仅限输出。指向 RichLink 的 URI。此字段始终存在。
mimeType

string

仅限输出。RichLink 的 MIME 类型（如果有），例如当云端硬盘文件是云端硬盘文件时。

ParagraphStyle

应用于整个段落的样式。

继承的段落样式在此消息中表示为未设置的字段。段落样式的父级取决于段落样式的定义位置：

  • Paragraph 上的 ParagraphStyle 会继承段落的相应 named style type。
  • named style 上的 ParagraphStyle 会继承 normal text 命名样式。
  • normal text 命名样式的 ParagraphStyle 会继承 Google 文档编辑器中的默认段落样式。
  • 表格中包含的 Paragraph 元素上的 ParagraphStyle 可能会从表格样式继承其段落样式。

如果段落样式未从父级继承，则取消设置字段会将样式还原为与 Google 文档编辑器中的默认值匹配的值。

JSON 表示法 
{
  "headingId": string,
  "namedStyleType": enum (NamedStyleType),
  "alignment": enum (Alignment),
  "lineSpacing": number,
  "direction": enum (ContentDirection),
  "spacingMode": enum (SpacingMode),
  "spaceAbove": {
    object (Dimension)
  },
  "spaceBelow": {
    object (Dimension)
  },
  "borderBetween": {
    object (ParagraphBorder)
  },
  "borderTop": {
    object (ParagraphBorder)
  },
  "borderBottom": {
    object (ParagraphBorder)
  },
  "borderLeft": {
    object (ParagraphBorder)
  },
  "borderRight": {
    object (ParagraphBorder)
  },
  "indentFirstLine": {
    object (Dimension)
  },
  "indentStart": {
    object (Dimension)
  },
  "indentEnd": {
    object (Dimension)
  },
  "tabStops": [
    {
      object (TabStop)
    }
  ],
  "keepLinesTogether": boolean,
  "keepWithNext": boolean,
  "avoidWidowAndOrphan": boolean,
  "shading": {
    object (Shading)
  },
  "pageBreakBefore": boolean
}
字段
headingId

string

段落的标题 ID。如果为空，则表示此段落不是标题。

此属性为只读属性。
namedStyleType

enum (NamedStyleType)

段落的命名样式类型。

由于更新命名样式类型会影响 ParagraphStyle 中的其他属性，因此系统会先应用命名样式类型，然后再更新其他属性。
alignment

enum (Alignment)

此段落的文本对齐方式。
lineSpacing

number

行之间的间距（以正常间距为百分比），其中正常间距表示为 100.0。如果未设置，该值将继承自父级。
direction

enum (ContentDirection)

此段落的文本方向。如果未设置，则值默认为 LEFT_TO_RIGHT，因为段落方向不会被继承。
spacingMode

enum (SpacingMode)

段落的间距模式。
spaceAbove

object (Dimension)

段落上方多余空间量。如果未设置，则值会从父级继承。
spaceBelow

object (Dimension)

段落下方的额外空格量。如果未设置，该值将继承自父级。
borderBetween

object (ParagraphBorder)

此段落与下一段落和上一段落之间的边框。如果未设置，则值会从父级继承。

当相邻段落具有相同的边框和缩进属性时，系统会渲染间隔边框。

无法部分更新段落边框。更改段落边框时，必须完整指定新边框。
borderTop

object (ParagraphBorder)

此段落顶部的边框。如果未设置，该值将继承自父级。

如果以上段落具有不同的边框和缩进属性，则系统会呈现上边框。

无法部分更新段落边框。更改段落边框时，必须完整指定新边框。
borderBottom

object (ParagraphBorder)

此段落底部的边框。如果未设置，则值会从父级继承。

当下方段落具有不同的边框和缩进属性时，系统会呈现底部边框。

无法部分更新段落边框。更改段落边框时，必须完整指定新边框。
borderLeft

object (ParagraphBorder)

此段落左侧的边框。如果未设置，该值将继承自父级。

无法部分更新段落边框。更改段落边框时，必须完整指定新边框。
borderRight

object (ParagraphBorder)

此段落右侧的边框。如果未设置，则值会从父级继承。

无法部分更新段落边框。更改段落边框时，必须完整指定新边框。
indentFirstLine

object (Dimension)

段落第一行的缩进量。如果未设置，则值会从父级继承。
indentStart

object (Dimension)

相对于文本开头的侧边，段落的缩进量（基于当前段落方向）。如果未设置，则值会从父级继承。
indentEnd

object (Dimension)

相应于文本末尾一侧的段落的缩进量，基于当前段落方向。如果未设置，则值会从父级继承。
tabStops[]

object (TabStop)

此段落的制表符列表。制表点列表不会被继承。

此属性为只读属性。
keepLinesTogether

boolean

是否应尽可能让段落中的所有行都排列在同一页面或同一列中。如果未设置，则值会从父级继承。
keepWithNext

boolean

是否应尽可能将此段落的至少一部分与下一段落排列在同一页面或同一列中。如果未设置，则值会从父级继承。
avoidWidowAndOrphan

boolean

是否为段落避免出现孤行和孤首行。如果未设置，则值会从父级继承。
shading

object (Shading)

段落的阴影。如果未设置，则值会从父级继承。
pageBreakBefore

boolean

当前段落是否应始终从页面开头开始。如果未设置，则值会从父级继承。

尝试为不受支持的区域（包括 Table、Header、Footer 和 Footnote）中的段落更新 pageBreakBefore 可能会导致无效文档状态，返回 400 bad request 错误。

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 段落已两端对齐。

ContentDirection

方向内容可以流入。

枚举
CONTENT_DIRECTION_UNSPECIFIED 未指定内容方向。
LEFT_TO_RIGHT 内容从左到右显示。
RIGHT_TO_LEFT 内容按从右到左的顺序显示。

SpacingMode

段落间距的不同模式。

枚举
SPACING_MODE_UNSPECIFIED 间距模式会从父级继承。
NEVER_COLLAPSE 系统始终会呈现段落间距。
COLLAPSE_LISTS 列表元素之间会跳过段落间距。

ParagraphBorder

段落周围的边框。

JSON 表示法 
{
  "color": {
    object (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "padding": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle)
}
字段
color

object (OptionalColor)

边框的颜色。
width

object (Dimension)

边框的宽度。
padding

object (Dimension)

边框的内边距。
dashStyle

enum (DashStyle)

边框的虚线样式。

DashStyle

可用于渲染线性几何图形的虚线类型。这些值基于 ECMA-376 第 4 版第 1 部分“Office Open XML 文件格式 - 基础知识和标记语言参考”的 20.1.10.48 节中所述的“ST_PresetLineDashVal”简单类型。

枚举
DASH_STYLE_UNSPECIFIED 未指定虚线样式。
SOLID 实线。对应于 ECMA-376 ST_PresetLineDashVal 值“solid”。这是默认的短划线样式。
DOT 虚线。对应于 ECMA-376 ST_PresetLineDashVal 值“dot”。
DASH 虚线。对应于 ECMA-376 ST_PresetLineDashVal 值“dash”。

TabStop

段落中的制表位。

JSON 表示法 
{
  "offset": {
    object (Dimension)
  },
  "alignment": enum (TabStopAlignment)
}
字段
offset

object (Dimension)

此标签页停止点与起始外边距之间的偏移量。
alignment

enum (TabStopAlignment)

此标签页停止对齐。如果未设置，则值默认为 START。

TabStopAlignment

制表位的对齐方式。

枚举
TAB_STOP_ALIGNMENT_UNSPECIFIED 未指定标签页停止对齐方式。
START 制表符停止点与行首对齐。这是默认值。
CENTER 制表符与线条中心对齐。
END 制表符对齐到行末尾。

阴影

段落的阴影。

JSON 表示法 
{
  "backgroundColor": {
    object (OptionalColor)
  }
}
字段
backgroundColor

object (OptionalColor)

此段落阴影的背景颜色。

SuggestedParagraphStyle

针对 ParagraphStyle 提出的更改建议。

JSON 表示法 
{
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "paragraphStyleSuggestionState": {
    object (ParagraphStyleSuggestionState)
  }
}
字段
paragraphStyle

object (ParagraphStyle)

仅包含在此建议中所做的更改的 ParagraphStyle。您可以将其与 paragraphStyleSuggestionState 搭配使用，以查看哪些字段发生了变化以及它们的新值。
paragraphStyleSuggestionState

object (ParagraphStyleSuggestionState)

一个掩码，用于指示此建议中基础 ParagraphStyle 的哪些字段已更改。

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 (ShadingSuggestionState)
  },
  "pageBreakBeforeSuggested": boolean
}
字段
headingIdSuggested

boolean

指示是否有针对 headingId 的建议更改。
namedStyleTypeSuggested

boolean

指示是否有针对 namedStyleType 的建议更改。
alignmentSuggested

boolean

指示是否有针对 alignment 的建议更改。
lineSpacingSuggested

boolean

指示是否有针对 lineSpacing 的建议更改。
directionSuggested

boolean

指示是否有针对 direction 的建议更改。
spacingModeSuggested

boolean

指示是否有针对 spacingMode 的建议更改。
spaceAboveSuggested

boolean

指示是否有针对 spaceAbove 的建议更改。
spaceBelowSuggested

boolean

指示是否有针对 spaceBelow 的建议更改。
borderBetweenSuggested

boolean

指示是否有针对 borderBetween 的建议更改。
borderTopSuggested

boolean

指示是否有针对 borderTop 的建议更改。
borderBottomSuggested

boolean

指示是否有针对 borderBottom 的建议更改。
borderLeftSuggested

boolean

指示是否有针对 borderLeft 的建议更改。
borderRightSuggested

boolean

指示是否有针对 borderRight 的建议更改。
indentFirstLineSuggested

boolean

指示是否有针对 indentFirstLine 的建议更改。
indentStartSuggested

boolean

指示是否有针对 indentStart 的建议更改。
indentEndSuggested

boolean

指示是否有针对 indentEnd 的建议更改。
keepLinesTogetherSuggested

boolean

指示是否有针对 keepLinesTogether 的建议更改。
keepWithNextSuggested

boolean

指示是否有针对 keepWithNext 的建议更改。
avoidWidowAndOrphanSuggested

boolean

指示是否有针对 avoidWidowAndOrphan 的建议更改。
shadingSuggestionState

object (ShadingSuggestionState)

一个掩码，用于指示此建议中 shading 中的哪些字段已更改。
pageBreakBeforeSuggested

boolean

指示是否有针对 pageBreakBefore 的建议更改。

ShadingSuggestionState

一个掩码，用于指示在此建议的更改中，基础 Shading 的哪些字段已更改。对于设置为 true 的任何字段，系统都会提供新的建议值。

JSON 表示法 
{
  "backgroundColorSuggested": boolean
}
字段
backgroundColorSuggested

boolean

指示是否有针对 Shading 的建议更改。

项目符号

描述段落的项目符号。

JSON 表示法 
{
  "listId": string,
  "nestingLevel": integer,
  "textStyle": {
    object (TextStyle)
  }
}
字段
listId

string

此段落所属列表的 ID。
nestingLevel

integer

此段落在列表中的嵌套级别。
textStyle

object (TextStyle)

应用于此项目符号的段落专用文本样式。

SuggestedBullet

对 Bullet 提出的更改建议。

JSON 表示法 
{
  "bullet": {
    object (Bullet)
  },
  "bulletSuggestionState": {
    object (BulletSuggestionState)
  }
}
字段
bullet

object (Bullet)

一个 Bullet，仅包含在此建议中所做的更改。您可以将其与 bulletSuggestionState 搭配使用，以查看哪些字段发生了变化以及它们的新值。
bulletSuggestionState

object (BulletSuggestionState)

一个掩码，用于指示此建议中基础 Bullet 的哪些字段已更改。

BulletSuggestionState

一个掩码，用于指示此建议中基础 Bullet 的哪些字段已更改。对于设置为 true 的任何字段，系统都会提供新的建议值。

JSON 表示法 
{
  "listIdSuggested": boolean,
  "nestingLevelSuggested": boolean,
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  }
}
字段
listIdSuggested

boolean

指示是否有针对 listId 的建议更改。
nestingLevelSuggested

boolean

指示是否有针对 nestingLevel 的建议更改。
textStyleSuggestionState

object (TextStyleSuggestionState)

一个掩码，用于指示此建议中 text style 中的哪些字段已更改。

ObjectReferences

一组对象 ID。

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

string

对象 ID。

SectionBreak

表示分节符的 StructuralElement。版块是指具有相同 SectionStyle 的内容范围。分节符表示新分节的开始，分节样式会应用于分节符后面的分节。

文档正文始终以分节符开头。

JSON 表示法 
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "sectionStyle": {
    object (SectionStyle)
  }
}
字段
suggestedInsertionIds[]

string

建议的广告订单 ID。如果是嵌套的建议更改，则 SectionBreak 可能会有多个插入 ID。如果为空，则表示这不是建议的插入内容。
suggestedDeletionIds[]

string

建议删除的 ID。如果为空，则表示系统没有建议删除此内容。
sectionStyle

object (SectionStyle)

此分节插入点后部分的样式。

SectionStyle

应用于某个版块的样式。

JSON 表示法 
{
  "columnProperties": [
    {
      object (SectionColumnProperties)
    }
  ],
  "columnSeparatorStyle": enum (ColumnSeparatorStyle),
  "contentDirection": enum (ContentDirection),
  "marginTop": {
    object (Dimension)
  },
  "marginBottom": {
    object (Dimension)
  },
  "marginRight": {
    object (Dimension)
  },
  "marginLeft": {
    object (Dimension)
  },
  "marginHeader": {
    object (Dimension)
  },
  "marginFooter": {
    object (Dimension)
  },
  "sectionType": enum (SectionType),
  "defaultHeaderId": string,
  "defaultFooterId": string,
  "firstPageHeaderId": string,
  "firstPageFooterId": string,
  "evenPageHeaderId": string,
  "evenPageFooterId": string,
  "useFirstPageHeaderFooter": boolean,
  "pageNumberStart": integer,
  "flipPageOrientation": boolean
}
字段
columnProperties[]

object (SectionColumnProperties)

该部分的列属性。

如果为空，该部分将在 Google 文档编辑器中包含一个包含默认属性的列。更新后的版块最多只能包含 3 列。

更新此属性时，必须设置具体值。取消设置此属性将导致 400 错误“Bad Request”。
columnSeparatorStyle

enum (ColumnSeparatorStyle)

列分隔符的样式。

即使该版块中只有一列，也可以设置此样式。

更新此属性时，必须设置具体值。取消设置此属性会导致 400 Bad Request 错误。
contentDirection

enum (ContentDirection)

此部分的内容方向。如果未设置，则值默认为 LEFT_TO_RIGHT。

更新此属性时，必须设置具体值。取消设置此属性会导致 400 错误请求错误。
marginTop

object (Dimension)

该部分的页面顶部边距。如果未设置，则该值默认为 DocumentStyle 中的 marginTop。

更新此属性时，必须设置具体值。取消设置此属性会导致 400 Bad Request 错误。
marginBottom

object (Dimension)

相应版块的底部外边距。如果未设置，则值默认为 DocumentStyle 中的 marginBottom。

更新此属性时，必须设置具体值。取消设置此属性会导致 400 错误请求错误。
marginRight

object (Dimension)

该版块的右页边距。如果未设置，则值默认为 DocumentStyle 中的 marginRight。更新右边距会导致此部分中的列调整大小。由于边距会影响列宽，因此会在列属性之前应用。

更新此属性时，必须设置具体值。取消设置此属性会导致 400 Bad Request 错误。
marginLeft

object (Dimension)

该部分的左页边距。如果未设置，则值默认为 DocumentStyle 中的 marginLeft。更新左外边距会导致此部分中的列调整大小。由于边距会影响列宽，因此会在列属性之前应用。

更新此属性时，必须设置具体值。取消设置此属性会导致 400 Bad Request 错误。
marginHeader

object (Dimension)

此部分的页眉边距。如果未设置，则值默认为 DocumentStyle 中的 marginHeader。更新后，DocumentStyle 上的 useCustomHeaderFooterMargins 会设为 true。DocumentStyle 上的 useCustomHeaderFooterMargins 的值表示是否要为此部分使用标题边距。

更新此属性时，必须设置具体值。取消设置此属性会导致 400 Bad Request 错误。
sectionType

enum (SectionType)

仅限输出。版块的类型。
defaultHeaderId

string

默认标题的 ID。如果未设置，该值将从之前的 SectionBreak's SectionStyle 继承。如果第一个 SectionBreak 中未设置该值，则会从 DocumentStyle 的 defaultHeaderId 继承。

此属性为只读属性。
firstPageHeaderId

string

仅用于该部分第一页的标题的 ID。如果 useFirstPageHeaderFooter 为 true，则此值将用于该部分第一页的标题。如果为 false，则该部分第一页上的标题会使用 defaultHeaderId。如果未设置，则值会继承之前的 SectionBreak's SectionStyle。如果第一个 SectionBreak 中未设置该值，则会从 DocumentStyle 的 firstPageHeaderId 继承。

此属性为只读属性。
firstPageFooterId

string

仅用于版块第一页的页脚 ID。如果 useFirstPageHeaderFooter 为 true，则此值将用于该部分第一页的页脚。如果为 false，则该部分第一个页面的页脚会使用 defaultFooterId。如果未设置，则值会继承之前的 SectionBreak's SectionStyle。如果该值在第一个 SectionBreak 中未设置，它将从 DocumentStyle 的 firstPageFooterId 继承。

此属性为只读属性。
evenPageHeaderId

string

仅用于偶数页的标题 ID。如果 DocumentStyle 的 useEvenPageHeaderFooter 的值为 true，则此值将用于该部分偶数页上的标题。如果为 false，偶数页上的标题会使用 defaultHeaderId。如果未设置，该值将从之前的 SectionBreak's SectionStyle 继承。如果第一个 SectionBreak 中未设置该值，则会从 DocumentStyle 的 evenPageHeaderId 继承。

此属性为只读属性。
evenPageFooterId

string

仅用于偶数页的页脚的 ID。如果 DocumentStyle 的 useEvenPageHeaderFooter 的值为 true，则此值将用于该部分偶数页上的页脚。如果该值为 false，则偶数页面上的页脚会使用 defaultFooterId。如果未设置，则值会继承之前的 SectionBreak's SectionStyle。如果第一个 SectionBreak 中未设置该值，则会从 DocumentStyle 的 evenPageFooterId 继承。

此属性为只读属性。
useFirstPageHeaderFooter

boolean

指示是否应为该部分的首页使用首页页眉 / 页脚 ID。如果未设置，则会继承第一个部分的 DocumentStyle 的 useFirstPageHeaderFooter。如果未为后续扇区设置该值，则应将其解读为 false。

更新此属性时，必须设置具体值。取消设置此属性会导致 400 Bad Request 错误。
pageNumberStart

integer

此部分的页码数从该页码开始计算。如果未设置，页面编号将从上一小节继续。如果该值在第一个 SectionBreak 中未设置，请参阅 DocumentStyle 的 pageNumberStart。

更新此属性时，必须设置具体值。取消设置此属性会导致 400 错误请求错误。
flipPageOrientation

boolean

可选。指示是否要针对此部分翻转 DocumentStyle 的 pageSize 的尺寸，以便在纵向和横向之间更改页面方向。如果未设置，则该值会继承 DocumentStyle 的 flipPageOrientation。

更新此属性时，需要设置具体值。取消设置此属性会导致 400 Bad Request 错误。

SectionColumnProperties

适用于版块列的属性。

JSON 表示法 
{
  "width": {
    object (Dimension)
  },
  "paddingEnd": {
    object (Dimension)
  }
}
字段
width

object (Dimension)

仅限输出。列的宽度。
paddingEnd

object (Dimension)

列末尾的内边距。

ColumnSeparatorStyle

各列之间列分隔符的样式。

枚举
COLUMN_SEPARATOR_STYLE_UNSPECIFIED 未指定的列分隔符样式。
NONE 列之间没有列分隔线。
BETWEEN_EACH_COLUMN 在每列之间呈现列分隔线。

SectionType

表示当前部分的开头相对于前一部分的位置。

枚举
SECTION_TYPE_UNSPECIFIED 未指定版块类型。
CONTINUOUS 该部分紧跟在上一部分的最后一段之后。
NEXT_PAGE 该部分将从下一页开始。

表

表示表的 StructuralElement。

JSON 表示法 
{
  "rows": integer,
  "columns": integer,
  "tableRows": [
    {
      object (TableRow)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "tableStyle": {
    object (TableStyle)
  }
}
字段
rows

integer

表中的行数。
columns

integer

表中的列数。

表格可能是非矩形的，因此有些行可能包含不同数量的单元格。
tableRows[]

object (TableRow)

每行的具体内容和样式。
suggestedInsertionIds[]

string

建议的广告订单 ID。如果 Table 是嵌套的建议更改，则可能具有多个广告插入 ID。如果为空，则不建议插入。
suggestedDeletionIds[]

string

建议删除的 ID。如果为空，则表示系统没有建议删除此内容。
tableStyle

object (TableStyle)

表格的样式。

TableRow

Table 中某一行的具体内容和样式。

JSON 表示法 
{
  "startIndex": integer,
  "endIndex": integer,
  "tableCells": [
    {
      object (TableCell)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "suggestedTableRowStyleChanges": {
    string: {
      object (SuggestedTableRowStyle)
    },
    ...
  }
}
字段
startIndex

integer

此行从零开始的索引（采用 UTF-16 代码单元）。
endIndex

integer

此行的结束编号（从 0 开始，不包括该编号），以 UTF-16 代码单元为单位。
tableCells[]

object (TableCell)

此行中每个单元格的相应内容和样式。

表格也可能是非矩形，因此同一表格中某些行的单元格数可能与其他行不同。
suggestedInsertionIds[]

string

建议的广告订单 ID。如果 TableRow 是嵌套的建议更改，则可能具有多个广告插入 ID。如果为空，则表示这不是建议的插入内容。
suggestedDeletionIds[]

string

建议删除的 ID。如果为空，则表示系统没有建议删除此内容。
tableRowStyle

object (TableRowStyle)

表格的行样式。
suggestedTableRowStyleChanges

map (key: string, value: object (SuggestedTableRowStyle))

此行采用的建议样式会发生更改，键值为建议 ID。

TableCell

Table 中单元格的内容和样式。

JSON 表示法 
{
  "startIndex": integer,
  "endIndex": integer,
  "content": [
    {
      object (StructuralElement)
    }
  ],
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "suggestedTableCellStyleChanges": {
    string: {
      object (SuggestedTableCellStyle)
    },
    ...
  }
}
字段
startIndex

integer

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

integer

此单元格中从零开始的结束索引（不含边界值），采用 UTF-16 代码单元。
content[]

object (StructuralElement)

单元格的内容。
tableCellStyle

object (TableCellStyle)

单元格的样式。
suggestedInsertionIds[]

string

建议的插入 ID。如果 TableCell 是嵌套的建议更改，则可能具有多个广告插入 ID。如果为空，则表示这不是建议的插入内容。
suggestedDeletionIds[]

string

建议删除的 ID。如果为空，则表示系统没有建议删除此内容。
suggestedTableCellStyleChanges

map (key: string, value: object (SuggestedTableCellStyle))

对表格单元格样式的建议更改，按建议 ID 编号。

TableCellStyle

TableCell 的样式。

继承的表格单元格样式在此消息中表示为未设置的字段。表格单元格样式可以从表格样式继承。

JSON 表示法 
{
  "rowSpan": integer,
  "columnSpan": integer,
  "backgroundColor": {
    object (OptionalColor)
  },
  "borderLeft": {
    object (TableCellBorder)
  },
  "borderRight": {
    object (TableCellBorder)
  },
  "borderTop": {
    object (TableCellBorder)
  },
  "borderBottom": {
    object (TableCellBorder)
  },
  "paddingLeft": {
    object (Dimension)
  },
  "paddingRight": {
    object (Dimension)
  },
  "paddingTop": {
    object (Dimension)
  },
  "paddingBottom": {
    object (Dimension)
  },
  "contentAlignment": enum (ContentAlignment)
}
字段
rowSpan

integer

单元格的行跨度。

此属性为只读属性。
columnSpan

integer

单元格的列跨度。

此属性为只读属性。
backgroundColor

object (OptionalColor)

单元格的背景颜色。
borderLeft

object (TableCellBorder)

单元格的左边框。
borderRight

object (TableCellBorder)

单元格的右边框。
borderTop

object (TableCellBorder)

单元格的上边框。
borderBottom

object (TableCellBorder)

单元格的下边框。
paddingLeft

object (Dimension)

单元格的左内边距。
paddingRight

object (Dimension)

单元格的右侧内边距。
paddingTop

object (Dimension)

单元格的上内边距。
paddingBottom

object (Dimension)

单元格的底部内边距。
contentAlignment

enum (ContentAlignment)

表格单元格中内容的对齐方式。默认对齐方式与 Google 文档编辑器中新创建的表格单元格的对齐方式一致。

TableCellBorder

表单元格周围的边框。

表格单元格边框不能是透明的。要隐藏表格单元格边框，请将其宽度设为 0。

JSON 表示法 
{
  "color": {
    object (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle)
}
字段
color

object (OptionalColor)

边框的颜色。

此颜色不得为透明。
width

object (Dimension)

边框的宽度。
dashStyle

enum (DashStyle)

边框的虚线样式。

ContentAlignment

内容对齐方式。

派生自 ECMA-376 第 4 版第 1 部分“Office Open XML 文件格式 - 基础知识和标记语言参考”的 20.1.10.59 节中“ST_TextAnchoringType”简单类型的值子集。

枚举
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": {
    object (TableCellStyleSuggestionState)
  }
}
字段
tableCellStyle

object (TableCellStyle)

仅包含在此建议中所做的更改的 TableCellStyle。您可以将其与 tableCellStyleSuggestionState 搭配使用，以查看哪些字段发生了变化以及它们的新值。
tableCellStyleSuggestionState

object (TableCellStyleSuggestionState)

一个掩码，用于指示此建议中基础 TableCellStyle 的哪些字段已更改。

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

boolean

指示是否有针对 rowSpan 的建议更改。
columnSpanSuggested

boolean

指示是否有针对 columnSpan 的建议更改。
backgroundColorSuggested

boolean

指示是否有针对 backgroundColor 的建议更改。
borderLeftSuggested

boolean

指示是否有针对 borderLeft 的建议更改。
borderRightSuggested

boolean

指示是否有针对 borderRight 的建议更改。
borderTopSuggested

boolean

指示是否有针对 borderTop 的建议更改。
borderBottomSuggested

boolean

指示是否有针对 borderBottom 的建议更改。
paddingLeftSuggested

boolean

指示是否有针对 paddingLeft 的建议更改。
paddingRightSuggested

boolean

指示是否有针对 paddingRight 的建议更改。
paddingTopSuggested

boolean

指示是否有针对 paddingTop 的建议更改。
paddingBottomSuggested

boolean

指示是否有针对 paddingBottom 的建议更改。
contentAlignmentSuggested

boolean

指示是否有针对 contentAlignment 的建议更改。

TableRowStyle

应用于表格行的样式。

JSON 表示法 
{
  "minRowHeight": {
    object (Dimension)
  },
  "tableHeader": boolean,
  "preventOverflow": boolean
}
字段
minRowHeight

object (Dimension)

行的最小高度。该行在 Google 文档编辑器中的高度将等于或大于此值，以便显示该行单元格中的所有内容。
tableHeader

boolean

相应行是否为表格标题。
preventOverflow

boolean

相应行是否不能溢出页面或列边界。

SuggestedTableRowStyle

针对 TableRowStyle 的建议更改。

JSON 表示法 
{
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "tableRowStyleSuggestionState": {
    object (TableRowStyleSuggestionState)
  }
}
字段
tableRowStyle

object (TableRowStyle)

仅包含在此建议中所做的更改的 TableRowStyle。您可以将其与 tableRowStyleSuggestionState 搭配使用，以查看哪些字段发生了变化以及它们的新值。
tableRowStyleSuggestionState

object (TableRowStyleSuggestionState)

一个掩码，用于指示此建议中基础 TableRowStyle 的哪些字段已更改。

TableRowStyleSuggestionState

一个掩码，用于指示此建议中基础 TableRowStyle 的哪些字段已更改。对于设置为 true 的任何字段，系统都会提供新的建议值。

JSON 表示法 
{
  "minRowHeightSuggested": boolean
}
字段
minRowHeightSuggested

boolean

指示是否有针对 minRowHeight 的建议更改。

TableStyle

适用于表格的样式。

JSON 表示法 
{
  "tableColumnProperties": [
    {
      object (TableColumnProperties)
    }
  ]
}
字段
tableColumnProperties[]

object (TableColumnProperties)

每列的属性。

请注意，在 Google 文档中，表格包含行，行包含单元格，与 HTML 类似。因此，您可以在行 tableRowStyle 中找到相应行的属性。

TableColumnProperties

表中列的属性。

JSON 表示法 
{
  "widthType": enum (WidthType),
  "width": {
    object (Dimension)
  }
}
字段
widthType

enum (WidthType)

列的宽度类型。
width

object (Dimension)

列的宽度。当列的 widthType 为 FIXED_WIDTH 时设置。

WidthType

列宽的类型。

枚举
WIDTH_TYPE_UNSPECIFIED 未指定列宽类型。
EVENLY_DISTRIBUTED

列宽会在其他均匀分布的列之间平均分配。

系统会自动确定该列的宽度，并在考虑所有指定宽度的列后，将剩余的宽度平均分配给表格。
FIXED_WIDTH 固定列宽。[width][google.apps.docs.v1.TableColumnProperties.width 属性包含列的宽度。

TableOfContents

表示目录的 StructuralElement。

JSON 表示法 
{
  "content": [
    {
      object (StructuralElement)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ]
}
字段
content[]

object (StructuralElement)

目录的内容。
suggestedInsertionIds[]

string

建议的插入 ID。如果 TableOfContents 是嵌套的建议更改，则可能具有多个插入 ID。如果为空，则表示这不是建议的插入内容。
suggestedDeletionIds[]

string

建议删除的 ID。如果为空，则表示系统没有建议删除此内容。

脚注

文档脚注。

JSON 表示法 
{
  "footnoteId": string,
  "content": [
    {
      object (StructuralElement)
    }
  ]
}
字段
footnoteId

string

脚注的 ID。
content[]

object (StructuralElement)

脚注的内容。

脚注内容的编号从 0 开始。

DocumentStyle

文档的样式。

JSON 表示法 
{
  "background": {
    object (Background)
  },
  "defaultHeaderId": string,
  "defaultFooterId": string,
  "evenPageHeaderId": string,
  "evenPageFooterId": string,
  "firstPageHeaderId": string,
  "firstPageFooterId": string,
  "useFirstPageHeaderFooter": boolean,
  "useEvenPageHeaderFooter": boolean,
  "pageNumberStart": integer,
  "marginTop": {
    object (Dimension)
  },
  "marginBottom": {
    object (Dimension)
  },
  "marginRight": {
    object (Dimension)
  },
  "marginLeft": {
    object (Dimension)
  },
  "pageSize": {
    object (Size)
  },
  "marginHeader": {
    object (Dimension)
  },
  "marginFooter": {
    object (Dimension)
  },
  "useCustomHeaderFooterMargins": boolean,
  "flipPageOrientation": boolean
}
字段
background

object (Background)

证件背景。证件不得采用透明背景颜色。
defaultHeaderId

string

默认标题的 ID。如果未设置，则没有默认标头。

此属性为只读属性。
evenPageHeaderId

string

仅用于偶数页的标题 ID。useEvenPageHeaderFooter 的值决定了偶数页的标题是使用 defaultHeaderId 还是此值。如果未设置，则没有偶数页页眉。

此属性为只读属性。
evenPageFooterId

string

仅用于偶数页的页脚的 ID。useEvenPageHeaderFooter 的值决定了偶数页的页脚是使用 defaultFooterId 还是此值。如果未设置，则不显示偶数页页脚。

此属性为只读属性。
firstPageHeaderId

string

仅用于首页的标题的 ID。如果未设置，则不存在第一页的唯一标题。useFirstPageHeaderFooter 的值决定了是使用 defaultHeaderId 还是此值作为第一页的标题。如果未设置，则没有第一页标题。

此属性为只读属性。
firstPageFooterId

string

仅用于第一页的页脚 ID。如果未设置，则不存在第一页的唯一页脚。useFirstPageHeaderFooter 的值决定了是使用 defaultFooterId 还是此值作为第一页的页脚。如果未设置，则不会显示首页页脚。

此属性为只读属性。
useFirstPageHeaderFooter

boolean

指示是否应为首页使用首页页眉 / 页脚 ID。
useEvenPageHeaderFooter

boolean

指示是否为偶数页使用偶数页页眉 / 页脚 ID。
pageNumberStart

integer

开始统计页码数的页码。
marginTop

object (Dimension)

上边距。

更新文档样式的页面顶部边距会清除所有部分样式的页面顶部边距。
marginBottom

object (Dimension)

页面底边距。

更新文档样式的底部页边距会清除所有部分样式的底部页边距。
marginRight

object (Dimension)

右页边距。

更新文档样式的右页边距会清除所有版块样式的右页边距。这也可能会导致所有部分中的列大小发生变化。
marginLeft

object (Dimension)

左页边距。

更新文档样式的左页边距会清除所有部分样式的左页边距。还可能会导致所有部分中的列都调整大小。
pageSize

object (Size)

文档中页面的大小。
marginHeader

object (Dimension)

页面顶部与标题内容之间的间距。
flipPageOrientation

boolean

可选。指示是否翻转 pageSize 的尺寸，以便在纵向和横向之间更改页面方向。

背景

表示文档的背景。

JSON 表示法 
{
  "color": {
    object (OptionalColor)
  }
}
字段
color

object (OptionalColor)

背景颜色。

大小

宽度和高度。

JSON 表示法 
{
  "height": {
    object (Dimension)
  },
  "width": {
    object (Dimension)
  }
}
字段
height

object (Dimension)

该对象的高度。
width

object (Dimension)

对象的宽度。

SuggestedDocumentStyle

对 DocumentStyle 的建议更改。

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

object (DocumentStyle)

仅包含在此建议中所做的更改的 DocumentStyle。您可以将其与 documentStyleSuggestionState 搭配使用，以查看哪些字段发生了变化以及它们的新值。
documentStyleSuggestionState

object (DocumentStyleSuggestionState)

一个掩码，用于指明基本 DocumentStyle 上的哪些字段在此建议中已更改。

DocumentStyleSuggestionState

一个掩码，用于指示此建议中基础 DocumentStyle 的哪些字段已更改。对于设置为 true 的任何字段，系统都会提供新的建议值。

JSON 表示法 
{
  "backgroundSuggestionState": {
    object (BackgroundSuggestionState)
  },
  "defaultHeaderIdSuggested": boolean,
  "defaultFooterIdSuggested": boolean,
  "evenPageHeaderIdSuggested": boolean,
  "evenPageFooterIdSuggested": boolean,
  "firstPageHeaderIdSuggested": boolean,
  "firstPageFooterIdSuggested": boolean,
  "useFirstPageHeaderFooterSuggested": boolean,
  "useEvenPageHeaderFooterSuggested": boolean,
  "pageNumberStartSuggested": boolean,
  "marginTopSuggested": boolean,
  "marginBottomSuggested": boolean,
  "marginRightSuggested": boolean,
  "marginLeftSuggested": boolean,
  "pageSizeSuggestionState": {
    object (SizeSuggestionState)
  },
  "marginHeaderSuggested": boolean,
  "marginFooterSuggested": boolean,
  "useCustomHeaderFooterMarginsSuggested": boolean,
  "flipPageOrientationSuggested": boolean
}
字段
backgroundSuggestionState

object (BackgroundSuggestionState)

一个掩码，用于指示此建议中 background 中的哪些字段已更改。
defaultHeaderIdSuggested

boolean

指示是否有针对 defaultHeaderId 的建议更改。
evenPageHeaderIdSuggested

boolean

指示是否有针对 evenPageHeaderId 的建议更改。
evenPageFooterIdSuggested

boolean

指示是否有针对 evenPageFooterId 的建议更改。
firstPageHeaderIdSuggested

boolean

指示是否有针对 firstPageHeaderId 的建议更改。
firstPageFooterIdSuggested

boolean

指示是否有针对 firstPageFooterId 的建议更改。
useFirstPageHeaderFooterSuggested

boolean

指示是否有针对 useFirstPageHeaderFooter 的建议更改。
useEvenPageHeaderFooterSuggested

boolean

指示是否有针对 useEvenPageHeaderFooter 的建议更改。
pageNumberStartSuggested

boolean

指示是否有针对 pageNumberStart 的建议更改。
marginTopSuggested

boolean

指示是否有针对 marginTop 的建议更改。
marginBottomSuggested

boolean

指示是否有针对 marginBottom 的建议更改。
marginRightSuggested

boolean

指示是否有针对 marginRight 的建议更改。
marginLeftSuggested

boolean

指示是否有针对 marginLeft 的建议更改。
pageSizeSuggestionState

object (SizeSuggestionState)

指示 [size] [google.apps.docs.v1.DocumentStyle.size] 中的哪些字段在此建议中已更改的掩码。
marginHeaderSuggested

boolean

指示是否有针对 marginHeader 的建议更改。
flipPageOrientationSuggested

boolean

可选。指示是否有针对 flipPageOrientation 的建议更改。

BackgroundSuggestionState

一个掩码，用于指示此建议中基础 Background 的哪些字段已更改。对于设置为 true 的任何字段，Backgound 都有新的建议值。

JSON 表示法 
{
  "backgroundColorSuggested": boolean
}
字段
backgroundColorSuggested

boolean

指示当前背景颜色是否已修改在此建议中。

SizeSuggestionState

一个掩码，用于指示此建议中基础 Size 的哪些字段已更改。对于设置为 true 的任何字段，Size 都有新的建议值。

JSON 表示法 
{
  "heightSuggested": boolean,
  "widthSuggested": boolean
}
字段
heightSuggested

boolean

指示是否有针对 height 的建议更改。
widthSuggested

boolean

指示是否有针对 width 的建议更改。

NamedStyles

命名样式。文档中的段落可以从这些已命名样式继承 TextStyle 和 ParagraphStyle。

JSON 表示法 
{
  "styles": [
    {
      object (NamedStyle)
    }
  ]
}
字段
styles[]

object (NamedStyle)

已命名的样式。

每个可能的 named style types 都有一个条目。

NamedStyle

已命名的样式。如果文档中的段落具有相同的命名样式类型，则可以从此命名样式继承 TextStyle 和 ParagraphStyle。

JSON 表示法 
{
  "namedStyleType": enum (NamedStyleType),
  "textStyle": {
    object (TextStyle)
  },
  "paragraphStyle": {
    object (ParagraphStyle)
  }
}
字段
namedStyleType

enum (NamedStyleType)

此已命名样式的类型。
textStyle

object (TextStyle)

此命名样式的文本样式。
paragraphStyle

object (ParagraphStyle)

此命名样式的段落样式。

SuggestedNamedStyles

对 NamedStyles 的建议更改。

JSON 表示法 
{
  "namedStyles": {
    object (NamedStyles)
  },
  "namedStylesSuggestionState": {
    object (NamedStylesSuggestionState)
  }
}
字段
namedStyles

object (NamedStyles)

一个 NamedStyles，仅包含在此建议中所做的更改。您可以将其与 namedStylesSuggestionState 搭配使用，以查看哪些字段发生了变化以及它们的新值。
namedStylesSuggestionState

object (NamedStylesSuggestionState)

一个掩码，用于指明基本 NamedStyles 上的哪些字段在此建议中已更改。

NamedStylesSuggestionState

NamedStyles 消息的建议状态。

JSON 表示法 
{
  "stylesSuggestionStates": [
    {
      object (NamedStyleSuggestionState)
    }
  ]
}
字段
stylesSuggestionStates[]

object (NamedStyleSuggestionState)

一个掩码，用于指明 styles 中相应 NamedStyle 上的哪些字段在此建议中已更改。

这些命名样式建议状态的顺序与 named styles 建议中相应命名样式的顺序一致。

NamedStyleSuggestionState

NamedStyle 消息的建议状态。

JSON 表示法 
{
  "namedStyleType": enum (NamedStyleType),
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  },
  "paragraphStyleSuggestionState": {
    object (ParagraphStyleSuggestionState)
  }
}
字段
namedStyleType

enum (NamedStyleType)

此建议状态对应的命名样式类型。

此字段是为了方便将 NamedStyleSuggestionState 与其对应的 NamedStyle 进行匹配而提供的。
textStyleSuggestionState

object (TextStyleSuggestionState)

一个掩码，用于指示此建议中 text style 中的哪些字段已更改。
paragraphStyleSuggestionState

object (ParagraphStyleSuggestionState)

一个掩码，用于指示此建议中 paragraph style 中的哪些字段已更改。

列表

List 表示一组段落的列表属性，这些段落都属于同一列表。列表中的段落在其 bullet 中包含对列表 ID 的引用。

JSON 表示法 
{
  "listProperties": {
    object (ListProperties)
  },
  "suggestedListPropertiesChanges": {
    string: {
      object (SuggestedListProperties)
    },
    ...
  },
  "suggestedInsertionId": string,
  "suggestedDeletionIds": [
    string
  ]
}
字段
listProperties

object (ListProperties)

列表的属性。
suggestedListPropertiesChanges

map (key: string, value: object (SuggestedListProperties))

对列表属性的建议更改，按建议 ID 编写键值对。
suggestedInsertionId

string

建议的广告订单 ID。如果为空，则表示这不是建议的插入内容。
suggestedDeletionIds[]

string

建议删除的 ID。如果为空，则表示系统不会建议删除此列表。

ListProperties

list 的属性，用于描述属于与列表关联的段落的项目符号的外观和风格。

JSON 表示法 
{
  "nestingLevels": [
    {
      object (NestingLevel)
    }
  ]
}
字段
nestingLevels[]

object (NestingLevel)

描述关联级别的项目的属性。

列表最多有 9 层嵌套，嵌套级别 0 对应最顶层，嵌套级别 8 对应最顶层。嵌套级别会按升序顺序返回，最浅的嵌套级别会先返回。

NestingLevel

包含描述列表项目符号在指定嵌套级别的外观和风格的属性。

JSON 表示法 
{
  "bulletAlignment": enum (BulletAlignment),
  "glyphFormat": string,
  "indentFirstLine": {
    object (Dimension)
  },
  "indentStart": {
    object (Dimension)
  },
  "textStyle": {
    object (TextStyle)
  },
  "startNumber": integer,

  // Union field glyph_kind can be only one of the following:
  "glyphType": enum (GlyphType),
  "glyphSymbol": string
  // End of list of possible types for union field glyph_kind.
}
字段
bulletAlignment

enum (BulletAlignment)

项目符号在分配用于渲染项目符号的空间中的对齐方式。
glyphFormat

string

此嵌套级别的项目符号使用的格式字符串。

字形格式包含一个或多个占位符，这些占位符会根据 glyphType 或 glyphSymbol 替换为适当的值。占位符遵循格式 %[nestingLevel]。此外，占位符可以有前缀和后缀。因此，字形格式遵循 <prefix>%[nestingLevel]<suffix> 模式。请注意，前缀和后缀是可选的，可以是任意字符串。

例如，字形格式 %0. 表示渲染的字形将替换占位符，并将嵌套级别 0 的相应字形作为后缀后跟一个句点。因此，嵌套级别为 0 且字形类型为 UPPER_ALPHA 且字形格式为 %0. 的列表将生成具有已渲染字形的列表

A.

B.

C.

该字形格式可以包含当前嵌套级别的占位符，以及父级嵌套级别的占位符。例如，在嵌套级别为 0 时，列表的字形格式可以为 %0.，在嵌套级别为 1 时，字形格式可以为 %0.%1.。假设这两个嵌套级别都具有 DECIMAL 字形类型，这将导致列表中包含渲染的字形

1.

2.

2.1.

2.2.

3.

对于有序嵌套层级，用于替换特定段落的字形格式占位符的字符串取决于该段落在列表中的顺序。
indentFirstLine

object (Dimension)

此嵌套级别段落第一行的缩进量。
indentStart

object (Dimension)

此嵌套级别的段落缩进量。根据段落的内容方向，应用于与文本开头对应的边。
textStyle

object (TextStyle)

此嵌套级别的项目符号的文本样式。
startNumber

integer

此嵌套级别中第一个列表项的编号。

对于字母列表和罗马数字列表，值 0 会被视为值 1。对于值为 0 和 1 的情况，字母列表和罗马数字列表将分别从 a 和 i 开始。

对于包含无序字符的嵌套层级，系统会忽略此值。
联合字段 glyph_kind。项目符号使用的字形类型。这会定义用于替换 glyph_format 中的占位符的圆点符号。glyph_kind 只能是下列其中一项：
glyphType

enum (GlyphType)

当此嵌套级别的段落排序时，项目符号使用的图形类型。

字形类型决定了在对此嵌套级别的段落进行排序时，用于替换 glyphFormat 中的占位符的字形类型。例如，如果嵌套级别为 0、glyphFormat 为 %0. 且字形类型为 DECIMAL，则渲染的字形会将字形格式中的占位符 %0 替换为与列表项在列表中的顺序对应的数字。
glyphSymbol

string

当此嵌套级别的段落未排序时，项目符号使用的自定义字形符号。

该字形符号会替换 glyphFormat 中的占位符。例如，如果 glyphSymbol 是与 Unicode U+25cf 代码点对应的实心圆，并且 glyphFormat 为 %0，则渲染的字形将是实心圆形。

BulletAlignment

项目符号对齐方式。

枚举
BULLET_ALIGNMENT_UNSPECIFIED 未指定项目符号对齐方式。
START 项目符号会与分配用于渲染项目符号的空间的起点对齐。对于 LTR 文本，为左对齐；否则为右对齐。
CENTER 项目符号会与分配用于渲染项目符号的空间的中心对齐。
END 项目符号会与分配用于呈现项目符号的空间的末尾对齐。对于 LTR 文本，为右对齐；否则为左对齐。

GlyphType

对这种嵌套级别的段落进行排序时，项目符号使用的字形类型。

枚举
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": {
    object (ListPropertiesSuggestionState)
  }
}
字段
listProperties

object (ListProperties)

一个 ListProperties，仅包含在此建议中所做的更改。它可以与 listPropertiesSuggestionState 结合使用，以查看哪些字段发生了变化及其新值。
listPropertiesSuggestionState

object (ListPropertiesSuggestionState)

一个掩码，用于指明基本 ListProperties 上的哪些字段在此建议中已更改。

ListPropertiesSuggestionState

一个掩码，用于指示此建议中基础 ListProperties 的哪些字段已更改。任何设置为 true 的字段都会有新的建议值。

JSON 表示法 
{
  "nestingLevelsSuggestionStates": [
    {
      object (NestingLevelSuggestionState)
    }
  ]
}
字段
nestingLevelsSuggestionStates[]

object (NestingLevelSuggestionState)

一个掩码，用于指明 nestingLevels 中相应 NestingLevel 上的哪些字段在此建议中已更改。

系统会按嵌套级别的升序返回嵌套级别建议状态，嵌套级别最少的建议状态最先返回。

NestingLevelSuggestionState

一个掩码，用于指示此建议中基础 NestingLevel 的哪些字段已更改。对于设置为 true 的任何字段，系统都会提供新的建议值。

JSON 表示法 
{
  "bulletAlignmentSuggested": boolean,
  "glyphTypeSuggested": boolean,
  "glyphFormatSuggested": boolean,
  "glyphSymbolSuggested": boolean,
  "indentFirstLineSuggested": boolean,
  "indentStartSuggested": boolean,
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  },
  "startNumberSuggested": boolean
}
字段
bulletAlignmentSuggested

boolean

指示是否有针对 bulletAlignment 的建议更改。
glyphTypeSuggested

boolean

指示是否有针对 glyphType 的建议更改。
glyphFormatSuggested

boolean

指示是否有针对 glyphFormat 的建议更改。
glyphSymbolSuggested

boolean

指示是否有针对 glyphSymbol 的建议更改。
indentFirstLineSuggested

boolean

指示是否有针对 indentFirstLine 的建议更改。
indentStartSuggested

boolean

指示是否有针对 indentStart 的建议更改。
textStyleSuggestionState

object (TextStyleSuggestionState)

一个掩码，用于指示此建议中 text style 中的哪些字段已更改。
startNumberSuggested

boolean

指示是否有针对 startNumber 的建议更改。

NamedRanges

文档中所有共享给定名称的 NamedRange 的集合。

JSON 表示法 
{
  "name": string,
  "namedRanges": [
    {
      object (NamedRange)
    }
  ]
}
字段
name

string

所有 named ranges 共享的名称。
namedRanges[]

object (NamedRange)

共用相同名称的 NamedRange。

NamedRange

具有相同命名范围 ID 的 Range 集合。

借助命名范围，开发者可以将文档的部分内容与任意用户定义的标签相关联，以便日后以编程方式读取或修改其内容。文档可以包含多个同名命名范围，但每个命名范围都有一个唯一 ID。

命名范围是使用单个 Range 创建的，插入命名范围中的内容通常会扩展该范围。不过，某些文档更改可能会导致范围拆分为多个范围。

命名的范围不是不公开的。有权访问该文档的所有应用和协作者都可以看到该文档的命名范围。

JSON 表示法 
{
  "namedRangeId": string,
  "name": string,
  "ranges": [
    {
      object (Range)
    }
  ]
}
字段
namedRangeId

string

命名范围的 ID。
name

string

命名范围的名称。
ranges[]

object (Range)

属于此命名范围的范围。

Range

指定连续的文本范围。

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

string

此范围所包含的页眉、页脚或脚注的 ID。空段 ID 表示文档正文。
startIndex

integer

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

在当前的所有用例中，都必须提供起始索引。此字段为 Int32Value，以便适应未来具有开口范围的用例。
endIndex

integer

此范围中从零开始的结束索引（不含边界值），采用 UTF-16 代码单元。

在当前的所有用例中，都必须提供结束编号。此字段是一个 Int32Value，以便满足使用开放式范围的未来用例。
tabId

string

包含此范围的标签页。如果省略，则请求会应用于第一个标签页。

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

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

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

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

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

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

InlineObject

与文本内嵌显示的对象。InlineObject 包含 EmbeddedObject，例如图片。

JSON 表示法 
{
  "objectId": string,
  "inlineObjectProperties": {
    object (InlineObjectProperties)
  },
  "suggestedInlineObjectPropertiesChanges": {
    string: {
      object (SuggestedInlineObjectProperties)
    },
    ...
  },
  "suggestedInsertionId": string,
  "suggestedDeletionIds": [
    string
  ]
}
字段
objectId

string

此内嵌对象的 ID。可用于更新对象的属性。
inlineObjectProperties

object (InlineObjectProperties)

此内嵌对象的属性。
suggestedInlineObjectPropertiesChanges

map (key: string, value: object (SuggestedInlineObjectProperties))

对内嵌对象属性的建议更改，按建议 ID 编写键值对。
suggestedInsertionId

string

建议的广告订单 ID。如果为空，则不建议插入。
suggestedDeletionIds[]

string

建议删除的 ID。如果为空，则表示没有建议删除此内容。

InlineObjectProperties

InlineObject 的属性。

JSON 表示法 
{
  "embeddedObject": {
    object (EmbeddedObject)
  }
}
字段
embeddedObject

object (EmbeddedObject)

此内嵌对象的嵌入对象。

EmbeddedObject

文档中的嵌入对象。

JSON 表示法 
{
  "title": string,
  "description": string,
  "embeddedObjectBorder": {
    object (EmbeddedObjectBorder)
  },
  "size": {
    object (Size)
  },
  "marginTop": {
    object (Dimension)
  },
  "marginBottom": {
    object (Dimension)
  },
  "marginRight": {
    object (Dimension)
  },
  "marginLeft": {
    object (Dimension)
  },
  "linkedContentReference": {
    object (LinkedContentReference)
  },

  // Union field properties can be only one of the following:
  "embeddedDrawingProperties": {
    object (EmbeddedDrawingProperties)
  },
  "imageProperties": {
    object (ImageProperties)
  }
  // End of list of possible types for union field properties.
}
字段
title

string

嵌入对象的标题。title 和 description 会组合使用来显示替代文本。
description

string

嵌入对象的说明。title 和 description 会组合使用来显示替代文本。
embeddedObjectBorder

object (EmbeddedObjectBorder)

嵌入对象的边框。
size

object (Size)

剪裁后的图片的可见大小。
marginTop

object (Dimension)

嵌入对象的上外边距。
marginBottom

object (Dimension)

嵌入对象的底部边距。
marginRight

object (Dimension)

嵌入对象的右边距。
marginLeft

object (Dimension)

嵌入对象的左边距。
linkedContentReference

object (LinkedContentReference)

对外部链接的来源内容的引用。例如，当嵌入的对象是链接的图表时，它会包含对源 Google 表格图表的引用。

如果未设置，则嵌入的对象不会关联。
联合字段 properties。特定于每个嵌入对象类型的属性。properties 只能是下列其中一项：
embeddedDrawingProperties

object (EmbeddedDrawingProperties)

嵌入式绘图的属性。
imageProperties

object (ImageProperties)

图片的属性。

EmbeddedDrawingProperties

此类型没有字段。

嵌入绘图的属性，用于区分对象类型。嵌入的绘图是在文档中创建和修改的绘图。请注意，不支持提供过多的详细信息。

ImageProperties

图片的属性。

JSON 表示法 
{
  "contentUri": string,
  "sourceUri": string,
  "brightness": number,
  "contrast": number,
  "transparency": number,
  "cropProperties": {
    object (CropProperties)
  },
  "angle": number
}
字段
contentUri

string

指向图片的 URI，默认生命周期为 30 分钟。此 URI 会标记为请求者的账号。知道该 URI 的任何人都可以有效地以原始请求者的身份访问图片。如果文档的共享设置发生变化，您可能无法再访问该图片。
sourceUri

string

源 URI 是用于插入图片的 URI。源 URI 可以为空。
brightness

number

图片的亮度效果。该值应在 [-1.0, 1.0] 范围内，其中 0 表示无效。
contrast

number

图片的对比度效果。该值应在 [-1.0, 1.0] 范围内，其中 0 表示无效。
transparency

number

图片的透明度效果。该值应介于 [0.0, 1.0] 之间，其中 0 表示没有任何效果，1 表示透明。
cropProperties

object (CropProperties)

图片的剪裁属性。
angle

number

图片的顺时针旋转角度（以弧度为单位）。

CropProperties

图片的剪裁属性。

剪裁矩形使用相对于原始内容的 4 条边的小数偏移表示。

  • 如果偏移量在 (0, 1) 范围内，则剪裁矩形的相应边缘位于图片的原始边界矩形内。
  • 如果偏移量为负值或大于 1，则剪裁矩形的相应边缘会位于图片的原始边界矩形之外。
  • 如果所有偏移量和旋转角度均为 0，则系统不会剪裁图片。
JSON 表示法 
{
  "offsetLeft": number,
  "offsetRight": number,
  "offsetTop": number,
  "offsetBottom": number,
  "angle": number
}
字段
offsetLeft

number

偏移量指定了剪裁矩形的左边缘相对于原始内容的左边缘的距离（以原始内容的宽度为基数）。
offsetRight

number

偏移量指定了剪裁矩形的右边缘相对于原始内容的右边缘向内偏移的距离（以原始内容的宽度为基数）。
offsetTop

number

偏移量指定了剪裁矩形的上边缘相对于原始内容的上边缘向内偏移的距离（以原始内容的高度为基数）。
offsetBottom

number

偏移值用于指定剪裁矩形的下边缘与原始内容下边缘的向内距离（占原始内容高度的比例）。
angle

number

剪裁矩形绕其中心顺时针旋转的角度（以弧度为单位）。旋转会在偏移量之后应用。

EmbeddedObjectBorder

EmbeddedObject 周围的边框。

JSON 表示法 
{
  "color": {
    object (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle),
  "propertyState": enum (PropertyState)
}
字段
color

object (OptionalColor)

边框的颜色。
width

object (Dimension)

边框的宽度。
dashStyle

enum (DashStyle)

边框的虚线样式。
propertyState

enum (PropertyState)

边框属性的属性状态。

PropertyState

属性的可能状态。

枚举
RENDERED 如果某个属性的状态为“已呈现”，则该元素在文档中呈现时具有相应的属性。这是默认值。
NOT_RENDERED 如果某个属性的状态为 NOT_RENDERED，则该元素在文档中呈现时将没有相应的属性。

LinkedContentReference

对所链接的外部来源内容的引用。

JSON 表示法 
{

  // Union field reference can be only one of the following:
  "sheetsChartReference": {
    object (SheetsChartReference)
  }
  // End of list of possible types for union field reference.
}
字段
联合字段 reference。特定于关联内容类型的引用。reference 只能是下列其中一项：
sheetsChartReference

object (SheetsChartReference)

对链接图表的引用。

SheetsChartReference

对从 Google 表格内嵌的关联图表的引用。

JSON 表示法 
{
  "spreadsheetId": string,
  "chartId": integer
}
字段
spreadsheetId

string

包含源图表的 Google 表格电子表格的 ID。
chartId

integer

嵌入的 Google 表格电子表格中特定图表的 ID。

SuggestedInlineObjectProperties

对 InlineObjectProperties 的建议更改。

JSON 表示法 
{
  "inlineObjectProperties": {
    object (InlineObjectProperties)
  },
  "inlineObjectPropertiesSuggestionState": {
    object (InlineObjectPropertiesSuggestionState)
  }
}
字段
inlineObjectProperties

object (InlineObjectProperties)

仅包含在此建议中所做的更改的 InlineObjectProperties。它可以与 inlineObjectPropertiesSuggestionState 结合使用，以查看哪些字段发生了变化及其新值。
inlineObjectPropertiesSuggestionState

object (InlineObjectPropertiesSuggestionState)

一个掩码，用于指明基本 InlineObjectProperties 上的哪些字段在此建议中已更改。

InlineObjectPropertiesSuggestionState

一个掩码，用于指明基本 InlineObjectProperties 上的哪些字段在此建议中已更改。对于设置为 true 的任何字段，系统都会提供新的建议值。

JSON 表示法 
{
  "embeddedObjectSuggestionState": {
    object (EmbeddedObjectSuggestionState)
  }
}
字段
embeddedObjectSuggestionState

object (EmbeddedObjectSuggestionState)

一个掩码，用于指示此建议中 embeddedObject 中的哪些字段已更改。

EmbeddedObjectSuggestionState

一个掩码，用于指示此建议中基础 EmbeddedObject 的哪些字段已更改。对于设置为 true 的任何字段，系统都会提供新的建议值。

JSON 表示法 
{
  "embeddedDrawingPropertiesSuggestionState": {
    object (EmbeddedDrawingPropertiesSuggestionState)
  },
  "imagePropertiesSuggestionState": {
    object (ImagePropertiesSuggestionState)
  },
  "titleSuggested": boolean,
  "descriptionSuggested": boolean,
  "embeddedObjectBorderSuggestionState": {
    object (EmbeddedObjectBorderSuggestionState)
  },
  "sizeSuggestionState": {
    object (SizeSuggestionState)
  },
  "marginLeftSuggested": boolean,
  "marginRightSuggested": boolean,
  "marginTopSuggested": boolean,
  "marginBottomSuggested": boolean,
  "linkedContentReferenceSuggestionState": {
    object (LinkedContentReferenceSuggestionState)
  }
}
字段
embeddedDrawingPropertiesSuggestionState

object (EmbeddedDrawingPropertiesSuggestionState)

一个掩码，用于指明 embeddedDrawingProperties 中的哪些字段在此建议中已更改。
imagePropertiesSuggestionState

object (ImagePropertiesSuggestionState)

一个掩码，用于指明 imageProperties 中的哪些字段在此建议中已更改。
titleSuggested

boolean

指示是否有针对 title 的建议更改。
descriptionSuggested

boolean

指示是否有针对 description 的建议更改。
embeddedObjectBorderSuggestionState

object (EmbeddedObjectBorderSuggestionState)

一个掩码，用于指示此建议中 embeddedObjectBorder 中的哪些字段已更改。
sizeSuggestionState

object (SizeSuggestionState)

一个掩码，用于指示此建议中 size 中的哪些字段已更改。
marginLeftSuggested

boolean

指示是否有针对 marginLeft 的建议更改。
marginRightSuggested

boolean

指示是否有针对 marginRight 的建议更改。
marginTopSuggested

boolean

指示是否有针对 marginTop 的建议更改。
marginBottomSuggested

boolean

指示是否有针对 marginBottom 的建议更改。
linkedContentReferenceSuggestionState

object (LinkedContentReferenceSuggestionState)

一个掩码，用于指示此建议中 linkedContentReference 中的哪些字段已更改。

EmbeddedDrawingPropertiesSuggestionState

此类型没有字段。

一个掩码，用于指示此建议中基础 EmbeddedDrawingProperties 的哪些字段已更改。任何设置为 true 的字段都会有新的建议值。

ImagePropertiesSuggestionState

一个掩码，用于指示此建议中基础 ImageProperties 的哪些字段已更改。对于设置为 true 的任何字段，系统都会提供新的建议值。

JSON 表示法 
{
  "contentUriSuggested": boolean,
  "sourceUriSuggested": boolean,
  "brightnessSuggested": boolean,
  "contrastSuggested": boolean,
  "transparencySuggested": boolean,
  "cropPropertiesSuggestionState": {
    object (CropPropertiesSuggestionState)
  },
  "angleSuggested": boolean
}
字段
contentUriSuggested

boolean

指示是否有针对 contentUri 的建议更改。
sourceUriSuggested

boolean

指示是否有针对 [sourceUri] [google.apps.docs.v1.EmbeddedObject.source_uri] 的建议更改。
brightnessSuggested

boolean

指示是否有针对 [亮度] [google.apps.docs.v1.EmbeddedObject.brightness] 的建议更改。
contrastSuggested

boolean

指示是否有针对 [contrast] [google.apps.docs.v1.EmbeddedObject.contrast] 的建议更改。
transparencySuggested

boolean

指明是否有针对 [transparency] [google.apps.docs.v1.EmbeddedObject.transparency] 的建议更改。
cropPropertiesSuggestionState

object (CropPropertiesSuggestionState)

一个掩码，用于指示此建议中 cropProperties 中的哪些字段已更改。
angleSuggested

boolean

指示是否有针对 [angle] [google.apps.docs.v1.EmbeddedObject.angle] 的建议更改。

CropPropertiesSuggestionState

一个掩码，用于指示此建议中基础 CropProperties 的哪些字段已更改。对于设置为 true 的任何字段，系统都会提供新的建议值。

JSON 表示法 
{
  "offsetLeftSuggested": boolean,
  "offsetRightSuggested": boolean,
  "offsetTopSuggested": boolean,
  "offsetBottomSuggested": boolean,
  "angleSuggested": boolean
}
字段
offsetLeftSuggested

boolean

指示是否有针对 offsetLeft 的建议更改。
offsetRightSuggested

boolean

指示是否有针对 offsetRight 的建议更改。
offsetTopSuggested

boolean

指示是否有针对 offsetTop 的建议更改。
offsetBottomSuggested

boolean

指示是否有针对 offsetBottom 的建议更改。
angleSuggested

boolean

指示是否有针对 angle 的建议更改。

EmbeddedObjectBorderSuggestionState

一个掩码，用于指示此建议中基础 EmbeddedObjectBorder 的哪些字段已更改。任何设置为 true 的字段都会有新的建议值。

JSON 表示法 
{
  "colorSuggested": boolean,
  "widthSuggested": boolean,
  "dashStyleSuggested": boolean,
  "propertyStateSuggested": boolean
}
字段
colorSuggested

boolean

指示是否有针对 [color] [google.apps.docs.v1.EmbeddedBorderObject.color] 的建议更改。
widthSuggested

boolean

指示是否有针对 [width] [google.apps.docs.v1.EmbeddedBorderObject.width] 的建议更改。
dashStyleSuggested

boolean

指示是否有针对 [dashStyle] [google.apps.docs.v1.EmbeddedBorderObject.dash_style] 的建议更改。
propertyStateSuggested

boolean

指示是否有针对 [propertyState] [google.apps.docs.v1.EmbeddedBorderObject.property_state] 的建议更改。

LinkedContentReferenceSuggestionState

一个掩码，用于指示此建议中基础 LinkedContentReference 的哪些字段已更改。任何设置为 true 的字段都会有新的建议值。

JSON 表示法 
{
  "sheetsChartReferenceSuggestionState": {
    object (SheetsChartReferenceSuggestionState)
  }
}
字段
sheetsChartReferenceSuggestionState

object (SheetsChartReferenceSuggestionState)

一个掩码，用于指明 sheetsChartReference 中的哪些字段在此建议中已更改。

SheetsChartReferenceSuggestionState

一个掩码，用于指示此建议中基础 SheetsChartReference 的哪些字段已更改。任何设置为 true 的字段都会有新的建议值。

JSON 表示法 
{
  "spreadsheetIdSuggested": boolean,
  "chartIdSuggested": boolean
}
字段
spreadsheetIdSuggested

boolean

指示是否有针对 spreadsheetId 的建议更改。
chartIdSuggested

boolean

指示是否有针对 chartId 的建议更改。

PositionedObject

一个锚定到 Paragraph 的对象，并相对于段落开头进行定位。PositionedObject 包含图片等 EmbeddedObject。

JSON 表示法 
{
  "objectId": string,
  "positionedObjectProperties": {
    object (PositionedObjectProperties)
  },
  "suggestedPositionedObjectPropertiesChanges": {
    string: {
      object (SuggestedPositionedObjectProperties)
    },
    ...
  },
  "suggestedInsertionId": string,
  "suggestedDeletionIds": [
    string
  ]
}
字段
objectId

string

此已定位对象的 ID。
positionedObjectProperties

object (PositionedObjectProperties)

此定位对象的属性。
suggestedPositionedObjectPropertiesChanges

map (key: string, value: object (SuggestedPositionedObjectProperties))

对定位对象属性的建议更改，按建议 ID 编键。
suggestedInsertionId

string

建议的插入 ID。如果为空，则表示这不是建议的插入内容。
suggestedDeletionIds[]

string

建议的删除 ID。如果为空，则表示没有建议删除此内容。

PositionedObjectProperties

PositionedObject 的属性。

JSON 表示法 
{
  "positioning": {
    object (PositionedObjectPositioning)
  },
  "embeddedObject": {
    object (EmbeddedObject)
  }
}
字段
positioning

object (PositionedObjectPositioning)

此定位对象相对于引用此定位对象的 Paragraph 的换行符的位置。
embeddedObject

object (EmbeddedObject)

此定位对象的嵌入对象。

PositionedObjectPositioning

PositionedObject 的定位。定位的对象相对于其所连接的 Paragraph 的开头进行定位。

JSON 表示法 
{
  "layout": enum (PositionedObjectLayout),
  "leftOffset": {
    object (Dimension)
  },
  "topOffset": {
    object (Dimension)
  }
}
字段
layout

enum (PositionedObjectLayout)

此放置对象的布局。
leftOffset

object (Dimension)

已定位对象的左边缘相对于其共享位置的 Paragraph 的起始偏移量。对象的确切位置可能取决于文档中的其他内容和文档的样式。
topOffset

object (Dimension)

放置的对象上边缘相对于其所连接的 Paragraph 开头的偏移量。对象的确切位置可能取决于文档中的其他内容和文档的样式。

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": {
    object (PositionedObjectPropertiesSuggestionState)
  }
}
字段
positionedObjectProperties

object (PositionedObjectProperties)

仅包含在此建议中所做的更改的 PositionedObjectProperties。您可以将其与 positionedObjectPropertiesSuggestionState 搭配使用，以查看哪些字段发生了变化以及它们的新值。
positionedObjectPropertiesSuggestionState

object (PositionedObjectPropertiesSuggestionState)

一个掩码，用于指明此建议中基础 PositionedObjectProperties 的哪些字段已更改。

PositionedObjectPropertiesSuggestionState

一个掩码，用于指示此建议中基础 PositionedObjectProperties 的哪些字段已更改。对于设置为 true 的任何字段，系统都会提供新的建议值。

JSON 表示法 
{
  "positioningSuggestionState": {
    object (PositionedObjectPositioningSuggestionState)
  },
  "embeddedObjectSuggestionState": {
    object (EmbeddedObjectSuggestionState)
  }
}
字段
positioningSuggestionState

object (PositionedObjectPositioningSuggestionState)

一个掩码，用于指示此建议中 positioning 中的哪些字段已更改。
embeddedObjectSuggestionState

object (EmbeddedObjectSuggestionState)

一个掩码，用于指示此建议中 embeddedObject 中的哪些字段已更改。

PositionedObjectPositioningSuggestionState

一个掩码，用于指示此建议中基础 PositionedObjectPositioning 的哪些字段已更改。任何设置为 true 的字段都会有新的建议值。

JSON 表示法 
{
  "layoutSuggested": boolean,
  "leftOffsetSuggested": boolean,
  "topOffsetSuggested": boolean
}
字段
layoutSuggested

boolean

指示是否有针对 layout 的建议更改。
leftOffsetSuggested

boolean

指示是否有针对 leftOffset 的建议更改。
topOffsetSuggested

boolean

指示是否有针对 topOffset 的建议更改。

SuggestionsViewMode

应用于文档的建议视图模式，用于指明建议更改的显示方式。它提供了阅读文档的各种选项，包括内嵌、已接受或拒绝的所有建议。

枚举
DEFAULT_FOR_CURRENT_ACCESS 应用于所返回文档的建议视图模式取决于用户当前的访问权限级别。如果用户只有查看权限，则系统会应用 PREVIEW_WITHOUT_SUGGESTIONS。否则，系统会应用 SUGGESTIONS_INLINE。这是默认的建议视图模式。
SUGGESTIONS_INLINE

返回的文档中会显示内嵌建议。建议的更改将与文档中的基本内容不同。

如果用户无权查看建议的更改，使用此模式检索文档的请求将返回 403 错误。
PREVIEW_SUGGESTIONS_ACCEPTED

返回的文档是预览，其中已接受所有建议更改。

如果用户无权查看建议的更改，使用此模式检索文档的请求将返回 403 错误。
PREVIEW_WITHOUT_SUGGESTIONS 如果文档中有任何建议，系统会在返回的文档中预览所有被拒绝的建议更改。

方法

batchUpdate

 对文档应用一个或多个更新。

create

 使用请求中提供的标题创建空白文档。

get

 获取指定文档的最新版本。