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

相应结构元素的从零开始的结束索引（不含），以 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

相应段落元素的起始索引（从零开始），以 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 可能会从表格样式继承其文本样式。

如果文本样式不继承自父样式，取消设置字段会将样式恢复为与 Google 文档编辑器中的默认值匹配的值。

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/72 英寸。

WeightedFontFamily

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

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

string

文本的字体系列。

字体系列可以是 Google 文档的“字体”菜单中的任何字体，也可以是 Google Fonts 中的任何字体。如果字体名称无法识别，则文本将以 Arial 呈现。
weight

integer

字体粗细。此字段可以具有介于 100 和 900 之间（含边界值）的任何 100 的倍数值。此范围对应于 CSS 2.1 规范第 15.6 节中描述的数值，不允许使用非数值。

默认值为 400（“正常”）。

字体粗细只是渲染字体粗细的一个组成部分。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)

相应自动文本的文本样式。
suggestedTextStyleChanges

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

建议的文字样式会更改为此自动文本，并以建议 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))

建议的文本样式更改为此 PageBreak，由建议 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)

相应 ColumnBreak 的文字样式。

与文本内容（例如文本运行和脚注引用）类似，分栏符的文本样式也会影响内容布局以及插入到分栏符旁边的文本的样式。
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))

建议的文本样式会更改为相应建议 ID 对应的 FootnoteReference。

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 类型（如果有，例如当 RichLink 是云端硬盘中的文件时）。

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 错误请求错误。

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 段落与行的开头对齐。对于从左到右的文本，左对齐；否则，右对齐。
CENTER 段落居中。
END 段落与行尾对齐。对于从左到右的文本，则为右对齐；否则为左对齐。
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 第 5 版第 1 部分“Office Open XML 文件格式 - 基础知识和标记语言参考”的 20.1.10.49 部分中描述的“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)

相应部分的列属性。

如果为空，则该部分包含一列，其中包含文档编辑器中的默认属性。更新后的部分最多只能有 3 列。

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

enum (ColumnSeparatorStyle)

列分隔线的样式。

即使部分中只有一列，也可以设置此样式。

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

enum (ContentDirection)

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

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

object (Dimension)

相应部分的上页边距。如果未设置，则值默认为 DocumentStyle 中的 marginTop。

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

object (Dimension)

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

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

object (Dimension)

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

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

object (Dimension)

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

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

object (Dimension)

相应部分的标题边距。如果未设置，则值默认为 DocumentStyle 中的 marginHeader。如果已更新，则在 DocumentStyle 上将 useCustomHeaderFooterMargins 设置为 true。DocumentStyle 中 useCustomHeaderFooterMargins 的值用于指示相应部分是否遵循页眉边距。

更新此属性时，必须设置具体值。取消设置此属性会导致 400 错误请求错误。
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 错误请求错误。
pageNumberStart

integer

相应部分的起始页码。如果未设置，页码编号将从上一部分继续。如果该值在第一个 SectionBreak 中未设置，请参阅 DocumentStyle 的 pageNumberStart。

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

boolean

可选。表示是否翻转相应部分的 DocumentStyle 的 pageSize 维度，从而允许在纵向和横向之间更改页面方向。如果未设置，则该值会继承自 DocumentStyle 的 flipPageOrientation。

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

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

相应行的从零开始的结束索引（不含），以 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 第 5 版第 1 部分“Office Open XML 文件格式 - 基础知识和标记语言参考”第 20.1.10.60 节中“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)

行的最小高度。为了显示相应行单元格中的所有内容，文档编辑器中呈现的行高将等于或大于此值。
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)

脚注的内容。

脚注内容的索引从零开始。

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 的相应字形作为前缀，以句点作为后缀。因此，如果列表的字形类型为 UPPER_ALPHA，字形格式为 %0.，嵌套级别为 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 项目符号与分配给项目符号的渲染空间的开头对齐。对于从左到右的文本，左对齐；否则，右对齐。
CENTER 项目符号与分配给项目符号的渲染空间居中对齐。
END 项目符号与分配给项目符号的呈现空间末尾对齐。对于从左到右的文本，则为右对齐；否则为左对齐。

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 如果某个属性的状态为 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

表示是否对 [透明度] [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 应用于返回文档的 SuggestionsViewMode 取决于用户的当前访问权限级别。如果用户仅拥有查看权限，则应用 PREVIEW_WITHOUT_SUGGESTIONS。否则，系统会应用 SUGGESTIONS_INLINE。这是默认的建议视图模式。
SUGGESTIONS_INLINE

返回的文档包含行内建议。建议的更改将与文档中的基本内容区分开来。

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

返回的文档是接受所有建议更改后的预览版。

如果用户没有查看建议的更改的权限，则使用此模式检索文档的请求将返回 403 错误。
PREVIEW_WITHOUT_SUGGESTIONS 如果文档中有任何建议，返回的文档将是拒绝所有建议的预览版本。

方法

batchUpdate

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

create

 使用请求中给定的标题创建空白文档。

get

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